stdlib/fmtmsg.c

   1 /* Copyright (C) 1997,1999,2000-2003,2005, 2006 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #include <fmtmsg.h>
  21 #include <bits/libc-lock.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/syslog.h>
  26 #ifdef USE_IN_LIBIO
  27 # include <wchar.h>
  28 #endif
  29
  30
  31 /* We have global data, protect the modification.  */
  32 __libc_lock_define_initialized (static, lock)
  33
  34
  35 enum
  36 {
  37   label_mask = 0x01,
  38   severity_mask = 0x02,
  39   text_mask = 0x04,
  40   action_mask = 0x08,
  41   tag_mask = 0x10,
  42   all_mask = label_mask | severity_mask | text_mask | action_mask | tag_mask
  43 };
  44
  45 static const struct
  46 {
  47   uint32_t len;
  48   /* Adjust the size if new elements are added.  */
  49   const char name[12];
  50 } keywords[] =
  51   {
  52     { 5, "label" },
  53     { 8, "severity" },
  54     { 4, "text" },
  55     { 6, "action"},
  56     { 3, "tag" }
  57   };
  58 #define NKEYWORDS (sizeof( keywords) / sizeof (keywords[0]))
  59
  60
  61 struct severity_info
  62 {
  63   int severity;
  64   const char *string;
  65   struct severity_info *next;
  66 };
  67
  68
  69 /* List of known severities.  */
  70 static const struct severity_info nosev =
  71 {
  72   MM_NOSEV, "", NULL
  73 };
  74 static const struct severity_info haltsev =
  75 {
  76   MM_HALT, "HALT", (struct severity_info *) &nosev
  77 };
  78 static const struct severity_info errorsev =
  79 {
  80   MM_ERROR, "ERROR", (struct severity_info *) &haltsev
  81 };
  82 static const struct severity_info warningsev =
  83 {
  84   MM_WARNING, "WARNING", (struct severity_info *) &errorsev
  85 };
  86 static const struct severity_info infosev =
  87 {
  88   MM_INFO, "INFO", (struct severity_info *) &warningsev
  89 };
  90
  91 /* Start of the list.  */
  92 static struct severity_info *severity_list = (struct severity_info *) &infosev;
  93
  94 /* Mask of values we will print.  */
  95 static int print;
  96
  97 /* Prototypes for local functions.  */
  98 static void init (void);
  99 static int internal_addseverity (int severity, const char *string)
 100      internal_function;
 101
 102
 103 int
 104 fmtmsg (long int classification, const char *label, int severity,
 105         const char *text, const char *action, const char *tag)
 106 {
 107   __libc_once_define (static, once);
 108   int result = MM_OK;
 109   struct severity_info *severity_rec;
 110
 111   /* Make sure everything is initialized.  */
 112   __libc_once (once, init);
 113
 114   /* Start the real work.  First check whether the input is ok.  */
 115   if (label != MM_NULLLBL)
 116     {
 117       /* Must be two fields, separated by a colon.  */
 118       const char *cp = strchr (label, ':');
 119       if (cp == NULL)
 120         return MM_NOTOK;
 121
 122       /* The first field must not contain more then 10 bytes.  */
 123       if (cp - label > 10
 124           /* The second field must not have more then 14 bytes.  */
 125           || strlen (cp + 1) > 14)
 126         return MM_NOTOK;
 127     }
 128
 129   for (severity_rec = severity_list; severity_rec != NULL;
 130        severity_rec = severity_rec->next)
 131     if (severity == severity_rec->severity)
 132       /* Bingo.  */
 133       break;
 134
 135   /* If we don't know anything about the severity level return an error.  */
 136   if (severity_rec == NULL)
 137     return MM_NOTOK;
 138
 139
 140 #ifdef __libc_ptf_call
 141   /* We do not want this call to be cut short by a thread
 142      cancellation.  Therefore disable cancellation for now.  */
 143   int state = PTHREAD_CANCEL_ENABLE;
 144   __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
 145                    0);
 146 #endif
 147
 148   /* Now we can print.  */
 149   if (classification & MM_PRINT)
 150     {
 151       int do_label = (print & label_mask) && label != MM_NULLLBL;
 152       int do_severity = (print & severity_mask) && severity != MM_NULLSEV;
 153       int do_text = (print & text_mask) && text != MM_NULLTXT;
 154       int do_action = (print & action_mask) && action != MM_NULLACT;
 155       int do_tag = (print & tag_mask) && tag != MM_NULLTAG;
 156
 157       if (__fxprintf (stderr, "%s%s%s%s%s%s%s%s%s%s\n",
 158                       do_label ? label : "",
 159                       do_label && (do_severity | do_text | do_action | do_tag)
 160                       ? ": " : "",
 161                       do_severity ? severity_rec->string : "",
 162                       do_severity && (do_text | do_action | do_tag)
 163                       ? ": " : "",
 164                       do_text ? text : "",
 165                       do_text && (do_action | do_tag) ? "\n" : "",
 166                       do_action ? "TO FIX: " : "",
 167                       do_action ? action : "",
 168                       do_action && do_tag ? "  " : "",
 169                       do_tag ? tag : "") < 0)
 170         /* Oh, oh.  An error occurred during the output.  */
 171         result = MM_NOMSG;
 172     }
 173
 174   if (classification & MM_CONSOLE)
 175     {
 176       int do_label = label != MM_NULLLBL;
 177       int do_severity = severity != MM_NULLSEV;
 178       int do_text = text != MM_NULLTXT;
 179       int do_action = action != MM_NULLACT;
 180       int do_tag = tag != MM_NULLTAG;
 181
 182       syslog (LOG_ERR, "%s%s%s%s%s%s%s%s%s%s\n",
 183               do_label ? label : "",
 184               do_label && (do_severity | do_text | do_action | do_tag)
 185               ? ": " : "",
 186               do_severity ? severity_rec->string : "",
 187               do_severity && (do_text | do_action | do_tag) ? ": " : "",
 188               do_text ? text : "",
 189               do_text && (do_action | do_tag) ? "\n" : "",
 190               do_action ? "TO FIX: " : "",
 191               do_action ? action : "",
 192               do_action && do_tag ? "  " : "",
 193               do_tag ? tag : "");
 194     }
 195
 196 #ifdef __libc_ptf_call
 197   __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
 198 #endif
 199
 200   return result;
 201 }
 202
 203
 204 /* Initialize from environment variable content.  */
 205 static void
 206 init (void)
 207 {
 208   const char *msgverb_var = getenv ("MSGVERB");
 209   const char *sevlevel_var = getenv ("SEV_LEVEL");
 210
 211   if (msgverb_var != NULL && msgverb_var[0] != '\0')
 212     {
 213       /* Using this extra variable allows us to work without locking.  */
 214       do
 215         {
 216           size_t cnt;
 217
 218           for (cnt = 0; cnt < NKEYWORDS; ++cnt)
 219             if (memcmp (msgverb_var,
 220                         keywords[cnt].name, keywords[cnt].len) == 0
 221                 && (msgverb_var[keywords[cnt].len] == ':'
 222                     || msgverb_var[keywords[cnt].len] == '\0'))
 223               break;
 224
 225           if (cnt < NKEYWORDS)
 226             {
 227               print |= 1 << cnt;
 228
 229               msgverb_var += keywords[cnt].len;
 230               if (msgverb_var[0] == ':')
 231                 ++msgverb_var;
 232             }
 233           else
 234             {
 235               /* We found an illegal keyword in the environment
 236                  variable.  The specifications say that we print all
 237                  fields.  */
 238               print = all_mask;
 239               break;
 240             }
 241         }
 242       while (msgverb_var[0] != '\0');
 243     }
 244   else
 245     print = all_mask;
 246
 247
 248   if (sevlevel_var != NULL)
 249     {
 250       __libc_lock_lock (lock);
 251
 252       while (sevlevel_var[0] != '\0')
 253         {
 254           const char *end = __strchrnul (sevlevel_var, ':');
 255           int level;
 256
 257           /* First field: keyword.  This is not used here but it must be
 258              present.  */
 259           while (sevlevel_var < end)
 260             if (*sevlevel_var++ == ',')
 261               break;
 262
 263           if (sevlevel_var < end)
 264             {
 265               /* Second field: severity level, a number.  */
 266               char *cp;
 267
 268               level = strtol (sevlevel_var, &cp, 0);
 269               if (cp != sevlevel_var && cp < end && *cp++ == ','
 270                   && level > MM_INFO)
 271                 {
 272                   const char *new_string;
 273
 274                   new_string = __strndup (cp, end - cp);
 275
 276                   if (new_string != NULL
 277                       && (internal_addseverity (level, new_string)
 278                           != MM_OK))
 279                     free ((char *) new_string);
 280                 }
 281             }
 282
 283           sevlevel_var = end + (*end == ':' ? 1 : 0);
 284         }
 285     }
 286 }
 287
 288
 289 /* Add the new entry to the list.  */
 290 static int
 291 internal_function
 292 internal_addseverity (int severity, const char *string)
 293 {
 294   struct severity_info *runp, *lastp;
 295   int result = MM_OK;
 296
 297   /* First see if there is already a record for the severity level.  */
 298   for (runp = severity_list, lastp = NULL; runp != NULL; runp = runp->next)
 299     if (runp->severity == severity)
 300       break;
 301     else
 302       lastp = runp;
 303
 304   if (runp != NULL)
 305     {
 306       if (string != NULL)
 307         /* Change the string.  */
 308         runp->string = string;
 309       else
 310         {
 311           /* Remove the severity class.  */
 312           if (lastp == NULL)
 313             severity_list = runp->next;
 314           else
 315             lastp->next = runp->next;
 316
 317           free (runp);
 318         }
 319     }
 320   else if (string != NULL)
 321     {
 322       runp = malloc (sizeof (*runp));
 323       if (runp == NULL)
 324         result = MM_NOTOK;
 325       else
 326         {
 327           runp->severity = severity;
 328           runp->next = severity_list;
 329           runp->string = string;
 330           severity_list = runp;
 331         }
 332     }
 333   else
 334     /* We tried to remove a non-existing severity class.  */
 335     result = MM_NOTOK;
 336
 337   return result;
 338 }
 339
 340
 341 /* Add new severity level or remove old one.  */
 342 int
 343 addseverity (int severity, const char *string)
 344 {
 345   int result;
 346
 347   /* Prevent illegal SEVERITY values.  */
 348   if (severity <= MM_INFO)
 349     return MM_NOTOK;
 350
 351   /* Protect the global data.  */
 352   __libc_lock_lock (lock);
 353
 354   /* Do the real work.  */
 355   result = internal_addseverity (severity, string);
 356
 357   /* Release the lock.  */
 358   __libc_lock_unlock (lock);
 359
 360   return result;
 361 }
 362
 363
 364 libc_freeres_fn (free_mem)
 365 {
 366   struct severity_info *runp = severity_list;
 367
 368   while (runp != NULL)
 369     if (runp->severity > MM_INFO)
 370       {
 371         /* This is data we have to release.  */
 372         struct severity_info *here = runp;
 373         runp = runp->next;
 374         free (here);
 375       }
 376     else
 377       runp = runp->next;
 378 }