New module 'strsignal'.
[gnulib.git] / lib / strsignal.c
1 /* Copyright (C) 1991, 1994-2002, 2005, 2008 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, write to the Free
16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17    02111-1307 USA.  */
18
19 #ifndef _LIBC
20 # include <config.h>
21 #endif
22
23 #include <signal.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27
28 #ifdef _LIBC
29 # include <libintl.h>
30 #else /* !_LIBC */
31 # include "gettext.h"
32 # define _(msgid) gettext (msgid)
33 # define N_(msgid) gettext_noop (msgid)
34 #endif /* _LIBC */
35
36 #ifdef _LIBC
37 # include <bits/libc-lock.h>
38 #else /* !_LIBC */
39 # include "lock.h"
40 # include "tls.h"
41 # define __libc_once_define(CLASS, NAME) gl_once_define (CLASS, NAME)
42 # define __libc_once(NAME, INIT) gl_once ((NAME), (INIT))
43 # define __libc_key_t gl_tls_key_t
44 # define __libc_getspecific(NAME) gl_tls_get ((NAME))
45 # define __libc_setspecific(NAME, POINTER) gl_tls_set ((NAME), (POINTER))
46 # define __snprintf snprintf
47 #endif /* _LIBC */
48
49 #ifdef _LIBC
50
51 /* Defined in siglist.c.  */
52 extern const char *const _sys_siglist[];
53 extern const char *const _sys_siglist_internal[] attribute_hidden;
54
55 #else /* !_LIBC */
56
57 /* NetBSD declares sys_siglist in unistd.h. */
58 # include <unistd.h>
59
60 # define INTUSE(x) (x)
61
62 # if HAVE_DECL_SYS_SIGLIST
63 #  undef _sys_siglist
64 #  define _sys_siglist sys_siglist
65 # else /* !HAVE_DECL_SYS_SIGLIST */
66 #  ifndef NSIG
67 #   define NSIG 32
68 #  endif /* NSIG */
69 static const char *_sys_siglist[NSIG];
70 # endif /* !HAVE_DECL_SYS_SIGLIST */
71
72 #endif /* _LIBC */
73
74 static __libc_key_t key;
75
76 /* If nonzero the key allocation failed and we should better use a
77    static buffer than fail.  */
78 #define BUFFERSIZ       100
79 static char local_buf[BUFFERSIZ];
80 static char *static_buf;
81
82 /* Destructor for the thread-specific data.  */
83 static void init (void);
84 static void free_key_mem (void *mem);
85 static char *getbuffer (void);
86
87
88 /* Return a string describing the meaning of the signal number SIGNUM.  */
89 char *
90 strsignal (int signum)
91 {
92   const char *desc;
93   __libc_once_define (static, once);
94
95   /* If we have not yet initialized the buffer do it now.  */
96   __libc_once (once, init);
97
98   if (
99 #ifdef SIGRTMIN
100       (signum >= SIGRTMIN && signum <= SIGRTMAX) ||
101 #endif
102       signum < 0 || signum >= NSIG
103       || (desc = INTUSE(_sys_siglist)[signum]) == NULL)
104     {
105       char *buffer = getbuffer ();
106       int len;
107 #ifdef SIGRTMIN
108       if (signum >= SIGRTMIN && signum <= SIGRTMAX)
109         len = __snprintf (buffer, BUFFERSIZ - 1, _("Real-time signal %d"),
110                           signum - SIGRTMIN);
111       else
112 #endif
113         len = __snprintf (buffer, BUFFERSIZ - 1, _("Unknown signal %d"),
114                           signum);
115       if (len >= BUFFERSIZ)
116         buffer = NULL;
117       else
118         buffer[len] = '\0';
119
120       return buffer;
121     }
122
123   return (char *) _(desc);
124 }
125
126
127 /* Initialize buffer.  */
128 static void
129 init (void)
130 {
131 #ifdef _LIBC
132   if (__libc_key_create (&key, free_key_mem))
133     /* Creating the key failed.  This means something really went
134        wrong.  In any case use a static buffer which is better than
135        nothing.  */
136     static_buf = local_buf;
137 #else /* !_LIBC */
138   gl_tls_key_init (key, free_key_mem);
139
140 # if !HAVE_DECL_SYS_SIGLIST
141   memset (_sys_siglist, 0, NSIG * sizeof *_sys_siglist);
142
143   /* No need to use a do {} while (0) here since init_sig(...) must expand
144      to a complete statement.  (We cannot use the ISO C99 designated array
145      initializer syntax since it is not supported by ANSI C compilers and
146      since some signal numbers might exceed NSIG.)  */
147 #  define init_sig(sig, abbrev, desc) \
148   if (sig >= 0 && sig < NSIG) \
149     _sys_siglist[sig] = desc;
150 } while (0);
151
152 #  include "siglist.h"
153
154 #  undef init_sig
155
156 # endif /* !HAVE_DECL_SYS_SIGLIST */
157 #endif /* !_LIBC */
158 }
159
160
161 /* Free the thread specific data, this is done if a thread terminates.  */
162 static void
163 free_key_mem (void *mem)
164 {
165   free (mem);
166   __libc_setspecific (key, NULL);
167 }
168
169
170 /* Return the buffer to be used.  */
171 static char *
172 getbuffer (void)
173 {
174   char *result;
175
176   if (static_buf != NULL)
177     result = static_buf;
178   else
179     {
180       /* We don't use the static buffer and so we have a key.  Use it
181          to get the thread-specific buffer.  */
182       result = __libc_getspecific (key);
183       if (result == NULL)
184         {
185           /* No buffer allocated so far.  */
186           result = malloc (BUFFERSIZ);
187           if (result == NULL)
188             /* No more memory available.  We use the static buffer.  */
189             result = local_buf;
190           else
191             __libc_setspecific (key, result);
192         }
193     }
194
195   return result;
196 }