lib/tempname.c

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