lib/setenv.c

   1 /* Copyright (C) 1992,1995-1999,2000-2002 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 Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    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    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 #if HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 #ifdef __GNUC__
  24 # ifndef alloca
  25 #  define alloca __builtin_alloca
  26 # endif
  27 #else
  28 # ifdef _MSC_VER
  29 #  include <malloc.h>
  30 #  define alloca _alloca
  31 # else
  32 #  if HAVE_ALLOCA_H
  33 #   include <alloca.h>
  34 #  else
  35 #   ifdef _AIX
  36  #pragma alloca
  37 #   else
  38 #    ifdef __hpux /* This section must match that of bison generated files. */
  39 #     ifdef __cplusplus
  40 extern "C" void *alloca (unsigned int);
  41 #     else /* not __cplusplus */
  42 void *alloca ();
  43 #     endif /* not __cplusplus */
  44 #    else /* not __hpux */
  45 #     ifndef alloca
  46 char *alloca ();
  47 #     endif
  48 #    endif /* __hpux */
  49 #   endif
  50 #  endif
  51 # endif
  52 #endif
  53
  54 #include <errno.h>
  55 #if !_LIBC
  56 # if !defined errno && !defined HAVE_ERRNO_DECL
  57 extern int errno;
  58 # endif
  59 # define __set_errno(ev) ((errno) = (ev))
  60 #endif
  61
  62 #if _LIBC || HAVE_STDLIB_H
  63 # include <stdlib.h>
  64 #endif
  65 #if _LIBC || HAVE_STRING_H
  66 # include <string.h>
  67 #endif
  68 #if _LIBC || HAVE_UNISTD_H
  69 # include <unistd.h>
  70 #endif
  71
  72 /* For those losing systems which don't have 'alloca' we have to add
  73    some additional code emulating it.  */
  74 #if _LIBC || HAVE_ALLOCA
  75 # define freea(p) /* nothing */
  76 #else
  77 # define alloca(n) malloc (n)
  78 # define freea(p) free (p)
  79 #endif
  80
  81 #if !_LIBC
  82 # define __environ      environ
  83 # ifndef HAVE_ENVIRON_DECL
  84 extern char **environ;
  85 # endif
  86 #endif
  87
  88 #if _LIBC
  89 /* This lock protects against simultaneous modifications of `environ'.  */
  90 # include <bits/libc-lock.h>
  91 __libc_lock_define_initialized (static, envlock)
  92 # define LOCK   __libc_lock_lock (envlock)
  93 # define UNLOCK __libc_lock_unlock (envlock)
  94 #else
  95 # define LOCK
  96 # define UNLOCK
  97 #endif
  98
  99 /* In the GNU C library we must keep the namespace clean.  */
 100 #ifdef _LIBC
 101 # define setenv __setenv
 102 # define clearenv __clearenv
 103 # define tfind __tfind
 104 # define tsearch __tsearch
 105 #endif
 106
 107 /* In the GNU C library implementation we try to be more clever and
 108    allow arbitrarily many changes of the environment given that the used
 109    values are from a small set.  Outside glibc this will eat up all
 110    memory after a while.  */
 111 #if defined _LIBC || (defined HAVE_SEARCH_H && defined HAVE_TSEARCH \
 112                       && defined __GNUC__)
 113 # define USE_TSEARCH    1
 114 # include <search.h>
 115 typedef int (*compar_fn_t) (const void *, const void *);
 116
 117 /* This is a pointer to the root of the search tree with the known
 118    values.  */
 119 static void *known_values;
 120
 121 # define KNOWN_VALUE(Str) \
 122   ({                                                                          \
 123     void *value = tfind (Str, &known_values, (compar_fn_t) strcmp);           \
 124     value != NULL ? *(char **) value : NULL;                                  \
 125   })
 126 # define STORE_VALUE(Str) \
 127   tsearch (Str, &known_values, (compar_fn_t) strcmp)
 128
 129 #else
 130 # undef USE_TSEARCH
 131
 132 # define KNOWN_VALUE(Str) NULL
 133 # define STORE_VALUE(Str) do { } while (0)
 134
 135 #endif
 136
 137
 138 /* If this variable is not a null pointer we allocated the current
 139    environment.  */
 140 static char **last_environ;
 141
 142
 143 /* This function is used by `setenv' and `putenv'.  The difference between
 144    the two functions is that for the former must create a new string which
 145    is then placed in the environment, while the argument of `putenv'
 146    must be used directly.  This is all complicated by the fact that we try
 147    to reuse values once generated for a `setenv' call since we can never
 148    free the strings.  */
 149 int
 150 __add_to_environ (const char *name, const char *value, const char *combined,
 151                   int replace)
 152 {
 153   register char **ep;
 154   register size_t size;
 155   const size_t namelen = strlen (name);
 156   const size_t vallen = value != NULL ? strlen (value) + 1 : 0;
 157
 158   LOCK;
 159
 160   /* We have to get the pointer now that we have the lock and not earlier
 161      since another thread might have created a new environment.  */
 162   ep = __environ;
 163
 164   size = 0;
 165   if (ep != NULL)
 166     {
 167       for (; *ep != NULL; ++ep)
 168         if (!strncmp (*ep, name, namelen) && (*ep)[namelen] == '=')
 169           break;
 170         else
 171           ++size;
 172     }
 173
 174   if (ep == NULL || *ep == NULL)
 175     {
 176       char **new_environ;
 177 #ifdef USE_TSEARCH
 178       char *new_value;
 179 #endif
 180
 181       /* We allocated this space; we can extend it.  */
 182       new_environ =
 183         (char **) (last_environ == NULL
 184                    ? malloc ((size + 2) * sizeof (char *))
 185                    : realloc (last_environ, (size + 2) * sizeof (char *)));
 186       if (new_environ == NULL)
 187         {
 188           UNLOCK;
 189           return -1;
 190         }
 191
 192       /* If the whole entry is given add it.  */
 193       if (combined != NULL)
 194         /* We must not add the string to the search tree since it belongs
 195            to the user.  */
 196         new_environ[size] = (char *) combined;
 197       else
 198         {
 199           /* See whether the value is already known.  */
 200 #ifdef USE_TSEARCH
 201           new_value = (char *) alloca (namelen + 1 + vallen);
 202 # ifdef _LIBC
 203           __mempcpy (__mempcpy (__mempcpy (new_value, name, namelen), "=", 1),
 204                      value, vallen);
 205 # else
 206           memcpy (new_value, name, namelen);
 207           new_value[namelen] = '=';
 208           memcpy (&new_value[namelen + 1], value, vallen);
 209 # endif
 210
 211           new_environ[size] = KNOWN_VALUE (new_value);
 212           if (new_environ[size] == NULL)
 213 #endif
 214             {
 215               new_environ[size] = (char *) malloc (namelen + 1 + vallen);
 216               if (new_environ[size] == NULL)
 217                 {
 218 #ifdef USE_TSEARCH
 219                   freea (new_value);
 220 #endif
 221                   __set_errno (ENOMEM);
 222                   UNLOCK;
 223                   return -1;
 224                 }
 225
 226 #ifdef USE_TSEARCH
 227               memcpy (new_environ[size], new_value, namelen + 1 + vallen);
 228 #else
 229               memcpy (new_environ[size], name, namelen);
 230               new_environ[size][namelen] = '=';
 231               memcpy (&new_environ[size][namelen + 1], value, vallen);
 232 #endif
 233               /* And save the value now.  We cannot do this when we remove
 234                  the string since then we cannot decide whether it is a
 235                  user string or not.  */
 236               STORE_VALUE (new_environ[size]);
 237             }
 238 #ifdef USE_TSEARCH
 239           freea (new_value);
 240 #endif
 241         }
 242
 243       if (__environ != last_environ)
 244         memcpy ((char *) new_environ, (char *) __environ,
 245                 size * sizeof (char *));
 246
 247       new_environ[size + 1] = NULL;
 248
 249       last_environ = __environ = new_environ;
 250     }
 251   else if (replace)
 252     {
 253       char *np;
 254
 255       /* Use the user string if given.  */
 256       if (combined != NULL)
 257         np = (char *) combined;
 258       else
 259         {
 260 #ifdef USE_TSEARCH
 261           char *new_value = alloca (namelen + 1 + vallen);
 262 # ifdef _LIBC
 263           __mempcpy (__mempcpy (__mempcpy (new_value, name, namelen), "=", 1),
 264                      value, vallen);
 265 # else
 266           memcpy (new_value, name, namelen);
 267           new_value[namelen] = '=';
 268           memcpy (&new_value[namelen + 1], value, vallen);
 269 # endif
 270
 271           np = KNOWN_VALUE (new_value);
 272           if (np == NULL)
 273 #endif
 274             {
 275               np = malloc (namelen + 1 + vallen);
 276               if (np == NULL)
 277                 {
 278 #ifdef USE_TSEARCH
 279                   freea (new_value);
 280 #endif
 281                   UNLOCK;
 282                   return -1;
 283                 }
 284
 285 #ifdef USE_TSEARCH
 286               memcpy (np, new_value, namelen + 1 + vallen);
 287 #else
 288               memcpy (np, name, namelen);
 289               np[namelen] = '=';
 290               memcpy (&np[namelen + 1], value, vallen);
 291 #endif
 292               /* And remember the value.  */
 293               STORE_VALUE (np);
 294             }
 295 #ifdef USE_TSEARCH
 296           freea (new_value);
 297 #endif
 298         }
 299
 300       *ep = np;
 301     }
 302
 303   UNLOCK;
 304
 305   return 0;
 306 }
 307
 308 int
 309 setenv (const char *name, const char *value, int replace)
 310 {
 311   return __add_to_environ (name, value, NULL, replace);
 312 }
 313
 314 /* The `clearenv' was planned to be added to POSIX.1 but probably
 315    never made it.  Nevertheless the POSIX.9 standard (POSIX bindings
 316    for Fortran 77) requires this function.  */
 317 int
 318 clearenv ()
 319 {
 320   LOCK;
 321
 322   if (__environ == last_environ && __environ != NULL)
 323     {
 324       /* We allocated this environment so we can free it.  */
 325       free (__environ);
 326       last_environ = NULL;
 327     }
 328
 329   /* Clear the environment pointer removes the whole environment.  */
 330   __environ = NULL;
 331
 332   UNLOCK;
 333
 334   return 0;
 335 }
 336
 337 #ifdef _LIBC
 338 static void
 339 free_mem (void)
 340 {
 341   /* Remove all traces.  */
 342   clearenv ();
 343
 344   /* Now remove the search tree.  */
 345   __tdestroy (known_values, free);
 346   known_values = NULL;
 347 }
 348 text_set_element (__libc_subfreeres, free_mem);
 349
 350
 351 # undef setenv
 352 # undef clearenv
 353 weak_alias (__setenv, setenv)
 354 weak_alias (__clearenv, clearenv)
 355 #endif