(addseverity): Remove new_string variable.
[kopensolaris-gnu/glibc.git] / stdlib / fmtmsg.c
1 /* Copyright (C) 1997,1999,2000-2003,2005 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   size_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 #ifdef USE_IN_LIBIO
158       if (_IO_fwide (stderr, 0) > 0)
159         {
160           if (__fwprintf (stderr, L"%s%s%s%s%s%s%s%s%s%s\n",
161                           do_label ? label : "",
162                           do_label
163                           && (do_severity | do_text | do_action | do_tag)
164                           ? ": " : "",
165                           do_severity ? severity_rec->string : "",
166                           do_severity && (do_text | do_action | do_tag)
167                           ? ": " : "",
168                           do_text ? text : "",
169                           do_text && (do_action | do_tag) ? "\n" : "",
170                           do_action ? "TO FIX: " : "",
171                           do_action ? action : "",
172                           do_action && do_tag ? "  " : "",
173                           do_tag ? tag : "") < 0)
174             /* Oh, oh.  An error occurred during the output.  */
175             result = MM_NOMSG;
176         }
177       else
178 #endif
179         if (fprintf (stderr, "%s%s%s%s%s%s%s%s%s%s\n",
180                      do_label ? label : "",
181                      do_label && (do_severity | do_text | do_action | do_tag)
182                      ? ": " : "",
183                      do_severity ? severity_rec->string : "",
184                      do_severity && (do_text | do_action | do_tag) ? ": " : "",
185                      do_text ? text : "",
186                      do_text && (do_action | do_tag) ? "\n" : "",
187                      do_action ? "TO FIX: " : "",
188                      do_action ? action : "",
189                      do_action && do_tag ? "  " : "",
190                      do_tag ? tag : "") < 0)
191           /* Oh, oh.  An error occurred during the output.  */
192           result = MM_NOMSG;
193     }
194
195   if (classification & MM_CONSOLE)
196     {
197       int do_label = label != MM_NULLLBL;
198       int do_severity = severity != MM_NULLSEV;
199       int do_text = text != MM_NULLTXT;
200       int do_action = action != MM_NULLACT;
201       int do_tag = tag != MM_NULLTAG;
202
203       syslog (LOG_ERR, "%s%s%s%s%s%s%s%s%s%s\n",
204               do_label ? label : "",
205               do_label && (do_severity | do_text | do_action | do_tag)
206               ? ": " : "",
207               do_severity ? severity_rec->string : "",
208               do_severity && (do_text | do_action | do_tag) ? ": " : "",
209               do_text ? text : "",
210               do_text && (do_action | do_tag) ? "\n" : "",
211               do_action ? "TO FIX: " : "",
212               do_action ? action : "",
213               do_action && do_tag ? "  " : "",
214               do_tag ? tag : "");
215     }
216
217 #ifdef __libc_ptf_call
218   __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
219 #endif
220
221   return result;
222 }
223
224
225 /* Initialize from environment variable content.  */
226 static void
227 init (void)
228 {
229   const char *msgverb_var = getenv ("MSGVERB");
230   const char *sevlevel_var = getenv ("SEV_LEVEL");
231
232   if (msgverb_var != NULL && msgverb_var[0] != '\0')
233     {
234       /* Using this extra variable allows us to work without locking.  */
235       do
236         {
237           size_t cnt;
238
239           for (cnt = 0; cnt < NKEYWORDS; ++cnt)
240             if (memcmp (msgverb_var,
241                         keywords[cnt].name, keywords[cnt].len) == 0
242                 && (msgverb_var[keywords[cnt].len] == ':'
243                     || msgverb_var[keywords[cnt].len] == '\0'))
244               break;
245
246           if (cnt < NKEYWORDS)
247             {
248               print |= 1 << cnt;
249
250               msgverb_var += keywords[cnt].len;
251               if (msgverb_var[0] == ':')
252                 ++msgverb_var;
253             }
254           else
255             {
256               /* We found an illegal keyword in the environment
257                  variable.  The specifications say that we print all
258                  fields.  */
259               print = all_mask;
260               break;
261             }
262         }
263       while (msgverb_var[0] != '\0');
264     }
265   else
266     print = all_mask;
267
268
269   if (sevlevel_var != NULL)
270     {
271       __libc_lock_lock (lock);
272
273       while (sevlevel_var[0] != '\0')
274         {
275           const char *end = __strchrnul (sevlevel_var, ':');
276           int level;
277
278           /* First field: keyword.  This is not used here but it must be
279              present.  */
280           while (sevlevel_var < end)
281             if (*sevlevel_var++ == ',')
282               break;
283
284           if (sevlevel_var < end)
285             {
286               /* Second field: severity level, a number.  */
287               char *cp;
288
289               level = strtol (sevlevel_var, &cp, 0);
290               if (cp != sevlevel_var && cp < end && *cp++ == ','
291                   && level > MM_INFO)
292                 {
293                   const char *new_string;
294
295                   new_string = __strndup (cp, end - cp);
296
297                   if (new_string != NULL
298                       && (internal_addseverity (level, new_string)
299                           != MM_OK))
300                     free ((char *) new_string);
301                 }
302             }
303
304           sevlevel_var = end + (*end == ':' ? 1 : 0);
305         }
306     }
307 }
308
309
310 /* Add the new entry to the list.  */
311 static int
312 internal_function
313 internal_addseverity (int severity, const char *string)
314 {
315   struct severity_info *runp, *lastp;
316   int result = MM_OK;
317
318   /* First see if there is already a record for the severity level.  */
319   for (runp = severity_list, lastp = NULL; runp != NULL; runp = runp->next)
320     if (runp->severity == severity)
321       break;
322     else
323       lastp = runp;
324
325   if (runp != NULL)
326     {
327       if (string != NULL)
328         /* Change the string.  */
329         runp->string = string;
330       else
331         {
332           /* Remove the severity class.  */
333           if (lastp == NULL)
334             severity_list = runp->next;
335           else
336             lastp->next = runp->next;
337
338           free (runp);
339         }
340     }
341   else if (string != NULL)
342     {
343       runp = malloc (sizeof (*runp));
344       if (runp == NULL)
345         result = MM_NOTOK;
346       else
347         {
348           runp->severity = severity;
349           runp->next = severity_list;
350           runp->string = string;
351           severity_list = runp;
352         }
353     }
354   else
355     /* We tried to remove a non-existing severity class.  */
356     result = MM_NOTOK;
357
358   return result;
359 }
360
361
362 /* Add new severity level or remove old one.  */
363 int
364 addseverity (int severity, const char *string)
365 {
366   int result;
367
368   /* Prevent illegal SEVERITY values.  */
369   if (severity <= MM_INFO)
370     return MM_NOTOK;
371
372   /* Protect the global data.  */
373   __libc_lock_lock (lock);
374
375   /* Do the real work.  */
376   result = internal_addseverity (severity, string);
377
378   /* Release the lock.  */
379   __libc_lock_unlock (lock);
380
381   return result;
382 }
383
384
385 libc_freeres_fn (free_mem)
386 {
387   struct severity_info *runp = severity_list;
388
389   while (runp != NULL)
390     if (runp->severity > MM_INFO)
391       {
392         /* This is data we have to release.  */
393         struct severity_info *here = runp;
394         runp = runp->next;
395         free (here);
396       }
397     else
398       runp = runp->next;
399 }