Home | History | Annotate | Line # | Download | only in src 
      1 /* $NetBSD: error.h,v 1.5 2025/12/16 12:03:39 nia Exp $ */
      2 
      3 /* Copyright (c) 2010 The NetBSD Foundation, Inc.
      4  * All rights reserved.
      5  *
      6  * This code is derived from software contributed to The NetBSD Foundation
      7  * by Mateusz Kocielski.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  * 3. Neither the name of The NetBSD Foundation nor the names of its
     18  *    contributors may be used to endorse or promote products derived
     19  *    from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     24  * PURPOSE ARE DISCLAIMED.	IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     31  * POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 #ifndef _ERROR_H_
     35 #define _ERROR_H_
     36 
     37 /** error definitions */
     38 typedef enum {
     39 	ERROR_GENERAL,		/**< general error */
     40 	ERROR_NOMEM,		/**< no memory available */
     41 	ERROR_BADARG,		/**< bad argument passed to function */
     42 	ERROR_NOTEXISTS,	/**< key/node does not exist */
     43 	ERROR_MECH,		/**< mechanism error */
     44 	ERROR_PARSE		/**< parse error */
     45 } saslc__error_code_t;
     46 
     47 /** error type */
     48 typedef struct saslc__error_t {
     49 	saslc__error_code_t err_no;     /**< error number */
     50 	const char *err_str;	        /**< string error */
     51 } saslc__error_t;
     52 
     53 /*
     54  * saslc__error_set - sets error for the context of sasl session
     55  *
     56  * E - error
     57  * N - error type
     58  * S - error message
     59  */
     60 #define saslc__error_set(E, N, S)	\
     61 do {					\
     62 	(E)->err_no = (N);		\
     63 	(E)->err_str = (S);		\
     64 } while(/*CONSTCOND*/0);
     65 
     66 /*
     67  * saslc__error_get_errno - gets error type
     68  *
     69  * E - error
     70  */
     71 #define saslc__error_get_errno(E) ((E)->err_no)
     72 
     73 const char *saslc__error_get_strerror(saslc__error_t *);
     74 
     75 /*
     76  * saslc__error_set_errno - sets error type with the default message
     77  *
     78  * E - error
     79  * N - error type
     80  */
     81 #define saslc__error_set_errno(E, N) saslc__error_set((E), (N), NULL)
     82 
     83 /*
     84  * ERR - gets address of the error structure, this macro should be used only
     85  * for the saslc_t and saslc_session_t structures.
     86  *
     87  * X - context or session
     88  */
     89 #define ERR(X) (&((X)->err))
     90 
     91 #endif /* ! _ERROR_H_ */
     92