tempname.c

Absolute File Name:

/home/opencoverage/opencoverage/guest-scripts/coreutils/src/lib/tempname.c

Line

Source

Count

/* tempname.c - generate the name of a temporary file.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program. If not, see <https://www.gnu.org/licenses/>. */

/* Extracted from glibc sysdeps/posix/tempname.c. See also tmpdir.c. */

#if !_LIBC

# include <config.h>

# include "tempname.h"

# include "randint.h"

#endif

#include <sys/types.h>

#include <assert.h>

#include <errno.h>

#ifndef __set_errno

# define __set_errno(Val) errno = (Val)

#endif

#include <stdio.h>

#ifndef P_tmpdir

# define P_tmpdir "/tmp"

#endif

#ifndef TMP_MAX

# define TMP_MAX 238328

#endif

#ifndef __GT_FILE

# define __GT_FILE 0

# define __GT_DIR 1

# define __GT_NOCREATE 2

#endif

#if !_LIBC && (GT_FILE != __GT_FILE || GT_DIR != __GT_DIR \

|| GT_NOCREATE != __GT_NOCREATE)

# error report this to bug-gnulib@gnu.org

#endif

#include <stdbool.h>

#include <stddef.h>

#include <stdlib.h>

#include <string.h>

#include <fcntl.h>

#include <sys/time.h>

#include <stdint.h>

#include <unistd.h>

#include <sys/stat.h>

#if _LIBC

# define struct_stat64 struct stat64

#else

# define struct_stat64 struct stat

# define __try_tempname try_tempname

# define __gen_tempname gen_tempname

# define __getpid getpid

# define __gettimeofday gettimeofday

# define __mkdir mkdir

# define __open open

# define __lxstat64(version, file, buf) lstat (file, buf)

#endif

#ifdef _LIBC

# include <hp-timing.h>

# if HP_TIMING_AVAIL

# define RANDOM_BITS(Var) \

if (__builtin_expect (value == UINT64_C (0), 0)) \

{ \

/* If this is the first time this function is used initialize \

the variable we accumulate the value in to some somewhat \

random value. If we'd not do this programs at startup time \

might have a reduced set of possible names, at least on slow \

machines. */ \

struct timeval tv; \

__gettimeofday (&tv, NULL); \

value = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec; \

} \

HP_TIMING_NOW (Var)

# endif

#endif

/* Use the widest available unsigned type if uint64_t is not

available. The algorithm below extracts a number less than 62**6

(approximately 2**35.725) from uint64_t, so ancient hosts where

uintmax_t is only 32 bits lose about 3.725 bits of randomness,

which is better than not having mkstemp at all. */

100

#if !defined UINT64_MAX && !defined uint64_t

101

# define uint64_t uintmax_t

#endif

#if _LIBC

/* 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,

int try_tmpdir)

{

const char *d;

size_t dlen, plen;

if (!pfx || !pfx[0])

{

pfx = "file";

plen = 4;

}

else

{

plen = strlen (pfx);

if (plen > 5)

plen = 5;

}

if (try_tmpdir)

{

d = __secure_getenv ("TMPDIR");

141

if (d != NULL && direxists (d))

142

dir = d;

143

else if (dir != NULL && direxists (dir))

/* nothing */ ;

else

dir = NULL;

}

if (dir == NULL)

{

if (direxists (P_tmpdir))

151

dir = P_tmpdir;

152

else if (strcmp (P_tmpdir, "/tmp") != 0 && direxists ("/tmp"))

dir = "/tmp";

else

{

__set_errno (ENOENT);

return -1;

}

}

dlen = strlen (dir);

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);

return -1;

}

sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);

return 0;

}

#endif /* _LIBC */

static inline bool _GL_ATTRIBUTE_PURE

178

check_x_suffix (char const *s, size_t len)

179

{

180

return len <= strspn (s, "X");

executed 596 times by 4 tests: return len <= __builtin_strspn ( s , "X" ) ;

Executed by:

cp
ln
mktemp
mv

596

181

}

182

183

/* These are the characters used in temporary file names. */

184

static const char letters[] =

185

"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

186

187

int

188

try_tempname_len (char *tmpl, int suffixlen, void *args,

189

int (*tryfunc) (char *, void *), size_t x_suffix_len)

{

size_t len;

char *XXXXXX;

unsigned int count;

int fd = -1;

int save_errno = errno;

196

struct randint_source *rand_src;

197

198

/* A lower bound on the number of temporary files to attempt to

199

generate. The maximum total number of temporary file names that

200

can exist for a given template is 62**6. It should never be

201

necessary to try all of these combinations. Instead if a reasonable

202

number of names is tried (we define reasonable as 62**3) fail to

203

give the system administrator the chance to remove the problems.

204

This value requires that X_SUFFIX_LEN be at least 3. */

205

#define ATTEMPTS_MIN (62 * 62 * 62)

206

207

/* The number of times to attempt to generate a temporary file. To

208

conform to POSIX, this must be no smaller than TMP_MAX. */

209

#if ATTEMPTS_MIN < TMP_MAX

210

unsigned int attempts = TMP_MAX;

211

#else

212

unsigned int attempts = ATTEMPTS_MIN;

#endif

len = strlen (tmpl);

if (len < x_suffix_len + suffixlen

len < x_suffix_len + suffixlen	Description
TRUE	never evaluated
FALSE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv

0-596

217

|| ! check_x_suffix (&tmpl[len - x_suffix_len - suffixlen],

! check_x_suff... x_suffix_len)	Description
TRUE	never evaluated
FALSE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv

0-596

218

x_suffix_len))

! check_x_suff... x_suffix_len)	Description
TRUE	never evaluated
FALSE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv

0-596

219

{

220

__set_errno (EINVAL);

221

return -1;

never executed: return -1;

222

}

223

224

/* This is where the Xs start. */

225

XXXXXX = &tmpl[len - x_suffix_len - suffixlen];

226

227

/* Get some more or less random data. */

228

rand_src = randint_all_new (NULL, x_suffix_len);

229

if (! rand_src)

! rand_src	Description
TRUE	never evaluated
FALSE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv

0-596

230

return -1;

never executed: return -1;

231

232

for (count = 0; count < attempts; ++count)

count < attempts	Description
TRUE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv
FALSE	never evaluated

0-596

{

size_t i;

for (i = 0; i < x_suffix_len; i++)

i < x_suffix_len	Description
TRUE	evaluated 2470 times by 4 tests Evaluated by: cp ln mktemp mv
FALSE	evaluated 596 times by 4 tests Evaluated by: cp ln mktemp mv

596-2470

237

XXXXXX[i] = letters[randint_genmax (rand_src, sizeof letters - 2)];

executed 2470 times by 4 tests: XXXXXX[i] = letters[randint_genmax (rand_src, sizeof letters - 2)];

Executed by:

cp
ln
mktemp
mv

2470

238

239

fd = tryfunc (tmpl, args);

240

if (fd >= 0)

fd >= 0	Description
TRUE	evaluated 594 times by 4 tests Evaluated by: cp ln mktemp mv
FALSE	evaluated 2 times by 2 tests Evaluated by: cp mktemp

2-594

241

{

242

__set_errno (save_errno);

243

goto done;

executed 594 times by 4 tests: goto done;

Executed by:

cp
ln
mktemp
mv

594

244

}

245

else if (errno != EEXIST)

(*__errno_location ()) != 17	Description
TRUE	evaluated 2 times by 2 tests Evaluated by: cp mktemp
FALSE	never evaluated

0-2

246

{

247

fd = -1;

248

goto done;

executed 2 times by 2 tests: goto done;

Executed by:

cp
mktemp

249

}

250

}

never executed: end of block

251

252

randint_all_free (rand_src);

253

254

/* We got out of the loop because we ran out of combinations to try. */

255

__set_errno (EEXIST);

256

return -1;

never executed: return -1;

done:

{

int saved_errno = errno;

261

randint_all_free (rand_src);

262

__set_errno (saved_errno);

263

}

264

return fd;

executed 596 times by 4 tests: return fd;

Executed by:

cp
ln
mktemp
mv

596

}

static int

try_file (char *tmpl, void *flags)

269

{

270

int *openflags = flags;

271

return __open (tmpl,

executed 13 times by 1 test: return open (tmpl, (*openflags & ~ 0003 ) | 02 | 0100 | 0200 , 0400 | 0200 );

Executed by:

mktemp

272

(*openflags & ~O_ACCMODE)

executed 13 times by 1 test: return open (tmpl, (*openflags & ~ 0003 ) | 02 | 0100 | 0200 , 0400 | 0200 );

Executed by:

mktemp

273

| O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);

executed 13 times by 1 test: return open (tmpl, (*openflags & ~ 0003 ) | 02 | 0100 | 0200 , 0400 | 0200 );

Executed by:

mktemp

}

static int

try_dir (char *tmpl, void *flags _GL_UNUSED)

278

{

279

return __mkdir (tmpl, S_IRUSR | S_IWUSR | S_IXUSR);

executed 549 times by 1 test: return mkdir (tmpl, 0400 | 0200 | 0100 );

Executed by:

mktemp

549

}

static int

try_nocreate (char *tmpl, void *flags _GL_UNUSED)

{

struct_stat64 st;

if (__lxstat64 (_STAT_VER, tmpl, &st) == 0 || errno == EOVERFLOW)

lstat (tmpl, &st) == 0	Description
TRUE	never evaluated
FALSE	evaluated 4 times by 1 test Evaluated by: mktemp

(*__errno_location ()) == 75	Description
TRUE	never evaluated
FALSE	evaluated 4 times by 1 test Evaluated by: mktemp

0-4

288

__set_errno (EEXIST);

never executed: (*__errno_location ()) = ( 17 );

289

return errno == ENOENT ? 0 : -1;

executed 4 times by 1 test: return (*__errno_location ()) == 2 ? 0 : -1;

Executed by:

mktemp

290

}

291

292

/* Generate a temporary file name based on TMPL. TMPL must match the

293

rules for mk[s]temp (i.e., end in at least X_SUFFIX_LEN "X"s,

294

possibly with a suffix).

295

The name constructed does not exist at the time of the call to

296

this function. TMPL is overwritten with the result.

297

298

KIND may be one of:

299

__GT_NOCREATE: simply verify that the name does not exist

300

at the time of the call.

301

__GT_FILE: create the file using open(O_CREAT|O_EXCL)

302

and return a read-write fd. The file is mode 0600.

303

__GT_DIR: create a directory, which will be mode 0700.

304

305

We use a clever algorithm to get hard-to-predict names. */

306

int

307

gen_tempname_len (char *tmpl, int suffixlen, int flags, int kind,

308

size_t x_suffix_len)

309

{

310

int (*tryfunc) (char *, void *);

switch (kind)

{

case __GT_FILE:

executed 13 times by 1 test: case 0:

Executed by:

mktemp

315

tryfunc = try_file;

316

break;

executed 13 times by 1 test: break;

Executed by:

mktemp

317

318

case __GT_DIR:

executed 549 times by 1 test: case 1:

Executed by:

mktemp

549

319

tryfunc = try_dir;

320

break;

executed 549 times by 1 test: break;

Executed by:

mktemp

549

321

322

case __GT_NOCREATE:

executed 4 times by 1 test: case 2:

Executed by:

mktemp

323

tryfunc = try_nocreate;

324

break;

executed 4 times by 1 test: break;

Executed by:

mktemp

325

326

default:

never executed: default:

327

assert (! "invalid KIND in __gen_tempname");

328

abort ();

never executed: abort ();

329

}

330

return try_tempname_len (tmpl, suffixlen, &flags, tryfunc, x_suffix_len);

executed 566 times by 1 test: return try_tempname_len (tmpl, suffixlen, &flags, tryfunc, x_suffix_len);

Executed by:

mktemp

566

}

int

__gen_tempname (char *tmpl, int suffixlen, int flags, int kind)

335

{

336

return gen_tempname_len (tmpl, suffixlen, flags, kind, 6);

never executed: return gen_tempname_len (tmpl, suffixlen, flags, kind, 6);

}

int

__try_tempname (char *tmpl, int suffixlen, void *args,

341

int (*tryfunc) (char *, void *))

342

{

343

return try_tempname_len (tmpl, suffixlen, args, tryfunc, 6);

never executed: return try_tempname_len (tmpl, suffixlen, args, tryfunc, 6);

344

}

Generated by Squish Coco 4.1.2