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