git.gag.com Git - debian/tar/blob - gnu/tempname.c

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