lib/libc/gen/popen.c

   1 /*
   2  * Copyright (c) 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software written by Ken Arnold and
   6  * published in UNIX Review, Vol. 6, No. 8.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #if defined(LIBC_SCCS) && !defined(lint)
  34 static char sccsid[] = "@(#)popen.c     8.3 (Berkeley) 5/3/95";
  35 #endif /* LIBC_SCCS and not lint */
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include "namespace.h"
  40 #include <sys/param.h>
  41 #include <sys/queue.h>
  42 #include <sys/wait.h>
  43
  44 #include <signal.h>
  45 #include <errno.h>
  46 #include <fcntl.h>
  47 #include <unistd.h>
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <string.h>
  51 #include <paths.h>
  52 #include <pthread.h>
  53 #include "un-namespace.h"
  54 #include "libc_private.h"
  55
  56 extern char **environ;
  57
  58 struct pid {
  59         SLIST_ENTRY(pid) next;
  60         FILE *fp;
  61         pid_t pid;
  62 };
  63 static SLIST_HEAD(, pid) pidlist = SLIST_HEAD_INITIALIZER(pidlist);
  64 static pthread_mutex_t pidlist_mutex = PTHREAD_MUTEX_INITIALIZER;
  65
  66 #define THREAD_LOCK()   if (__isthreaded) _pthread_mutex_lock(&pidlist_mutex)
  67 #define THREAD_UNLOCK() if (__isthreaded) _pthread_mutex_unlock(&pidlist_mutex)
  68
  69 FILE *
  70 popen(command, type)
  71         const char *command, *type;
  72 {
  73         struct pid *cur;
  74         FILE *iop;
  75         int pdes[2], pid, twoway, cloexec;
  76         int pdes_unused_in_parent;
  77         char *argv[4];
  78         struct pid *p;
  79
  80         cloexec = strchr(type, 'e') != NULL;
  81         /*
  82          * Lite2 introduced two-way popen() pipes using _socketpair().
  83          * FreeBSD's pipe() is bidirectional, so we use that.
  84          */
  85         if (strchr(type, '+')) {
  86                 twoway = 1;
  87                 type = "r+";
  88         } else  {
  89                 twoway = 0;
  90                 if ((*type != 'r' && *type != 'w') ||
  91                     (type[1] && (type[1] != 'e' || type[2])))
  92                         return (NULL);
  93         }
  94         if ((cloexec ? pipe2(pdes, O_CLOEXEC) : pipe(pdes)) < 0)
  95                 return (NULL);
  96
  97         if ((cur = malloc(sizeof(struct pid))) == NULL) {
  98                 (void)_close(pdes[0]);
  99                 (void)_close(pdes[1]);
 100                 return (NULL);
 101         }
 102
 103         if (*type == 'r') {
 104                 iop = fdopen(pdes[0], type);
 105                 pdes_unused_in_parent = pdes[1];
 106         } else {
 107                 iop = fdopen(pdes[1], type);
 108                 pdes_unused_in_parent = pdes[0];
 109         }
 110         if (iop == NULL) {
 111                 (void)_close(pdes[0]);
 112                 (void)_close(pdes[1]);
 113                 free(cur);
 114                 return (NULL);
 115         }
 116
 117         argv[0] = "sh";
 118         argv[1] = "-c";
 119         argv[2] = (char *)command;
 120         argv[3] = NULL;
 121
 122         THREAD_LOCK();
 123         switch (pid = vfork()) {
 124         case -1:                        /* Error. */
 125                 THREAD_UNLOCK();
 126                 /*
 127                  * The _close() closes the unused end of pdes[], while
 128                  * the fclose() closes the used end of pdes[], *and* cleans
 129                  * up iop.
 130                  */
 131                 (void)_close(pdes_unused_in_parent);
 132                 free(cur);
 133                 (void)fclose(iop);
 134                 return (NULL);
 135                 /* NOTREACHED */
 136         case 0:                         /* Child. */
 137                 if (*type == 'r') {
 138                         /*
 139                          * The _dup2() to STDIN_FILENO is repeated to avoid
 140                          * writing to pdes[1], which might corrupt the
 141                          * parent's copy.  This isn't good enough in
 142                          * general, since the _exit() is no return, so
 143                          * the compiler is free to corrupt all the local
 144                          * variables.
 145                          */
 146                         if (!cloexec)
 147                                 (void)_close(pdes[0]);
 148                         if (pdes[1] != STDOUT_FILENO) {
 149                                 (void)_dup2(pdes[1], STDOUT_FILENO);
 150                                 if (!cloexec)
 151                                         (void)_close(pdes[1]);
 152                                 if (twoway)
 153                                         (void)_dup2(STDOUT_FILENO, STDIN_FILENO);
 154                         } else if (twoway && (pdes[1] != STDIN_FILENO)) {
 155                                 (void)_dup2(pdes[1], STDIN_FILENO);
 156                                 if (cloexec)
 157                                         (void)_fcntl(pdes[1], F_SETFD, 0);
 158                         } else if (cloexec)
 159                                 (void)_fcntl(pdes[1], F_SETFD, 0);
 160                 } else {
 161                         if (pdes[0] != STDIN_FILENO) {
 162                                 (void)_dup2(pdes[0], STDIN_FILENO);
 163                                 if (!cloexec)
 164                                         (void)_close(pdes[0]);
 165                         } else if (cloexec)
 166                                 (void)_fcntl(pdes[0], F_SETFD, 0);
 167                         if (!cloexec)
 168                                 (void)_close(pdes[1]);
 169                 }
 170                 SLIST_FOREACH(p, &pidlist, next)
 171                         (void)_close(fileno(p->fp));
 172                 _execve(_PATH_BSHELL, argv, environ);
 173                 _exit(127);
 174                 /* NOTREACHED */
 175         }
 176         THREAD_UNLOCK();
 177
 178         /* Parent. */
 179         (void)_close(pdes_unused_in_parent);
 180
 181         /* Link into list of file descriptors. */
 182         cur->fp = iop;
 183         cur->pid = pid;
 184         THREAD_LOCK();
 185         SLIST_INSERT_HEAD(&pidlist, cur, next);
 186         THREAD_UNLOCK();
 187
 188         return (iop);
 189 }
 190
 191 /*
 192  * pclose --
 193  *      Pclose returns -1 if stream is not associated with a `popened' command,
 194  *      if already `pclosed', or waitpid returns an error.
 195  */
 196 int
 197 pclose(iop)
 198         FILE *iop;
 199 {
 200         struct pid *cur, *last = NULL;
 201         int pstat;
 202         pid_t pid;
 203
 204         /*
 205          * Find the appropriate file pointer and remove it from the list.
 206          */
 207         THREAD_LOCK();
 208         SLIST_FOREACH(cur, &pidlist, next) {
 209                 if (cur->fp == iop)
 210                         break;
 211                 last = cur;
 212         }
 213         if (cur == NULL) {
 214                 THREAD_UNLOCK();
 215                 return (-1);
 216         }
 217         if (last == NULL)
 218                 SLIST_REMOVE_HEAD(&pidlist, next);
 219         else
 220                 SLIST_REMOVE_AFTER(last, next);
 221         THREAD_UNLOCK();
 222
 223         (void)fclose(iop);
 224
 225         do {
 226                 pid = _wait4(cur->pid, &pstat, 0, (struct rusage *)0);
 227         } while (pid == -1 && errno == EINTR);
 228
 229         free(cur);
 230
 231         return (pid == -1 ? -1 : pstat);
 232 }