external/bsd/atf/dist/atf-c/process.h

   1 /*
   2  * Automated Testing Framework (atf)
   3  *
   4  * Copyright (c) 2008, 2009 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #if !defined(ATF_C_PROCESS_H)
  31 #define ATF_C_PROCESS_H
  32
  33 #include <sys/types.h>
  34
  35 #include <stdbool.h>
  36
  37 #include <atf-c/error_fwd.h>
  38 #include <atf-c/fs.h>
  39 #include <atf-c/list.h>
  40 #include <atf-c/object.h>
  41
  42 /* ---------------------------------------------------------------------
  43  * The "atf_process_stream" type.
  44  * --------------------------------------------------------------------- */
  45
  46 struct atf_process_stream {
  47     atf_object_t m_object;
  48
  49     int m_type;
  50
  51     /* Valid if m_type == connect. */
  52     int m_src_fd;
  53     int m_tgt_fd;
  54
  55     /* Valid if m_type == redirect_fd. */
  56     int m_fd;
  57
  58     /* Valid if m_type == redirect_path. */
  59     const atf_fs_path_t *m_path;
  60 };
  61 typedef struct atf_process_stream atf_process_stream_t;
  62
  63 extern const int atf_process_stream_type_capture;
  64 extern const int atf_process_stream_type_connect;
  65 extern const int atf_process_stream_type_inherit;
  66 extern const int atf_process_stream_type_redirect_fd;
  67 extern const int atf_process_stream_type_redirect_path;
  68
  69 atf_error_t atf_process_stream_init_capture(atf_process_stream_t *);
  70 atf_error_t atf_process_stream_init_connect(atf_process_stream_t *,
  71                                             const int, const int);
  72 atf_error_t atf_process_stream_init_inherit(atf_process_stream_t *);
  73 atf_error_t atf_process_stream_init_redirect_fd(atf_process_stream_t *,
  74                                                 const int fd);
  75 atf_error_t atf_process_stream_init_redirect_path(atf_process_stream_t *,
  76                                                   const atf_fs_path_t *);
  77 void atf_process_stream_fini(atf_process_stream_t *);
  78
  79 int atf_process_stream_type(const atf_process_stream_t *);
  80
  81 /* ---------------------------------------------------------------------
  82  * The "atf_process_status" type.
  83  * --------------------------------------------------------------------- */
  84
  85 struct atf_process_status {
  86     atf_object_t m_object;
  87
  88     int m_status;
  89 };
  90 typedef struct atf_process_status atf_process_status_t;
  91
  92 void atf_process_status_fini(atf_process_status_t *);
  93
  94 bool atf_process_status_exited(const atf_process_status_t *);
  95 int atf_process_status_exitstatus(const atf_process_status_t *);
  96 bool atf_process_status_signaled(const atf_process_status_t *);
  97 int atf_process_status_termsig(const atf_process_status_t *);
  98 bool atf_process_status_coredump(const atf_process_status_t *);
  99
 100 /* ---------------------------------------------------------------------
 101  * The "atf_process_child" type.
 102  * --------------------------------------------------------------------- */
 103
 104 struct atf_process_child {
 105     atf_object_t m_object;
 106
 107     pid_t m_pid;
 108
 109     int m_stdout;
 110     int m_stderr;
 111 };
 112 typedef struct atf_process_child atf_process_child_t;
 113
 114 atf_error_t atf_process_child_wait(atf_process_child_t *,
 115                                    atf_process_status_t *);
 116 pid_t atf_process_child_pid(const atf_process_child_t *);
 117 int atf_process_child_stdout(atf_process_child_t *);
 118 int atf_process_child_stderr(atf_process_child_t *);
 119
 120 /* ---------------------------------------------------------------------
 121  * Free functions.
 122  * --------------------------------------------------------------------- */
 123
 124 atf_error_t atf_process_fork(atf_process_child_t *,
 125                              void (*)(void *),
 126                              const atf_process_stream_t *,
 127                              const atf_process_stream_t *,
 128                              void *);
 129 atf_error_t atf_process_exec_array(atf_process_status_t *,
 130                                    const atf_fs_path_t *,
 131                                    const char *const *,
 132                                    const atf_process_stream_t *,
 133                                    const atf_process_stream_t *);
 134 atf_error_t atf_process_exec_list(atf_process_status_t *,
 135                                   const atf_fs_path_t *,
 136                                   const atf_list_t *,
 137                                   const atf_process_stream_t *,
 138                                   const atf_process_stream_t *);
 139
 140 #endif /* !defined(ATF_C_PROCESS_H) */