change semantics of searchpath2 and add searchpath3

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>

6 files changed, 201 insertions, 122 deletions

diff --git a/include/unistd.h b/include/unistd.h
index d27f342..2d7ee16 100644
--- a/include/unistd.h
+++ b/include/unistd.h
@@ -830,7 +830,8 @@ int fexecve(int, char* const[], char* const[]);
  * 
  * @since  Always.
  */
-char* searchpath(const char*);
+char* searchpath(const char*)
+  __GCC_ONLY(__attribute__((__nonnull__(0))));
 #endif
 
 #if defined(__SLIBC_SOURCE)
@@ -853,9 +854,8 @@ char* searchpath(const char*);
  * 
  * @param   name      The name of the sought executable. Must not be `NULL`.
  * @param   fallback  Value to use instead of the value of $PATH, if
- *                    path is not defined. If `NULL` the fall rules for
- *                    the `exec`-functions are used: The current working
- *                    directory, and the default value for $PATH.
+ *                    path is not defined. If `NULL` the default value
+ *                    for $PATH is used.
  * @return            The pathname of the sought file, `NULL` on error,
  *                    or if not found. Files that are not executable
  *                    are (almost) ignored.
@@ -871,7 +871,50 @@ char* searchpath(const char*);
  * 
  * @since  Always.
  */
-char* searchpath2(const char*, const char*);
+char* searchpath2(const char*, const char*)
+  __GCC_ONLY(__attribute__((__nonnull__(0))));
+
+/**
+ * Search the environment variable $PATH for an executable
+ * file whose name is the specified name. Slashes are ignored
+ * and treated as any other character. $PATH is searched
+ * for left to right, and ':' is used as the path-delimiter.
+ * If $PATH is not defined, a fallback value for $PATH will be
+ * used.
+ * 
+ * $PATH is not inspected if `name` starts with './', '../', or '/'.
+ * 
+ * This function was added because it was useful in implementing
+ * the `exec`-function family.
+ * 
+ * This is a slibc extension.
+ * 
+ * @etymology  Variant of (searchpath) that takes (2) arguments.
+ * 
+ * @param   name      The name of the sought executable. Must not be `NULL`.
+ * @param   fallback  Value to use instead of the value of $PATH, if
+ *                    path is not defined. If `NULL` the default value
+ *                    for $PATH is used.
+ * @param   first     If $PATH is not defined, and `fallback` is `NULL`,
+ *                    these directories are tested before the default
+ *                    directories. May be `NULL`.
+ * @return            The pathname of the sought file, `NULL` on error,
+ *                    or if not found. Files that are not executable
+ *                    are (almost) ignored.
+ * 
+ * @throws  ENOMEM  The process cannot allocate enough memory.
+ * @throws  ENOENT  There are no directories listed in $PATH, or
+ *                  the sought file is not exist inside $PATH.
+ * @throws  EACCES  None of the candidates (with at least one candidate)
+ *                  are executable by the current user.
+ * @throws          Any exception defined for access(3), except for `EROFS`,
+ *                  these when encountered, the search is aborted, unless
+ *                  the error is `ENOENT` or `EACCES`.
+ * 
+ * @since  Always.
+ */
+char* searchpath3(const char*, const char*, const char*)
+  __GCC_ONLY(__attribute__((__nonnull__(0))));
 #endif
 
 
diff --git a/src/unistd/exec.c b/src/unistd/exec.c
index 9375baa..3558b1f 100644
--- a/src/unistd/exec.c
+++ b/src/unistd/exec.c
@@ -329,7 +329,7 @@ int execvpe(const char* file, char* const argv[], char* const envp[])
   if (!*file)
     return errno = ENOENT, -1;
   
-  pathname = searchpath2(file, NULL);
+  pathname = searchpath3(file, NULL, ".");
   if (pathname == NULL)
     return -1;
   
diff --git a/src/unistd/execat.c b/src/unistd/execat.c
index 68d9cfd..700db2f 100644
--- a/src/unistd/execat.c
+++ b/src/unistd/execat.c
@@ -474,65 +474,30 @@ int execveat(int dirfd, const char* path, char* const argv[], char* const envp[]
  */
 int execvpeat(int dirfd, const char* file, char* const argv[], char* const envp[], int flags)
 {
-  char* path = NULL;
   char* pathname = NULL;
-  char* p;
-  char* q;
-  size_t len = 0;
   int eacces = 0;
   int saved_errno;
   
   if (strchr(file, '/') || !*file)
     return execveat(dirfd, file, argv, envp, flags);
   
-  path = getenv("PATH");
-  if (path == NULL)
+  if (getenv("PATH") == NULL)
     {
       execveat(dirfd, file, argv, envp, flags);
       if      (errno == EACCES)  eacces = 1;
-      else if (errno != ENOENT)  goto fail;
-      
-      if ((len = confstr(_CS_PATH, NULL, 0)))
-	{
-	  path = malloc(len * sizeof(char));
-	  if (path == NULL)
-	    goto fail;
-	  if (!confstr(_CS_PATH, path, len))
-	    free(path), path = NULL;
-	}
-      if (path == NULL)
-	path = strdup("/usr/local/bin:/bin:/usr/bin");
+      else if (errno != ENOENT)  return -1;
     }
-  else
-    path = strdup(path);
-  if (path == NULL)
-    goto fail;
   
-  pathname = malloc((strlen(path) + strlen(file) + 2) * sizeof(char));
+  pathname = searchpath3(file, NULL, "");
   if (pathname == NULL)
-    goto fail;
-  
-  for (p = path; *p; p = q + 1)
-    {
-      if (p == (q = strchr(p, ':')))
-	continue;
-      *q = '\0';
-      
-      stpcpy(stpcpy(stpcpy(pathname, p), "/"), file);
-      
-      execve(pathname, argv, envp);
-      if      (errno == EACCES)  eacces = 1;
-      else if (errno != ENOENT)  goto fail;
-    }
+    return -1;
   
-  free(path);
-  free(pathname);
-  return errno = (eacces ? EACCES : ENOENT), -1;
+  execve(pathname, argv, envp);
   
- fail:
   saved_errno = errno;
-  free(path);
   free(pathname);
+  if (eacces && (saved_errno == ENOENT))
+    saved_errno = EACCES;
   errno = saved_errno;
   return -1;
 }
diff --git a/src/unistd/searchpath.c b/src/unistd/searchpath.c
index 84bc58e..bfcffba 100644
--- a/src/unistd/searchpath.c
+++ b/src/unistd/searchpath.c
@@ -50,6 +50,6 @@
  */
 char* searchpath(const char* name)
 {
-  return searchpath2(name, "");
+  return searchpath3(name, "", NULL);
 }
 
diff --git a/src/unistd/searchpath2.c b/src/unistd/searchpath2.c
index 9921550..b2dd800 100644
--- a/src/unistd/searchpath2.c
+++ b/src/unistd/searchpath2.c
@@ -16,11 +16,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 #include <unistd.h>
-#include <stdlib.h>
-#include <string.h>
-/* TODO temporary contants from other headers { */
-#define _CS_PATH 1
-/* } */
 
 
 
@@ -43,9 +38,8 @@
  * 
  * @param   name      The name of the sought executable. Must not be `NULL`.
  * @param   fallback  Value to use instead of the value of $PATH, if
- *                    path is not defined. If `NULL` the fall rules for
- *                    the `exec`-functions are used: The current working
- *                    directory, and the default value for $PATH.
+ *                    path is not defined. If `NULL` the default value
+ *                    for $PATH is used.
  * @return            The pathname of the sought file, `NULL` on error,
  *                    or if not found. Files that are not executable
  *                    are (almost) ignored.
@@ -63,70 +57,6 @@
  */
 char* searchpath2(const char* name, const char* fallback)
 {
-  char* path;
-  size_t len = 0;
-  char* pathname = NULL;
-  char* p;
-  char* q;
-  int eacces = 0;
-  int saved_errno;
-  
-  if (strstarts(name, "./") || strstarts(name, "../") || strstarts(name, "/"))
-    {
-      if (access(name, X_OK) == 0)
-	return strdup(name);
-      return NULL;
-    }
-  
-  path = getenv("PATH");
-  if ((path == NULL) && (fallback == NULL))
-    {
-      if ((len = confstr(_CS_PATH, NULL, 0)))
-	{
-	  path = malloc((2 + len) * sizeof(char));
-	  if (path == NULL)
-	    goto fail;
-	  if (!confstr(_CS_PATH, stpcpy(path, ".:"), len))
-	    free(path), path = NULL;
-	}
-      if (path == NULL)
-	path = strdup(".:/usr/local/bin:/bin:/usr/bin");
-    }
-  else
-    path = strdup(path == NULL ? fallback : path);
-  if (path == NULL)
-    goto fail;
-  
-  pathname = malloc((strlen(path) + strlen(name) + 2) * sizeof(char));
-  if (pathname == NULL)
-    goto fail;
-  
-  for (p = path; *p; p = q + 1)
-    {
-      if (p == (q = strchr(p, ':')))
-	continue;
-      *q = '\0';
-      
-      stpcpy(stpcpy(stpcpy(pathname, p), "/"), name);
-      
-      if (access(pathname, X_OK) == 0)
-	{
-	  char* truncated = realloc(pathname, (strlen(pathname) + 1) * sizeof(char));
-	  return truncated == NULL ? pathname : truncated;
-	}
-      else if (errno == EACCES)  eacces = 1;
-      else if (errno != ENOENT)  goto fail;
-    }
-  
-  free(path);
-  free(pathname);
-  return errno = (eacces ? EACCES : ENOENT), -1;
-  
- fail:
-  saved_errno = errno;
-  free(path);
-  free(pathname);
-  errno = saved_errno;
-  return -1;
+  return searchpath3(name, fallback, NULL);
 }
 
diff --git a/src/unistd/searchpath3.c b/src/unistd/searchpath3.c
new file mode 100644
index 0000000..5fabc62
--- /dev/null
+++ b/src/unistd/searchpath3.c
@@ -0,0 +1,141 @@
+/**
+ * slibc — Yet another C library
+ * Copyright © 2015  Mattias Andrée (maandree@member.fsf.org)
+ * 
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+#include <unistd.h>
+#include <stdlib.h>
+#include <string.h>
+/* TODO temporary contants from other headers { */
+#define _CS_PATH 1
+/* } */
+
+
+
+/**
+ * Search the environment variable $PATH for an executable
+ * file whose name is the specified name. Slashes are ignored
+ * and treated as any other character. $PATH is searched
+ * for left to right, and ':' is used as the path-delimiter.
+ * If $PATH is not defined, a fallback value for $PATH will be
+ * used.
+ * 
+ * $PATH is not inspected if `name` starts with './', '../', or '/'.
+ * 
+ * This function was added because it was useful in implementing
+ * the `exec`-function family.
+ * 
+ * This is a slibc extension.
+ * 
+ * @etymology  Variant of (searchpath) that takes (2) arguments.
+ * 
+ * @param   name      The name of the sought executable. Must not be `NULL`.
+ * @param   fallback  Value to use instead of the value of $PATH, if
+ *                    path is not defined. If `NULL` the default value
+ *                    for $PATH is used.
+ * @param   first     If $PATH is not defined, and `fallback` is `NULL`,
+ *                    these directories are tested before the default
+ *                    directories. May be `NULL`.
+ * @return            The pathname of the sought file, `NULL` on error,
+ *                    or if not found. Files that are not executable
+ *                    are (almost) ignored.
+ * 
+ * @throws  ENOMEM  The process cannot allocate enough memory.
+ * @throws  ENOENT  There are no directories listed in $PATH, or
+ *                  the sought file is not exist inside $PATH.
+ * @throws  EACCES  None of the candidates (with at least one candidate)
+ *                  are executable by the current user.
+ * @throws          Any exception defined for access(3), except for `EROFS`,
+ *                  these when encountered, the search is aborted, unless
+ *                  the error is `ENOENT` or `EACCES`.
+ * 
+ * @since  Always.
+ */
+char* searchpath3(const char* name, const char* fallback, const char* first)
+{
+  char* path;
+  size_t len = 0;
+  char* pathname = NULL;
+  char* p;
+  char* q;
+  int eacces = 0;
+  int saved_errno;
+  
+  if (strstarts(name, "./") || strstarts(name, "../") || strstarts(name, "/"))
+    {
+      if (access(name, X_OK) == 0)
+	return strdup(name);
+      return NULL;
+    }
+  
+  path = getenv("PATH");
+  if ((path == NULL) && (fallback == NULL))
+    {
+      if (first == NULL)
+	first = "";
+      if ((len = confstr(_CS_PATH, NULL, 0)))
+	{
+	  path = malloc((strlen(first) + 1 + len) * sizeof(char));
+	  if (path == NULL)
+	    goto fail;
+	  if (!confstr(_CS_PATH, stpcpy(stpcpy(path, first), ":"), len))
+	    free(path), path = NULL;
+	}
+      if (path == NULL)
+	{
+	  path = malloc(strlen(first) * sizeof(char) + sizeof(":/usr/local/bin:/bin:/usr/bin"));
+	  if (path == NULL)
+	    goto fail;
+	  stpcpy(stpcpy(path, first), ":/usr/local/bin:/bin:/usr/bin");
+	}
+    }
+  else
+    path = strdup(path == NULL ? fallback : path);
+  if (path == NULL)
+    goto fail;
+  
+  pathname = malloc((strlen(path) + strlen(name) + 2) * sizeof(char));
+  if (pathname == NULL)
+    goto fail;
+  
+  for (p = path; *p; p = q + 1)
+    {
+      if (p == (q = strchr(p, ':')))
+	continue;
+      *q = '\0';
+      
+      stpcpy(stpcpy(stpcpy(pathname, p), "/"), name);
+      
+      if (access(pathname, X_OK) == 0)
+	{
+	  char* truncated = realloc(pathname, (strlen(pathname) + 1) * sizeof(char));
+	  return truncated == NULL ? pathname : truncated;
+	}
+      else if (errno == EACCES)  eacces = 1;
+      else if (errno != ENOENT)  goto fail;
+    }
+  
+  free(path);
+  free(pathname);
+  return errno = (eacces ? EACCES : ENOENT), -1;
+  
+ fail:
+  saved_errno = errno;
+  free(path);
+  free(pathname);
+  errno = saved_errno;
+  return -1;
+}
+