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