2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
18 Permission is hereby granted, free of charge, to any person obtaining
19 a copy of this software and associated documentation files (the
20 "Software"), to deal in the Software without restriction, including
21 without limitation the rights to use, copy, modify, merge, publish,
22 distribute, sublicense, and/or sell copies of the Software, and to
23 permit persons to whom the Software is furnished to do so, subject to
24 the following conditions:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
29 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 #ifndef included_error_h
39 #define included_error_h
41 #include <vppinfra/clib.h> /* for CLIB_LINUX_KERNEL */
42 #include <vppinfra/error_bootstrap.h>
48 #ifdef CLIB_LINUX_KERNEL
49 #include <linux/errno.h>
53 #include <vppinfra/vec.h>
55 /* Callback functions for error reporting. */
56 typedef void clib_error_handler_func_t (void *arg, u8 * msg, int msg_len);
57 void clib_error_register_handler (clib_error_handler_func_t func, void *arg);
59 #define clib_warning(format,args...) \
60 _clib_error (CLIB_ERROR_WARNING, clib_error_function, __LINE__, format, ## args)
62 #define clib_error(format,args...) \
63 _clib_error (CLIB_ERROR_FATAL, clib_error_function, __LINE__, format, ## args)
65 #define clib_unix_error(format,args...) \
66 _clib_error (CLIB_ERROR_FATAL | CLIB_ERROR_ERRNO_VALID, clib_error_function, __LINE__, format, ## args)
68 #define clib_unix_warning(format,args...) \
69 _clib_error (CLIB_ERROR_WARNING | CLIB_ERROR_ERRNO_VALID, clib_error_function, __LINE__, format, ## args)
71 /* For programming errors and assert. */
72 #define clib_panic(format,args...) \
73 _clib_error (CLIB_ERROR_ABORT, (char *) clib_error_function, __LINE__, format, ## args)
80 /* Where error occurred (e.g. __FUNCTION__ __LINE__) */
85 /* Error code (e.g. errno for Unix errors). */
89 #define clib_error_get_code(err) ((err) ? (err)->code : 0)
90 #define clib_error_set_code(err, c) \
96 extern void *clib_error_free_vector (clib_error_t * errors);
98 #define clib_error_free(e) e = clib_error_free_vector(e)
100 extern clib_error_t *_clib_error_return (clib_error_t * errors,
103 char *where, char *fmt, ...);
105 #define clib_error_return_code(e,code,flags,args...) \
106 _clib_error_return((e),(code),(flags),(char *)clib_error_function,args)
108 #define clib_error_create(args...) \
109 clib_error_return_code(0,0,0,args)
111 #define clib_error_return(e,args...) \
112 clib_error_return_code(e,0,0,args)
114 #define clib_error_return_unix(e,args...) \
115 clib_error_return_code(e,errno,CLIB_ERROR_ERRNO_VALID,args)
117 #define clib_error_return_fatal(e,args...) \
118 clib_error_return_code(e,0,CLIB_ERROR_FATAL,args)
120 #define clib_error_return_unix_fatal(e,args...) \
121 clib_error_return_code(e,errno,CLIB_ERROR_ERRNO_VALID|CLIB_ERROR_FATAL,args)
123 extern clib_error_t *_clib_error_report (clib_error_t * errors);
125 #define clib_error_report(e) do { (e) = _clib_error_report (e); } while (0)
127 u8 *format_clib_error (u8 * s, va_list * va);
130 unix_error_is_fatal (word error)
143 #define IF_ERROR_IS_FATAL_RETURN_ELSE_FREE(e) \
147 if (unix_error_is_fatal (clib_error_get_code (e))) \
150 clib_error_free (e); \
154 #define ERROR_RETURN_IF(x) \
156 clib_error_t * _error_return_if = (x); \
157 if (_error_return_if) \
158 return clib_error_return (_error_return_if, 0); \
161 #define ERROR_ASSERT(truth) \
163 clib_error_t * _error_assert = 0; \
164 if (CLIB_DEBUG > 0 && ! (truth)) \
166 _error_assert = clib_error_return_fatal \
167 (0, "%s:%d (%s) assertion `%s' fails", \
170 clib_error_function, \
176 /* Assert to remain even if CLIB_DEBUG is set to 0. */
177 #define CLIB_ERROR_ASSERT(truth) \
179 clib_error_t * _error_assert = 0; \
183 clib_error_return_fatal \
184 (0, "%s:%d (%s) assertion `%s' fails", \
187 clib_error_function, \
193 #endif /* included_error_h */
196 * fd.io coding-style-patch-verification: ON
199 * eval: (c-set-style "gnu")