[v2,2/2] Split __path_search into a separate file

Message ID 20220825214634.3561419-3-eggert@cs.ucla.edu
State New
Headers
Series tempname ALSR etc. fixes from Gnulib |

Checks

Context Check Description
dj/TryBot-apply_patch success Patch applied to master at the time it was sent
dj/TryBot-32bit success Build for i686
redhat-pt-bot/TryBot-still_applies warning Patch no longer applies to master

Commit Message

Paul Eggert Aug. 25, 2022, 9:46 p.m. UTC
  This simplifies sharing tempname with Gnulib.
Suggested by Bruno Haible in:
https://lists.gnu.org/r/bug-gnulib/2022-08/msg00077.html
* stdio-common/Makefile (routines): Add path-search.
(CFLAGS-path-search.c): New macro, which has -fexceptions
because tempname.c has it.
* stdio-common/path-search.c, sysdeps/posix/path-search.c:
New files.
* stdio-common/tempname.c (__need_size_t): Do not define.
No need to include stddef.h, since stdio.h declares size_t.
(__path_search): Move to path-search.c.
* sysdeps/posix/tempname.c:
Don't include sys/types.h, assert.h, stddef.h; not needed.
(P_tmpdir): Remove.
(__secure_getenv) [_LIBC]: Remove.
(__stat64) [!_LIBC]: Remove.
(direxists, __path_search) [_LIBC]: Move to path-search.c.
---
 stdio-common/Makefile       |  2 +
 stdio-common/path-search.c  | 31 +++++++++++++
 stdio-common/tempname.c     | 14 ------
 sysdeps/posix/path-search.c | 92 +++++++++++++++++++++++++++++++++++++
 sysdeps/posix/tempname.c    | 82 ---------------------------------
 5 files changed, 125 insertions(+), 96 deletions(-)
 create mode 100644 stdio-common/path-search.c
 create mode 100644 sysdeps/posix/path-search.c
  

Comments

Florian Weimer Aug. 26, 2022, 9:47 a.m. UTC | #1
* Paul Eggert:

> This simplifies sharing tempname with Gnulib.
> Suggested by Bruno Haible in:
> https://lists.gnu.org/r/bug-gnulib/2022-08/msg00077.html
> * stdio-common/Makefile (routines): Add path-search.
> (CFLAGS-path-search.c): New macro, which has -fexceptions
> because tempname.c has it.
> * stdio-common/path-search.c, sysdeps/posix/path-search.c:
> New files.
> * stdio-common/tempname.c (__need_size_t): Do not define.
> No need to include stddef.h, since stdio.h declares size_t.
> (__path_search): Move to path-search.c.
> * sysdeps/posix/tempname.c:
> Don't include sys/types.h, assert.h, stddef.h; not needed.
> (P_tmpdir): Remove.
> (__secure_getenv) [_LIBC]: Remove.
> (__stat64) [!_LIBC]: Remove.
> (direxists, __path_search) [_LIBC]: Move to path-search.c.

sysdeps/posix/path-search.c is not intended to be shared with gnulib,
right?  Change looks okay to me.

Thanks,
Florian
  

Patch

diff --git a/stdio-common/Makefile b/stdio-common/Makefile
index b1e9144de0..1543b5414b 100644
--- a/stdio-common/Makefile
+++ b/stdio-common/Makefile
@@ -49,6 +49,7 @@  routines := \
   itoa-digits \
   itoa-udigits \
   itowa-digits \
+  path-search \
   perror \
   printf \
   printf-prs \
@@ -351,6 +352,7 @@  $(objpfx)tst-errno-manual.out: tst-errno-manual.py \
 CFLAGS-vfprintf.c += -Wno-uninitialized
 CFLAGS-vfwprintf.c += -Wno-uninitialized
 
+CFLAGS-path-search.c += -fexceptions
 CFLAGS-tmpfile.c += -fexceptions
 CFLAGS-tmpfile64.c += -fexceptions
 CFLAGS-tempname.c += -fexceptions
diff --git a/stdio-common/path-search.c b/stdio-common/path-search.c
new file mode 100644
index 0000000000..6ad7002d7c
--- /dev/null
+++ b/stdio-common/path-search.c
@@ -0,0 +1,31 @@ 
+/* Copyright (C) 1991-2022 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   The GNU C Library 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
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <https://www.gnu.org/licenses/>.  */
+
+#include <stdio.h>
+#include <errno.h>
+
+/* Perform the "SVID path search malarkey" on DIR and PFX.  Write a
+   template suitable for use in __gen_tempname into TMPL, bounded
+   by TMPL_LEN. */
+int
+__path_search (char *tmpl, size_t tmpl_len, const char *dir, const char *pfx,
+	       int try_tmpdir)
+{
+  __set_errno (ENOSYS);
+  return -1;
+}
+stub_warning (__path_search)
diff --git a/stdio-common/tempname.c b/stdio-common/tempname.c
index 621876a9d9..6538fb1777 100644
--- a/stdio-common/tempname.c
+++ b/stdio-common/tempname.c
@@ -15,23 +15,9 @@ 
    License along with the GNU C Library; if not, see
    <https://www.gnu.org/licenses/>.  */
 
-#define __need_size_t
-#include <stddef.h>
 #include <stdio.h>
 #include <errno.h>
 
-/* Perform the "SVID path search malarkey" on DIR and PFX.  Write a
-   template suitable for use in __gen_tempname into TMPL, bounded
-   by TMPL_LEN. */
-int
-__path_search (char *tmpl, size_t tmpl_len, const char *dir, const char *pfx,
-	       int try_tmpdir)
-{
-  __set_errno (ENOSYS);
-  return -1;
-}
-stub_warning (__path_search)
-
 /* Generate a (hopefully) unique temporary filename
    in DIR (if applicable), using template TMPL.
    KIND determines what to do with that name.  It may be one of:
diff --git a/sysdeps/posix/path-search.c b/sysdeps/posix/path-search.c
new file mode 100644
index 0000000000..ae2f404f58
--- /dev/null
+++ b/sysdeps/posix/path-search.c
@@ -0,0 +1,92 @@ 
+/* Copyright (C) 1991-2022 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   The GNU C Library 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
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <https://www.gnu.org/licenses/>.  */
+
+#include <errno.h>
+#include <stdio.h>
+#include <string.h>
+#include <sys/stat.h>
+
+/* Return nonzero if DIR is an existent directory.  */
+static int
+direxists (const char *dir)
+{
+  struct __stat64_t64 buf;
+  return __stat64_time64 (dir, &buf) == 0 && S_ISDIR (buf.st_mode);
+}
+
+/* Path search algorithm, for tmpnam, tmpfile, etc.  If DIR is
+   non-null and exists, uses it; otherwise uses the first of $TMPDIR,
+   P_tmpdir, /tmp that exists.  Copies into TMPL a template suitable
+   for use with mk[s]temp.  Will fail (-1) if DIR is non-null and
+   doesn't exist, none of the searched dirs exists, or there's not
+   enough space in TMPL. */
+int
+__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 = __libc_secure_getenv ("TMPDIR");
+      if (d != NULL && direxists (d))
+        dir = d;
+      else if (dir != NULL && direxists (dir))
+        /* nothing */ ;
+      else
+        dir = NULL;
+    }
+  if (dir == NULL)
+    {
+      if (direxists (P_tmpdir))
+        dir = P_tmpdir;
+      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] == '/')
+    dlen--;                     /* remove trailing slashes */
+
+  /* check we have room for "${dir}/${pfx}XXXXXX\0" */
+  if (tmpl_len < dlen + 1 + plen + 6 + 1)
+    {
+      __set_errno (EINVAL);
+      return -1;
+    }
+
+  sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);
+  return 0;
+}
diff --git a/sysdeps/posix/tempname.c b/sysdeps/posix/tempname.c
index 0e2f29f5de..11b4796b34 100644
--- a/sysdeps/posix/tempname.c
+++ b/sysdeps/posix/tempname.c
@@ -20,16 +20,10 @@ 
 # include "tempname.h"
 #endif
 
-#include <sys/types.h>
-#include <assert.h>
 #include <stdbool.h>
-
 #include <errno.h>
 
 #include <stdio.h>
-#ifndef P_tmpdir
-# define P_tmpdir "/tmp"
-#endif
 #ifndef TMP_MAX
 # define TMP_MAX 238328
 #endif
@@ -43,7 +37,6 @@ 
 # error report this to bug-gnulib@gnu.org
 #endif
 
-#include <stddef.h>
 #include <stdlib.h>
 #include <string.h>
 
@@ -55,14 +48,12 @@ 
 
 #if _LIBC
 # define struct_stat64 struct __stat64_t64
-# define __secure_getenv __libc_secure_getenv
 #else
 # define struct_stat64 struct stat
 # define __gen_tempname gen_tempname
 # define __mkdir mkdir
 # define __open open
 # define __lstat64_time64(file, buf) lstat (file, buf)
-# define __stat64(file, buf) stat (file, buf)
 # define __getrandom getrandom
 # define __clock_gettime64 clock_gettime
 # define __timespec64 timespec
@@ -127,79 +118,6 @@  random_bits (random_value *r, random_value s)
   return false;
 }
 
-#if _LIBC
-/* Return nonzero if DIR is an existent directory.  */
-static int
-direxists (const char *dir)
-{
-  struct_stat64 buf;
-  return __stat64_time64 (dir, &buf) == 0 && S_ISDIR (buf.st_mode);
-}
-
-/* Path search algorithm, for tmpnam, tmpfile, etc.  If DIR is
-   non-null and exists, uses it; otherwise uses the first of $TMPDIR,
-   P_tmpdir, /tmp that exists.  Copies into TMPL a template suitable
-   for use with mk[s]temp.  Will fail (-1) if DIR is non-null and
-   doesn't exist, none of the searched dirs exists, or there's not
-   enough space in TMPL. */
-int
-__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");
-      if (d != NULL && direxists (d))
-        dir = d;
-      else if (dir != NULL && direxists (dir))
-        /* nothing */ ;
-      else
-        dir = NULL;
-    }
-  if (dir == NULL)
-    {
-      if (direxists (P_tmpdir))
-        dir = P_tmpdir;
-      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] == '/')
-    dlen--;                     /* remove trailing slashes */
-
-  /* check we have room for "${dir}/${pfx}XXXXXX\0" */
-  if (tmpl_len < dlen + 1 + plen + 6 + 1)
-    {
-      __set_errno (EINVAL);
-      return -1;
-    }
-
-  sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);
-  return 0;
-}
-#endif /* _LIBC */
-
 #if _LIBC
 static int try_tempname_len (char *, int, void *, int (*) (char *, void *),
                              size_t);