lib/strerror_r.c

   1 /* strerror_r.c --- POSIX compatible system error routine
   2
   3    Copyright (C) 2010-2011 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program 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
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Written by Bruno Haible <bruno@clisp.org>, 2010.  */
  19
  20 #include <config.h>
  21
  22 /* Enable declaration of sys_nerr and sys_errlist in <errno.h> on NetBSD.  */
  23 #define _NETBSD_SOURCE 1
  24
  25 /* Specification.  */
  26 #include <string.h>
  27
  28 #include <errno.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31
  32 #include "strerror-override.h"
  33
  34 #if (__GLIBC__ >= 2 || defined __UCLIBC__ || defined __CYGWIN__) && HAVE___XPG_STRERROR_R /* glibc >= 2.3.4, cygwin >= 1.7.9 */
  35
  36 # define USE_XPG_STRERROR_R 1
  37
  38 #elif HAVE_DECL_STRERROR_R && !(__GLIBC__ >= 2 || defined __UCLIBC__ || defined __CYGWIN__)
  39
  40 /* The system's strerror_r function is OK, except that its third argument
  41    is 'int', not 'size_t', or its return type is wrong.  */
  42
  43 # include <limits.h>
  44
  45 # define USE_SYSTEM_STRERROR_R 1
  46
  47 #else /* (__GLIBC__ >= 2 || defined __UCLIBC__ || defined __CYGWIN__ ? !HAVE___XPG_STRERROR_R : !HAVE_DECL_STRERROR_R) */
  48
  49 /* Use the system's strerror().  Exclude glibc and cygwin because the
  50    system strerror_r has the wrong return type, and cygwin 1.7.9
  51    strerror_r clobbers strerror.  */
  52 # undef strerror
  53
  54 # define USE_SYSTEM_STRERROR 1
  55
  56 # if defined __NetBSD__ || defined __hpux || ((defined _WIN32 || defined __WIN32__) && !defined __CYGWIN__) || defined __sgi || (defined __sun && !defined _LP64) || defined __CYGWIN__
  57
  58 /* No locking needed.  */
  59
  60 /* Get catgets internationalization functions.  */
  61 #  if HAVE_CATGETS
  62 #   include <nl_types.h>
  63 #  endif
  64
  65 /* Get sys_nerr, sys_errlist on HP-UX (otherwise only declared in C++ mode).
  66    Get sys_nerr, sys_errlist on IRIX (otherwise only declared with _SGIAPI).  */
  67 #  if defined __hpux || defined __sgi
  68 extern int sys_nerr;
  69 extern char *sys_errlist[];
  70 #  endif
  71
  72 /* Get sys_nerr on Solaris.  */
  73 #  if defined __sun && !defined _LP64
  74 extern int sys_nerr;
  75 #  endif
  76
  77 # else
  78
  79 #  include "glthread/lock.h"
  80
  81 /* This lock protects the buffer returned by strerror().  We assume that
  82    no other uses of strerror() exist in the program.  */
  83 gl_lock_define_initialized(static, strerror_lock)
  84
  85 # endif
  86
  87 #endif
  88
  89 /* Copy as much of MSG into BUF as possible, without corrupting errno.
  90    Return 0 if MSG fit in BUFLEN, otherwise return ERANGE.  */
  91 static int
  92 safe_copy (char *buf, size_t buflen, const char *msg)
  93 {
  94   size_t len = strlen (msg);
  95   int ret;
  96
  97   if (len < buflen)
  98     {
  99       /* Although POSIX allows memcpy() to corrupt errno, we don't
 100          know of any implementation where this is a real problem.  */
 101       memcpy (buf, msg, len + 1);
 102       ret = 0;
 103     }
 104   else
 105     {
 106       memcpy (buf, msg, buflen - 1);
 107       buf[buflen - 1] = '\0';
 108       ret = ERANGE;
 109     }
 110   return ret;
 111 }
 112
 113
 114 int
 115 strerror_r (int errnum, char *buf, size_t buflen)
 116 #undef strerror_r
 117 {
 118   /* Filter this out now, so that rest of this replacement knows that
 119      there is room for a non-empty message and trailing NUL.  */
 120   if (buflen <= 1)
 121     {
 122       if (buflen)
 123         *buf = '\0';
 124       return ERANGE;
 125     }
 126   *buf = '\0';
 127
 128   /* Check for gnulib overrides.  */
 129   {
 130     char const *msg = strerror_override (errnum);
 131
 132     if (msg)
 133       return safe_copy (buf, buflen, msg);
 134   }
 135
 136   {
 137     int ret;
 138     int saved_errno = errno;
 139
 140 #if USE_XPG_STRERROR_R
 141
 142     {
 143       extern int __xpg_strerror_r (int errnum, char *buf, size_t buflen);
 144
 145       ret = __xpg_strerror_r (errnum, buf, buflen);
 146       if (ret < 0)
 147         ret = errno;
 148       if (!*buf)
 149         {
 150           /* glibc 2.13 would not touch buf on err, so we have to fall
 151              back to GNU strerror_r which always returns a thread-safe
 152              untruncated string to (partially) copy into our buf.  */
 153           safe_copy (buf, buflen, strerror_r (errnum, buf, buflen));
 154         }
 155     }
 156
 157 #elif USE_SYSTEM_STRERROR_R
 158
 159     if (buflen > INT_MAX)
 160       buflen = INT_MAX;
 161
 162 # ifdef __hpux
 163     /* On HP-UX 11.31, strerror_r always fails when buflen < 80; it
 164        also fails to change buf on EINVAL.  */
 165     {
 166       char stackbuf[80];
 167
 168       if (buflen < sizeof stackbuf)
 169         {
 170           ret = strerror_r (errnum, stackbuf, sizeof stackbuf);
 171           if (ret == 0)
 172             ret = safe_copy (buf, buflen, stackbuf);
 173         }
 174       else
 175         ret = strerror_r (errnum, buf, buflen);
 176     }
 177 # else
 178     /* Solaris 10 does not populate buf on ERANGE.  */
 179     ret = strerror_r (errnum, buf, buflen);
 180     if (ret == ERANGE && !*buf)
 181       {
 182         char stackbuf[STACKBUF_LEN];
 183
 184         if (strerror_r (errnum, stackbuf, sizeof stackbuf) == ERANGE)
 185           /* STACKBUF_LEN should have been large enough.  */
 186           abort ();
 187         safe_copy (buf, buflen, stackbuf);
 188       }
 189 # endif
 190
 191 # ifdef _AIX
 192     /* AIX returns 0 rather than ERANGE when truncating strings; try
 193        again until we are sure we got the entire string.  */
 194     if (!ret && strlen (buf) == buflen - 1)
 195       {
 196         char stackbuf[STACKBUF_LEN];
 197         size_t len;
 198         strerror_r (errnum, stackbuf, sizeof stackbuf);
 199         len = strlen (stackbuf);
 200         /* STACKBUF_LEN should have been large enough.  */
 201         if (len + 1 == sizeof stackbuf)
 202           abort ();
 203         if (buflen <= len)
 204           ret = ERANGE;
 205       }
 206 # endif
 207
 208     /* Some old implementations may return (-1, EINVAL) instead of EINVAL.  */
 209     if (ret < 0)
 210       ret = errno;
 211
 212     /* FreeBSD rejects 0; see http://austingroupbugs.net/view.php?id=382.  */
 213     if (errnum == 0 && ret == EINVAL)
 214       ret = safe_copy (buf, buflen, "Success");
 215
 216 #else /* USE_SYSTEM_STRERROR */
 217
 218     /* Try to do what strerror (errnum) does, but without clobbering the
 219        buffer used by strerror().  */
 220
 221 # if defined __NetBSD__ || defined __hpux || ((defined _WIN32 || defined __WIN32__) && !defined __CYGWIN__) || defined __CYGWIN__ /* NetBSD, HP-UX, native Win32, Cygwin */
 222
 223     /* NetBSD:        sys_nerr, sys_errlist are declared through _NETBSD_SOURCE
 224                       and <errno.h> above.
 225        HP-UX:         sys_nerr, sys_errlist are declared explicitly above.
 226        native Win32:  sys_nerr, sys_errlist are declared in <stdlib.h>.
 227        Cygwin:        sys_nerr, sys_errlist are declared in <errno.h>.  */
 228     if (errnum >= 0 && errnum < sys_nerr)
 229       {
 230 #  if HAVE_CATGETS && (defined __NetBSD__ || defined __hpux)
 231 #   if defined __NetBSD__
 232         nl_catd catd = catopen ("libc", NL_CAT_LOCALE);
 233         const char *errmsg =
 234           (catd != (nl_catd)-1
 235            ? catgets (catd, 1, errnum, sys_errlist[errnum])
 236            : sys_errlist[errnum]);
 237 #   endif
 238 #   if defined __hpux
 239         nl_catd catd = catopen ("perror", NL_CAT_LOCALE);
 240         const char *errmsg =
 241           (catd != (nl_catd)-1
 242            ? catgets (catd, 1, 1 + errnum, sys_errlist[errnum])
 243            : sys_errlist[errnum]);
 244 #   endif
 245 #  else
 246         const char *errmsg = sys_errlist[errnum];
 247 #  endif
 248         if (errmsg == NULL || *errmsg == '\0')
 249           ret = EINVAL;
 250         else
 251           ret = safe_copy (buf, buflen, errmsg);
 252 #  if HAVE_CATGETS && (defined __NetBSD__ || defined __hpux)
 253         if (catd != (nl_catd)-1)
 254           catclose (catd);
 255 #  endif
 256       }
 257     else
 258       ret = EINVAL;
 259
 260 # elif defined __sgi || (defined __sun && !defined _LP64) /* IRIX, Solaris <= 9 32-bit */
 261
 262     /* For a valid error number, the system's strerror() function returns
 263        a pointer to a not copied string, not to a buffer.  */
 264     if (errnum >= 0 && errnum < sys_nerr)
 265       {
 266         char *errmsg = strerror (errnum);
 267
 268         if (errmsg == NULL || *errmsg == '\0')
 269           ret = EINVAL;
 270         else
 271           ret = safe_copy (buf, buflen, errmsg);
 272       }
 273     else
 274       ret = EINVAL;
 275
 276 # else
 277
 278     gl_lock_lock (strerror_lock);
 279
 280     {
 281       char *errmsg = strerror (errnum);
 282
 283       /* For invalid error numbers, strerror() on
 284            - IRIX 6.5 returns NULL,
 285            - HP-UX 11 returns an empty string.  */
 286       if (errmsg == NULL || *errmsg == '\0')
 287         ret = EINVAL;
 288       else
 289         ret = safe_copy (buf, buflen, errmsg);
 290     }
 291
 292     gl_lock_unlock (strerror_lock);
 293
 294 # endif
 295
 296 #endif
 297
 298     if (ret == EINVAL && !*buf)
 299       snprintf (buf, buflen, "Unknown error %d", errnum);
 300
 301     errno = saved_errno;
 302     return ret;
 303   }
 304 }