lib/ferr.c

   1 /*
   2  * Copyright (c) 2015-16  David Lamparter, for NetDEF, Inc.
   3  *
   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.
   7  *
   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.
  15  */
  16
  17 #ifdef HAVE_CONFIG_H
  18 #include "config.h"
  19 #endif
  20
  21 #include <stdlib.h>
  22 #include <stdarg.h>
  23 #include <string.h>
  24 #include <pthread.h>
  25 #include <signal.h>
  26 #include <inttypes.h>
  27
  28 #include "ferr.h"
  29 #include "vty.h"
  30 #include "jhash.h"
  31 #include "memory.h"
  32 #include "hash.h"
  33 #include "command.h"
  34 #include "json.h"
  35 #include "linklist.h"
  36 #include "frr_pthread.h"
  37
  38 DEFINE_MTYPE_STATIC(LIB, ERRINFO, "error information");
  39
  40 /*
  41  * Thread-specific key for temporary storage of allocated ferr.
  42  */
  43 static pthread_key_t errkey;
  44
  45 static void ferr_free(void *arg)
  46 {
  47         XFREE(MTYPE_ERRINFO, arg);
  48 }
  49
  50 static void err_key_init(void) __attribute__((_CONSTRUCTOR(500)));
  51 static void err_key_init(void)
  52 {
  53         pthread_key_create(&errkey, ferr_free);
  54 }
  55
  56 static void err_key_fini(void) __attribute__((_DESTRUCTOR(500)));
  57 static void err_key_fini(void)
  58 {
  59         pthread_key_delete(errkey);
  60 }
  61
  62 /*
  63  * Global shared hash table holding reference text for all defined errors.
  64  */
  65 static pthread_mutex_t refs_mtx = PTHREAD_MUTEX_INITIALIZER;
  66 struct hash *refs;
  67
  68 static bool ferr_hash_cmp(const void *a, const void *b)
  69 {
  70         const struct log_ref *f_a = a;
  71         const struct log_ref *f_b = b;
  72
  73         return f_a->code == f_b->code;
  74 }
  75
  76 static inline unsigned int ferr_hash_key(const void *a)
  77 {
  78         const struct log_ref *f = a;
  79
  80         return f->code;
  81 }
  82
  83 void log_ref_add(struct log_ref *ref)
  84 {
  85         uint32_t i = 0;
  86
  87         frr_with_mutex(&refs_mtx) {
  88                 while (ref[i].code != END_FERR) {
  89                         hash_get(refs, &ref[i], hash_alloc_intern);
  90                         i++;
  91                 }
  92         }
  93 }
  94
  95 struct log_ref *log_ref_get(uint32_t code)
  96 {
  97         struct log_ref holder;
  98         struct log_ref *ref;
  99
 100         holder.code = code;
 101         frr_with_mutex(&refs_mtx) {
 102                 ref = hash_lookup(refs, &holder);
 103         }
 104
 105         return ref;
 106 }
 107
 108 void log_ref_display(struct vty *vty, uint32_t code, bool json)
 109 {
 110         struct log_ref *ref;
 111         struct json_object *top = NULL, *obj = NULL;
 112         struct list *errlist;
 113         struct listnode *ln;
 114
 115         if (json)
 116                 top = json_object_new_object();
 117
 118         frr_with_mutex(&refs_mtx) {
 119                 errlist = code ? list_new() : hash_to_list(refs);
 120         }
 121
 122         if (code) {
 123                 ref = log_ref_get(code);
 124                 if (!ref) {
 125                         if (top)
 126                                 json_object_free(top);
 127                         list_delete(&errlist);
 128                         return;
 129                 }
 130                 listnode_add(errlist, ref);
 131         }
 132
 133         for (ALL_LIST_ELEMENTS_RO(errlist, ln, ref)) {
 134                 if (json) {
 135                         char key[11];
 136
 137                         snprintf(key, sizeof(key), "%u", ref->code);
 138                         obj = json_object_new_object();
 139                         json_object_string_add(obj, "title", ref->title);
 140                         json_object_string_add(obj, "description",
 141                                                ref->description);
 142                         json_object_string_add(obj, "suggestion",
 143                                                ref->suggestion);
 144                         json_object_object_add(top, key, obj);
 145                 } else {
 146                         char pbuf[256];
 147                         char ubuf[256];
 148
 149                         snprintf(pbuf, sizeof(pbuf), "\nError %u - %s",
 150                                  ref->code, ref->title);
 151                         memset(ubuf, '=', strlen(pbuf));
 152                         ubuf[strlen(pbuf)] = '\0';
 153
 154                         vty_out(vty, "%s\n%s\n", pbuf, ubuf);
 155                         vty_out(vty, "Description:\n%s\n\n", ref->description);
 156                         vty_out(vty, "Recommendation:\n%s\n", ref->suggestion);
 157                 }
 158         }
 159
 160         if (json) {
 161                 const char *str = json_object_to_json_string_ext(
 162                         top, JSON_C_TO_STRING_PRETTY);
 163                 vty_out(vty, "%s\n", str);
 164                 json_object_free(top);
 165         }
 166
 167         list_delete(&errlist);
 168 }
 169
 170 DEFUN_NOSH(show_error_code,
 171            show_error_code_cmd,
 172            "show error <(1-4294967295)|all> [json]",
 173            SHOW_STR
 174            "Information on errors\n"
 175            "Error code to get info about\n"
 176            "Information on all errors\n"
 177            JSON_STR)
 178 {
 179         bool json = strmatch(argv[argc-1]->text, "json");
 180         uint32_t arg = 0;
 181
 182         if (!strmatch(argv[2]->text, "all"))
 183                 arg = strtoul(argv[2]->arg, NULL, 10);
 184
 185         log_ref_display(vty, arg, json);
 186         return CMD_SUCCESS;
 187 }
 188
 189 void log_ref_init(void)
 190 {
 191         frr_with_mutex(&refs_mtx) {
 192                 refs = hash_create(ferr_hash_key, ferr_hash_cmp,
 193                                    "Error Reference Texts");
 194         }
 195 }
 196
 197 void log_ref_fini(void)
 198 {
 199         frr_with_mutex(&refs_mtx) {
 200                 hash_clean(refs, NULL);
 201                 hash_free(refs);
 202                 refs = NULL;
 203         }
 204 }
 205
 206 void log_ref_vty_init(void)
 207 {
 208         install_element(VIEW_NODE, &show_error_code_cmd);
 209 }
 210
 211
 212 const struct ferr *ferr_get_last(ferr_r errval)
 213 {
 214         struct ferr *last_error = pthread_getspecific(errkey);
 215         if (!last_error || last_error->kind == 0)
 216                 return NULL;
 217         return last_error;
 218 }
 219
 220 ferr_r ferr_clear(void)
 221 {
 222         struct ferr *last_error = pthread_getspecific(errkey);
 223         if (last_error)
 224                 last_error->kind = 0;
 225         return ferr_ok();
 226 }
 227
 228 static ferr_r ferr_set_va(const char *file, int line, const char *func,
 229                           enum ferr_kind kind, const char *pathname,
 230                           int errno_val, const char *text, va_list va)
 231 {
 232         struct ferr *error = pthread_getspecific(errkey);
 233
 234         if (!error) {
 235                 error = XCALLOC(MTYPE_ERRINFO, sizeof(*error));
 236
 237                 pthread_setspecific(errkey, error);
 238         }
 239
 240         error->file = file;
 241         error->line = line;
 242         error->func = func;
 243         error->kind = kind;
 244
 245         error->unique_id = jhash(text, strlen(text),
 246                                  jhash(file, strlen(file), 0xd4ed0298));
 247
 248         error->errno_val = errno_val;
 249         if (pathname)
 250                 snprintf(error->pathname, sizeof(error->pathname), "%s",
 251                          pathname);
 252         else
 253                 error->pathname[0] = '\0';
 254
 255         vsnprintf(error->message, sizeof(error->message), text, va);
 256         return -1;
 257 }
 258
 259 ferr_r ferr_set_internal(const char *file, int line, const char *func,
 260                          enum ferr_kind kind, const char *text, ...)
 261 {
 262         ferr_r rv;
 263         va_list va;
 264         va_start(va, text);
 265         rv = ferr_set_va(file, line, func, kind, NULL, 0, text, va);
 266         va_end(va);
 267         return rv;
 268 }
 269
 270 ferr_r ferr_set_internal_ext(const char *file, int line, const char *func,
 271                              enum ferr_kind kind, const char *pathname,
 272                              int errno_val, const char *text, ...)
 273 {
 274         ferr_r rv;
 275         va_list va;
 276         va_start(va, text);
 277         rv = ferr_set_va(file, line, func, kind, pathname, errno_val, text, va);
 278         va_end(va);
 279         return rv;
 280 }
 281
 282 #define REPLACE "$ERR"
 283 void vty_print_error(struct vty *vty, ferr_r err, const char *msg, ...)
 284 {
 285         char tmpmsg[512], *replacepos;
 286         const struct ferr *last_error = ferr_get_last(err);
 287
 288         va_list va;
 289         va_start(va, msg);
 290         vsnprintf(tmpmsg, sizeof(tmpmsg), msg, va);
 291         va_end(va);
 292
 293         replacepos = strstr(tmpmsg, REPLACE);
 294         if (!replacepos)
 295                 vty_out(vty, "%s\n", tmpmsg);
 296         else {
 297                 replacepos[0] = '\0';
 298                 replacepos += sizeof(REPLACE) - 1;
 299                 vty_out(vty, "%s%s%s\n", tmpmsg,
 300                         last_error ? last_error->message : "(no error?)",
 301                         replacepos);
 302         }
 303 }