1 /* tempname.c - generate the name of a temporary file.
3 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2005 Free Software Foundation, Inc.
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)
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.
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. */
24 #include <sys/types.h>
29 # define __set_errno(Val) errno = (Val)
34 # define P_tmpdir "/tmp"
37 # define TMP_MAX 238328
41 # define __GT_BIGFILE 1
43 # define __GT_NOCREATE 3
50 #if HAVE_FCNTL_H || _LIBC
54 #if HAVE_SYS_TIME_H || _LIBC
55 # include <sys/time.h>
58 #if HAVE_STDINT_H || _LIBC
62 # include <inttypes.h>
65 #if HAVE_UNISTD_H || _LIBC
72 # define struct_stat64 struct stat64
74 # include "stat-macros.h"
75 # define struct_stat64 struct stat
76 # define __getpid getpid
77 # define __gettimeofday gettimeofday
78 # define __mkdir mkdir
80 # define __open64 open
81 # define __lxstat64(version, file, buf) lstat (file, buf)
82 # define __xstat64(version, file, buf) stat (file, buf)
85 #if ! (HAVE___SECURE_GETENV || _LIBC)
86 # define __secure_getenv getenv
90 # include <hp-timing.h>
92 # define RANDOM_BITS(Var) \
93 if (__builtin_expect (value == UINT64_C (0), 0)) \
95 /* If this is the first time this function is used initialize \
96 the variable we accumulate the value in to some somewhat \
97 random value. If we'd not do this programs at startup time \
98 might have a reduced set of possible names, at least on slow \
101 __gettimeofday (&tv, NULL); \
102 value = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec; \
108 /* Use the widest available unsigned type if uint64_t is not
109 available. The algorithm below extracts a number less than 62**6
110 (approximately 2**35.725) from uint64_t, so ancient hosts where
111 uintmax_t is only 32 bits lose about 3.725 bits of randomness,
112 which is better than not having mkstemp at all. */
113 #if !defined UINT64_MAX && !defined uint64_t
114 # define uint64_t uintmax_t
117 /* Return nonzero if DIR is an existent directory. */
119 direxists (const char *dir)
122 return __xstat64 (_STAT_VER, dir, &buf) == 0 && S_ISDIR (buf.st_mode);
125 /* Path search algorithm, for tmpnam, tmpfile, etc. If DIR is
126 non-null and exists, uses it; otherwise uses the first of $TMPDIR,
127 P_tmpdir, /tmp that exists. Copies into TMPL a template suitable
128 for use with mk[s]temp. Will fail (-1) if DIR is non-null and
129 doesn't exist, none of the searched dirs exists, or there's not
130 enough space in TMPL. */
132 __path_search (char *tmpl, size_t tmpl_len, const char *dir, const char *pfx,
152 d = __secure_getenv ("TMPDIR");
153 if (d != NULL && direxists (d))
155 else if (dir != NULL && direxists (dir))
162 if (direxists (P_tmpdir))
164 else if (strcmp (P_tmpdir, "/tmp") != 0 && direxists ("/tmp"))
168 __set_errno (ENOENT);
174 while (dlen > 1 && dir[dlen - 1] == '/')
175 dlen--; /* remove trailing slashes */
177 /* check we have room for "${dir}/${pfx}XXXXXX\0" */
178 if (tmpl_len < dlen + 1 + plen + 6 + 1)
180 __set_errno (EINVAL);
184 sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);
188 /* These are the characters used in temporary file names. */
189 static const char letters[] =
190 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
192 /* Generate a temporary file name based on TMPL. TMPL must match the
193 rules for mk[s]temp (i.e. end in "XXXXXX"). The name constructed
194 does not exist at the time of the call to __gen_tempname. TMPL is
195 overwritten with the result.
198 __GT_NOCREATE: simply verify that the name does not exist
199 at the time of the call.
200 __GT_FILE: create the file using open(O_CREAT|O_EXCL)
201 and return a read-write fd. The file is mode 0600.
202 __GT_BIGFILE: same as __GT_FILE but use open64().
203 __GT_DIR: create a directory, which will be mode 0700.
205 We use a clever algorithm to get hard-to-predict names. */
207 __gen_tempname (char *tmpl, int kind)
211 static uint64_t value;
212 uint64_t random_time_bits;
215 int save_errno = errno;
218 /* A lower bound on the number of temporary files to attempt to
219 generate. The maximum total number of temporary file names that
220 can exist for a given template is 62**6. It should never be
221 necessary to try all these combinations. Instead if a reasonable
222 number of names is tried (we define reasonable as 62**3) fail to
223 give the system administrator the chance to remove the problems. */
224 unsigned int attempts_min = 62 * 62 * 62;
226 /* The number of times to attempt to generate a temporary file. To
227 conform to POSIX, this must be no smaller than TMP_MAX. */
228 unsigned int attempts = attempts_min < TMP_MAX ? TMP_MAX : attempts_min;
231 if (len < 6 || strcmp (&tmpl[len - 6], "XXXXXX"))
233 __set_errno (EINVAL);
237 /* This is where the Xs start. */
238 XXXXXX = &tmpl[len - 6];
240 /* Get some more or less random data. */
242 RANDOM_BITS (random_time_bits);
244 # if HAVE_GETTIMEOFDAY || _LIBC
247 __gettimeofday (&tv, NULL);
248 random_time_bits = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;
251 random_time_bits = time (NULL);
254 value += random_time_bits ^ __getpid ();
256 for (count = 0; count < attempts; value += 7777, ++count)
260 /* Fill in the random bits. */
261 XXXXXX[0] = letters[v % 62];
263 XXXXXX[1] = letters[v % 62];
265 XXXXXX[2] = letters[v % 62];
267 XXXXXX[3] = letters[v % 62];
269 XXXXXX[4] = letters[v % 62];
271 XXXXXX[5] = letters[v % 62];
276 fd = __open (tmpl, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
280 fd = __open64 (tmpl, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
284 fd = __mkdir (tmpl, S_IRUSR | S_IWUSR | S_IXUSR);
288 /* This case is backward from the other three. __gen_tempname
289 succeeds if __xstat fails because the name does not exist.
290 Note the continue to bypass the common logic at the bottom
292 if (__lxstat64 (_STAT_VER, tmpl, &st) < 0)
296 __set_errno (save_errno);
306 assert (! "invalid KIND in __gen_tempname");
311 __set_errno (save_errno);
314 else if (errno != EEXIST)
318 /* We got out of the loop because we ran out of combinations to try. */
319 __set_errno (EEXIST);