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