Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T.
Portions Copyright (c) 1997, The Open Group. All Rights Reserved.
Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.

popen, pclose - initiate a pipe to or from a process

#include <stdio.h>

FILE *popen(const char *command, const char *mode);

int pclose(FILE *stream);

The popen() function creates a pipe between the calling program and the command to be executed. The arguments to popen() are pointers to null-terminated strings. The command argument consists of a shell command line. The mode argument is an I/O mode, either r for reading or w for writing. The value returned is a stream pointer such that one can write to the standard input of the command, if the I/O mode is w, by writing to the file stream (see Intro(3)); and one can read from the standard output of the command, if the I/O mode is r, by reading from the file stream. Because open files are shared, a type r command may be used as an input filter and a type w as an output filter. A trailing F character can also be included in the mode argument as described in fopen(3C) to enable extended FILE facility.

The environment of the executed command will be as if a child process were created within the popen() call using fork(2). The child is created as if invoked with the call:

execl("/usr/bin/sh", "sh", "-c", command, (char *)0);

The pclose() function closes a stream opened by popen() by closing the pipe. It waits for the associated process to terminate and returns the termination status of the process running the command language interpreter. This is the value returned by waitpid(3C). See wait.h(3HEAD) for more information on termination status. If, however, a call to waitpid() with a pid argument equal to the process ID of the command line interpreter causes the termination status to be unavailable to pclose(), then pclose() returns -1 with errno set to ECHILD to report this condition.

Upon successful completion, popen() returns a pointer to an open stream that can be used to read or write to the pipe. Otherwise, it returns a null pointer and may set errno to indicate the error.

Upon successful completion, pclose() returns the termination status of the command language interpreter as returned by waitpid(). Otherwise, it returns -1 and sets errno to indicate the error.

The pclose() function will fail if: ECHILD

The popen() function may fail if: EMFILE

EINVAL

The popen() function may also set errno values as described by fork(2) or pipe(2).

If the original and popen() processes concurrently read or write a common file, neither should use buffered I/O. Problems with an output filter may be forestalled by careful buffer flushing, for example, with fflush() (see fclose(3C)). A security hole exists through the IFS and PATH environment variables. Full pathnames should be used (or PATH reset) and IFS should be set to space and tab (" \et").

Even if the process has established a signal handler for SIGCHLD, it will be called when the command terminates. Even if another thread in the same process issues a wait(3C) call, it will interfere with the return value of pclose(). Even if the process's signal handler for SIGCHLD has been set to ignore the signal, there will be no effect on pclose().

Example 1 popen() example

The following program will print on the standard output (see stdio(3C)) the names of files in the current directory with a .c suffix.

#include <stdio.h>
#include <stdlib.h>
main(\|)
{
 char *cmd = "/usr/bin/ls *.c";
 char buf[BUFSIZ];
 FILE *ptr;

 if ((ptr = popen(cmd, "r")) != NULL) {
 while (fgets(buf, BUFSIZ, ptr) != NULL)
 (void) printf("%s", buf);
 (void) pclose(ptr);
 }
 return 0;
}

Example 2 system() replacement

The following function can be used in a multithreaded process in place of the most common usage of the Unsafe system(3C) function:

int my_system(const char *cmd)
{
 FILE *p;

 if ((p = popen(cmd, "w")) == NULL)
 return (-1);
 return (pclose(p));
}

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability See below.

MT-Level Safe

The F character in the mode argument of popen() is Evolving. In all other respects this function is Standard. The pclose() function is Standard.

ksh (1), pipe (2), fclose (3C), fopen (3C), posix_spawn (3C), stdio (3C), system (3C), wait (3C), waitpid (3C), wait.h (3HEAD), attributes (7), standards (7)