lib/tempname.c

   1 /* Copyright (C) 1991-1999, 2000, 2001 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 #if HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 #include <sys/types.h>
  24 #include <assert.h>
  25
  26 #include <errno.h>
  27 #ifndef __set_errno
  28 # define __set_errno(Val) errno = (Val)
  29 #endif
  30
  31 #include <stdio.h>
  32 #ifndef P_tmpdir
  33 # define P_tmpdir "/tmp"
  34 #endif
  35 #ifndef TMP_MAX
  36 # define TMP_MAX 238328
  37 #endif
  38 #ifndef __GT_FILE
  39 # define __GT_FILE      0
  40 # define __GT_BIGFILE   1
  41 # define __GT_DIR       2
  42 # define __GT_NOCREATE  3
  43 #endif
  44
  45 #if STDC_HEADERS || _LIBC
  46 # include <stddef.h>
  47 # include <stdlib.h>
  48 # include <string.h>
  49 #endif
  50
  51 #if HAVE_FCNTL_H || _LIBC
  52 # include <fcntl.h>
  53 #endif
  54
  55 #if HAVE_SYS_TIME_H || _LIBC
  56 # include <sys/time.h>
  57 #endif
  58
  59 #if HAVE_STDINT_H || _LIBC
  60 # include <stdint.h>
  61 #endif
  62
  63 #if HAVE_UNISTD_H || _LIBC
  64 # include <unistd.h>
  65 #endif
  66
  67 #include <sys/stat.h>
  68 #if STAT_MACROS_BROKEN
  69 # undef S_ISDIR
  70 #endif
  71 #if !defined S_ISDIR && defined S_IFDIR
  72 # define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
  73 #endif
  74 #if !S_IRUSR && S_IREAD
  75 # define S_IRUSR S_IREAD
  76 #endif
  77 #if !S_IRUSR
  78 # define S_IRUSR 00400
  79 #endif
  80 #if !S_IWUSR && S_IWRITE
  81 # define S_IWUSR S_IWRITE
  82 #endif
  83 #if !S_IWUSR
  84 # define S_IWUSR 00200
  85 #endif
  86 #if !S_IXUSR && S_IEXEC
  87 # define S_IXUSR S_IEXEC
  88 #endif
  89 #if !S_IXUSR
  90 # define S_IXUSR 00100
  91 #endif
  92
  93 #if _LIBC
  94 # define struct_stat64 struct stat64
  95 #else
  96 # define struct_stat64 struct stat
  97 # define __getpid getpid
  98 # define __gettimeofday gettimeofday
  99 # define __mkdir mkdir
 100 # define __open open
 101 # define __open64 open
 102 # define __lxstat64(version, path, buf) lstat (path, buf)
 103 # define __xstat64(version, path, buf) stat (path, buf)
 104 #endif
 105
 106 #if ! (HAVE___SECURE_GETENV || _LIBC)
 107 # define __secure_getenv getenv
 108
 109 # ifndef HAVE_DECL_GETENV
 110 "this configure-time declaration test was not run"
 111 # endif
 112 # if !HAVE_DECL_GETENV
 113 char *getenv ();
 114 # endif
 115 #endif
 116
 117 #ifdef _LIBC
 118 # include <hp-timing.h>
 119 # if HP_TIMING_AVAIL
 120 #  define RANDOM_BITS(Var) \
 121   if (__builtin_expect (value == UINT64_C (0), 0))                            \
 122     {                                                                         \
 123       /* If this is the first time this function is used initialize           \
 124          the variable we accumulate the value in to some somewhat             \
 125          random value.  If we'd not do this programs at startup time          \
 126          might have a reduced set of possible names, at least on slow         \
 127          machines.  */                                                        \
 128       struct timeval tv;                                                      \
 129       __gettimeofday (&tv, NULL);                                             \
 130       value = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;                      \
 131     }                                                                         \
 132   HP_TIMING_NOW (Var)
 133 # endif
 134 #endif
 135
 136 /* Use the widest available unsigned type if uint64_t is not
 137    available.  The algorithm below extracts a number less than 62**6
 138    (approximately 2**35.725) from uint64_t, so ancient hosts where
 139    uintmax_t is only 32 bits lose about 3.725 bits of randomness,
 140    which is better than not having mkstemp at all.  */
 141 #if !defined UINT64_MAX && !defined uint64_t
 142 # define uint64_t uintmax_t
 143 #endif
 144
 145 /* Return nonzero if DIR is an existent directory.  */
 146 static int
 147 direxists (const char *dir)
 148 {
 149   struct_stat64 buf;
 150   return __xstat64 (_STAT_VER, dir, &buf) == 0 && S_ISDIR (buf.st_mode);
 151 }
 152
 153 /* Path search algorithm, for tmpnam, tmpfile, etc.  If DIR is
 154    non-null and exists, uses it; otherwise uses the first of $TMPDIR,
 155    P_tmpdir, /tmp that exists.  Copies into TMPL a template suitable
 156    for use with mk[s]temp.  Will fail (-1) if DIR is non-null and
 157    doesn't exist, none of the searched dirs exists, or there's not
 158    enough space in TMPL. */
 159 int
 160 __path_search (char *tmpl, size_t tmpl_len, const char *dir, const char *pfx,
 161                int try_tmpdir)
 162 {
 163   const char *d;
 164   size_t dlen, plen;
 165
 166   if (!pfx || !pfx[0])
 167     {
 168       pfx = "file";
 169       plen = 4;
 170     }
 171   else
 172     {
 173       plen = strlen (pfx);
 174       if (plen > 5)
 175         plen = 5;
 176     }
 177
 178   if (try_tmpdir)
 179     {
 180       d = __secure_getenv ("TMPDIR");
 181       if (d != NULL && direxists (d))
 182         dir = d;
 183       else if (dir != NULL && direxists (dir))
 184         /* nothing */ ;
 185       else
 186         dir = NULL;
 187     }
 188   if (dir == NULL)
 189     {
 190       if (direxists (P_tmpdir))
 191         dir = P_tmpdir;
 192       else if (strcmp (P_tmpdir, "/tmp") != 0 && direxists ("/tmp"))
 193         dir = "/tmp";
 194       else
 195         {
 196           __set_errno (ENOENT);
 197           return -1;
 198         }
 199     }
 200
 201   dlen = strlen (dir);
 202   while (dlen > 1 && dir[dlen - 1] == '/')
 203     dlen--;                     /* remove trailing slashes */
 204
 205   /* check we have room for "${dir}/${pfx}XXXXXX\0" */
 206   if (tmpl_len < dlen + 1 + plen + 6 + 1)
 207     {
 208       __set_errno (EINVAL);
 209       return -1;
 210     }
 211
 212   sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);
 213   return 0;
 214 }
 215
 216 /* These are the characters used in temporary filenames.  */
 217 static const char letters[] =
 218 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
 219
 220 /* Generate a temporary file name based on TMPL.  TMPL must match the
 221    rules for mk[s]temp (i.e. end in "XXXXXX").  The name constructed
 222    does not exist at the time of the call to __gen_tempname.  TMPL is
 223    overwritten with the result.
 224
 225    KIND may be one of:
 226    __GT_NOCREATE:       simply verify that the name does not exist
 227                         at the time of the call.
 228    __GT_FILE:           create the file using open(O_CREAT|O_EXCL)
 229                         and return a read-write fd.  The file is mode 0600.
 230    __GT_BIGFILE:        same as __GT_FILE but use open64().
 231    __GT_DIR:            create a directory, which will be mode 0700.
 232
 233    We use a clever algorithm to get hard-to-predict names. */
 234 int
 235 __gen_tempname (char *tmpl, int kind)
 236 {
 237   int len;
 238   char *XXXXXX;
 239   static uint64_t value;
 240   uint64_t random_time_bits;
 241   unsigned int count;
 242   int fd = -1;
 243   int save_errno = errno;
 244   struct_stat64 st;
 245
 246   /* A lower bound on the number of temporary files to attempt to
 247      generate.  The maximum total number of temporary file names that
 248      can exist for a given template is 62**6.  It should never be
 249      necessary to try all these combinations.  Instead if a reasonable
 250      number of names is tried (we define reasonable as 62**3) fail to
 251      give the system administrator the chance to remove the problems.  */
 252   unsigned int attempts_min = 62 * 62 * 62;
 253
 254   /* The number of times to attempt to generate a temporary file.  To
 255      conform to POSIX, this must be no smaller than TMP_MAX.  */
 256   unsigned int attempts = attempts_min < TMP_MAX ? TMP_MAX : attempts_min;
 257
 258   len = strlen (tmpl);
 259   if (len < 6 || strcmp (&tmpl[len - 6], "XXXXXX"))
 260     {
 261       __set_errno (EINVAL);
 262       return -1;
 263     }
 264
 265   /* This is where the Xs start.  */
 266   XXXXXX = &tmpl[len - 6];
 267
 268   /* Get some more or less random data.  */
 269 #ifdef RANDOM_BITS
 270   RANDOM_BITS (random_time_bits);
 271 #else
 272 # if HAVE_GETTIMEOFDAY || _LIBC
 273   {
 274     struct timeval tv;
 275     __gettimeofday (&tv, NULL);
 276     random_time_bits = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;
 277   }
 278 # else
 279   random_time_bits = time (NULL);
 280 # endif
 281 #endif
 282   value += random_time_bits ^ __getpid ();
 283
 284   for (count = 0; count < attempts; value += 7777, ++count)
 285     {
 286       uint64_t v = value;
 287
 288       /* Fill in the random bits.  */
 289       XXXXXX[0] = letters[v % 62];
 290       v /= 62;
 291       XXXXXX[1] = letters[v % 62];
 292       v /= 62;
 293       XXXXXX[2] = letters[v % 62];
 294       v /= 62;
 295       XXXXXX[3] = letters[v % 62];
 296       v /= 62;
 297       XXXXXX[4] = letters[v % 62];
 298       v /= 62;
 299       XXXXXX[5] = letters[v % 62];
 300
 301       switch (kind)
 302         {
 303         case __GT_FILE:
 304           fd = __open (tmpl, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 305           break;
 306
 307         case __GT_BIGFILE:
 308           fd = __open64 (tmpl, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 309           break;
 310
 311         case __GT_DIR:
 312           fd = __mkdir (tmpl, S_IRUSR | S_IWUSR | S_IXUSR);
 313           break;
 314
 315         case __GT_NOCREATE:
 316           /* This case is backward from the other three.  __gen_tempname
 317              succeeds if __xstat fails because the name does not exist.
 318              Note the continue to bypass the common logic at the bottom
 319              of the loop.  */
 320           if (__lxstat64 (_STAT_VER, tmpl, &st) < 0)
 321             {
 322               if (errno == ENOENT)
 323                 {
 324                   __set_errno (save_errno);
 325                   return 0;
 326                 }
 327               else
 328                 /* Give up now. */
 329                 return -1;
 330             }
 331           continue;
 332
 333         default:
 334           assert (! "invalid KIND in __gen_tempname");
 335         }
 336
 337       if (fd >= 0)
 338         {
 339           __set_errno (save_errno);
 340           return fd;
 341         }
 342       else if (errno != EEXIST)
 343         return -1;
 344     }
 345
 346   /* We got out of the loop because we ran out of combinations to try.  */
 347   __set_errno (EEXIST);
 348   return -1;
 349 }