]>
git.proxmox.com Git - mirror_frr.git/blob - lib/ferr.h
2 * Copyright (c) 2015-16 David Lamparter, for NetDEF, Inc.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 /***********************************************************
21 * scroll down to the end of this file for a full example! *
22 ***********************************************************/
34 /* return type when this error indication stuff is used.
36 * guaranteed to have boolean evaluation to "false" when OK, "true" when error
37 * (i.e. can be changed to pointer in the future if necessary)
39 * For checking, always use "if (value)", nothing else.
40 * Do _NOT_ use any integer constant (!= 0), or sign check (< 0).
44 /* rough category of error indication */
49 /* something isn't the way it's supposed to be.
50 * (things that might otherwise be asserts, really)
54 /* user-supplied parameters don't make sense or is inconsistent
55 * if you can express a rule for it (e.g. "holdtime > 2 * keepalive"),
60 /* user-supplied parameters don't line up with reality
61 * (IP address or interface not available, etc.)
62 * NB: these are really TODOs where the code needs to be fixed to
63 * respond to future changes!
67 /* out of some system resource (probably memory)
68 * aka "you didn't spend enough money error" */
71 /* system error (permission denied, etc.) */
74 /* error return from some external library
75 * (FERR_SYSTEM and FERR_LIBRARY are not strongly distinct) */
87 /* unique_id is calculated as a checksum of source filename and error
88 * message format (*before* calling vsnprintf). Line number and
89 * function name are not used; this keeps the number reasonably static
96 /* valid if != 0. note "errno" might be preprocessor foobar. */
98 /* valid if pathname[0] != '\0' */
99 char pathname
[PATH_MAX
];
102 /* Numeric ranges assigned to daemons for use as error codes. */
103 #define BABEL_FERR_START 0x01000001
104 #define BABEL_FRRR_END 0x01FFFFFF
105 #define BGP_FERR_START 0x02000001
106 #define BGP_FERR_END 0x02FFFFFF
107 #define EIGRP_FERR_START 0x03000001
108 #define EIGRP_FERR_END 0x03FFFFFF
109 #define ISIS_FERR_START 0x04000001
110 #define ISIS_FERR_END 0x04FFFFFF
111 #define LDP_FERR_START 0x05000001
112 #define LDP_FERR_END 0x05FFFFFF
113 #define LIB_FERR_START 0x06000001
114 #define LIB_FERR_END 0x06FFFFFF
115 #define NHRP_FERR_START 0x07000001
116 #define NHRP_FERR_END 0x07FFFFFF
117 #define OSPF_FERR_START 0x08000001
118 #define OSPF_FERR_END 0x08FFFFFF
119 #define OSPFV3_FERR_START 0x09000001
120 #define OSPFV3_FERR_END 0x09FFFFFF
121 #define PBR_FERR_START 0x0A000001
122 #define PBR_FERR_END 0x0AFFFFFF
123 #define PIM_FERR_START 0x0B000001
124 #define PIM_FERR_STOP 0x0BFFFFFF
125 #define RIP_FERR_START 0x0C000001
126 #define RIP_FERR_STOP 0x0CFFFFFF
127 #define RIPNG_FERR_START 0x0D000001
128 #define RIPNG_FERR_STOP 0x0DFFFFFF
129 #define SHARP_FERR_START 0x0E000001
130 #define SHARP_FERR_END 0x0EFFFFFF
131 #define VTYSH_FERR_START 0x0F000001
132 #define VTYSH_FRR_END 0x0FFFFFFF
133 #define WATCHFRR_FERR_START 0x10000001
134 #define WATCHFRR_FERR_END 0x10FFFFFF
135 #define PATH_FERR_START 0x11000001
136 #define PATH_FERR_END 0x11FFFFFF
137 #define ZEBRA_FERR_START 0xF1000001
138 #define ZEBRA_FERR_END 0xF1FFFFFF
139 #define END_FERR 0xFFFFFFFF
142 /* Unique error code displayed to end user as a reference. -1 means
143 * this is an uncoded error that does not have reference material. */
145 /* Ultra brief title */
147 /* Brief description of error */
148 const char *description
;
149 /* Remedial suggestion */
150 const char *suggestion
;
153 void log_ref_add(struct log_ref
*ref
);
154 struct log_ref
*log_ref_get(uint32_t code
);
155 void log_ref_display(struct vty
*vty
, uint32_t code
, bool json
);
158 * This function should be called by the
161 void log_ref_init(void);
162 void log_ref_fini(void);
163 void log_ref_vty_init(void);
165 /* get error details.
167 * NB: errval/ferr_r does NOT carry the full error information. It's only
168 * passed around for future API flexibility. ferr_get_last always returns
169 * the last error set in the current thread.
171 const struct ferr
*ferr_get_last(ferr_r errval
);
174 * Can optionally be called at strategic locations.
177 ferr_r
ferr_clear(void);
179 /* do NOT call these functions directly. only for macro use! */
180 ferr_r
ferr_set_internal(const char *file
, int line
, const char *func
,
181 enum ferr_kind kind
, const char *text
, ...);
182 ferr_r
ferr_set_internal_ext(const char *file
, int line
, const char *func
,
183 enum ferr_kind kind
, const char *pathname
,
184 int errno_val
, const char *text
, ...);
190 * If you need to do cleanup (free memory, etc.), save the return value in a
191 * variable of type ferr_r.
193 * Don't put a \n at the end of the error message.
195 #define ferr_code_bug(...) \
196 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_CODE_BUG, \
198 #define ferr_cfg_invalid(...) \
199 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_CONFIG_INVALID, \
201 #define ferr_cfg_reality(...) \
202 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_CONFIG_REALITY, \
204 #define ferr_cfg_resource(...) \
205 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_RESOURCE, \
207 #define ferr_system(...) \
208 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_SYSTEM, \
210 #define ferr_library(...) \
211 ferr_set_internal(__FILE__, __LINE__, __func__, FERR_LIBRARY, \
214 /* extended information variants */
215 #define ferr_system_errno(...) \
216 ferr_set_internal_ext(__FILE__, __LINE__, __func__, FERR_SYSTEM, NULL, \
218 #define ferr_system_path_errno(path, ...) \
219 ferr_set_internal_ext(__FILE__, __LINE__, __func__, FERR_SYSTEM, path, \
223 /* print error message to vty; $ERR is replaced by the error's message */
224 void vty_print_error(struct vty
*vty
, ferr_r err
, const char *msg
, ...);
226 #define CMD_FERR_DO(func, action, ...) \
228 ferr_r cmd_retval = func; \
230 vty_print_error(vty, cmd_retval, __VA_ARGS__); \
235 #define CMD_FERR_RETURN(func, ...) \
236 CMD_FERR_DO(func, return CMD_WARNING_CONFIG_FAILED, __VA_ARGS__)
237 #define CMD_FERR_GOTO(func, label, ...) \
238 CMD_FERR_DO(func, goto label, __VA_ARGS__)
240 /* example: uses bogus #define to keep indent.py happy */
241 #ifdef THIS_IS_AN_EXAMPLE
242 ferr_r
foo_bar_set(struct object
*obj
, int bar
)
244 if (bar
< 1 || bar
>= 100)
245 return ferr_config_invalid("bar setting (%d) must be 0<x<100",
248 if (ioctl(obj
->fd
, bar
))
249 return ferr_system_errno("couldn't set bar to %d", bar
);
256 CMD_FERR_RETURN(foo_bar_set(obj
, atoi(argv
[1])),
257 "command failed: $ERR\n");
261 #endif /* THIS_IS_AN_EXAMPLE */