misc/setenv.c

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