Skip to content

Commit

Permalink
process: Add thread safety comments.
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Pfaff <[email protected]>
  • Loading branch information
blp committed Jun 10, 2013
1 parent 57d9031 commit ff412c8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
4 changes: 4 additions & 0 deletions lib/process.c
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ static void sigchld_handler(int signr OVS_UNUSED);
/* Initializes the process subsystem (if it is not already initialized). Calls
* exit() if initialization fails.
*
* This function may not be called after creating any additional threads.
*
* Calling this function is optional; it will be called automatically by
* process_start() if necessary. Calling it explicitly allows the client to
* prevent the process from exiting at an unexpected time. */
Expand Down Expand Up @@ -164,6 +166,8 @@ process_register(const char *name, pid_t pid)
* argv[0] is used as the name of the process. Searches the PATH environment
* variable to find the program to execute.
*
* This function may not be called after creating any additional threads.
*
* All file descriptors are closed before executing the subprocess, except for
* fds 0, 1, and 2.
*
Expand Down
14 changes: 10 additions & 4 deletions lib/process.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,27 @@
#include <sys/types.h>

struct process;

/* Starting and monitoring subprocesses.
*
* process_init() and process_start() may safely be called only from a
* single-threaded parent process. The parent process may safely create
* additional threads afterward, as long as the remaining functions in this
* group are called only from a single thread at any given time. */
void process_init(void);
char *process_escape_args(char **argv);
int process_start(char **argv, struct process **);
void process_destroy(struct process *);
int process_kill(const struct process *, int signr);

pid_t process_pid(const struct process *);
const char *process_name(const struct process *);
bool process_exited(struct process *);
int process_status(const struct process *);
char *process_status_msg(int);

void process_run(void);
void process_wait(struct process *);

/* These functions are thread-safe. */
char *process_status_msg(int);
char *process_escape_args(char **argv);
char *process_search_path(const char *);

#endif /* process.h */

0 comments on commit ff412c8

Please sign in to comment.