2 * include/types.h - types representing the tesh concepts.
4 * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package.
10 * This file declares the types used to run a set of tesh files.
20 #include <xbt/xbt_os_thread.h>
21 #include <xbt/strbuff.h>
31 * byte type definition
33 #ifndef __BYTE_T_DEFINED
34 typedef unsigned char byte;
35 #define __BYTE_T_DEFINED
39 * file descriptor and pid types for portability.
44 #ifndef __FD_T_DEFINED
46 #define __FD_T_DEFINED
49 #ifndef __PID_T_DEFINED
51 #define __PID_T_DEFINED
56 #ifndef __FD_T_DEFINED
58 #define __FD_T_DEFINED
61 #ifndef __PID_T_DEFINED
63 #define __PID_T_DEFINED
67 /* forward declarations */
69 struct s_unit; /* this structure represents a tesh unit */
89 * declaration of the tesh unit type which represents a tesh file
94 char* description; /* an optional description of the unit */
95 struct s_fstream* fstream; /* the file stream used to parse the tesh file */
96 struct s_runner* runner; /* the runner of the unit */
97 xbt_dynar_t commands; /* a vector containing all the commands parsed from the tesh file */
98 int cmd_nb; /* number of created commands of the unit */
99 int started_cmd_nb; /* number of started commands of the unit */
100 int interrupted_cmd_nb; /* number of interrupted commands of the unit */
101 int failed_cmd_nb; /* number of failed commands of the unit */
102 int successeded_cmd_nb; /* number of successeded commands of the unit */
103 int terminated_cmd_nb; /* number of ended commands */
104 int waiting_cmd_nb; /* REMOVE THIS FIELD LATER */
105 xbt_os_thread_t thread; /* all the units run in its own thread */
106 xbt_os_sem_t sem; /* used by the last command of the unit to signal the end of the unit */
107 xbt_os_mutex_t mutex; /* used to synchronously access to the properties of the runner */
108 unsigned interrupted : 1; /* if 1, the unit is interrupted by the runner */
109 unsigned failed : 1; /* if 1, the unit is failed */
110 unsigned successeded : 1; /* if 1, the unit is successeded */
111 unsigned parsed : 1; /* if 1, the tesh file of the unit is parsed */
112 unsigned released : 1; /* if 1, the unit is released */
113 unsigned is_running_suite : 1; /* if 1, the unit is running a suite */
114 struct s_unit* owner; /* the unit owned the unit is included */
115 struct s_unit* root; /* the root unit */
116 xbt_dynar_t suites; /* the suites contained by the unit */
117 int exit_code; /* the exit code of the unit */
119 xbt_dynar_t includes;
124 * declaration of the tesh file stream type used to manage the tesh file.
126 typedef struct s_fstream
128 char* name; /* the name of the file stream (same as the name of the tesh file) */
129 char* directory; /* the directory containing the tesh file */
130 FILE* stream; /* the system file stream */
131 struct s_unit* unit; /* a reference to the unit using the file stream object */
133 }s_fstream_t,* fstream_t;
138 typedef enum e_command_status
140 cs_initialized = 0, /* the is initialized */
141 cs_started = 1, /* the command is started */
142 cs_in_progress = 2, /* the command is execited */
143 cs_waiting = 3, /* the command is waiting the writer, the reader and the timer */
144 cs_interrupted = 4, /* the command is interrupted */
145 cs_failed = 5, /* the command is failed */
146 cs_successeded = 6, /* the command is successeded */
147 cs_killed = 7, /* the command is killed */
148 csr_fcntl_function_failed = 8 /* the fcntl function failed */
152 * reason of the status of the command
154 typedef enum e_command_status_raison
156 csr_unknown = 0, /* unknown reason */
157 csr_read_failure = 1, /* a read operation failed */
158 csr_read_pipe_broken = 2, /* the pipe used to read from the stdout of the command is broken */
159 csr_timeout = 3, /* timeout */
160 csr_write_failure = 4, /* a write operation failed */
161 csr_write_pipe_broken = 5, /* the pipe used to write to the stdin of the command is broken */
162 csr_fork_function_failure = 6, /* can't execute the command */
163 csr_wait_failure = 8, /* the wait process function failed */
164 csr_interruption_request = 9, /* the command has received an interruption request */
165 csr_command_not_found = 10, /* the command is not found */
166 csr_exit_codes_dont_match = 11,
167 csr_outputs_dont_match = 12,
168 csr_signals_dont_match = 13,
169 csr_unexpected_signal_caught = 14,
170 csr_expected_signal_not_receipt = 15,
171 csr_pipe_function_failed = 16, /* the function pipe() or CreatePipe() fails */
172 csr_dup2_function_failure = 17,
173 csr_execlp_function_failure = 18,
174 csr_create_process_function_failure = 19,
175 csr_waitpid_function_failure = 20,
176 csr_get_exit_code_process_function_failure = 21,
177 csr_shell_failed = 22
183 typedef struct s_variable
190 }s_variable_t,* variable_t;
193 * declaration of the tesh timer type
195 typedef struct s_timer
197 xbt_os_thread_t thread; /* asynchronous timer */
198 struct s_command* command; /* the timed command */
199 int timeouted; /* if 1, the timer is timeouted */
200 xbt_os_sem_t started;
201 }s_timer_t,* ttimer_t;
204 * declaration of the tesh reader type
206 typedef struct s_reader
208 xbt_os_thread_t thread; /* asynchonous reader */
209 struct s_command* command; /* the command of the reader */
210 int failed; /* if 1, the reader failed */
211 int broken_pipe; /* if 1, the pipe used by the reader is broken */
213 xbt_os_sem_t started;
214 }s_reader_t,* reader_t;
217 * declaration of the tesh writer type
219 typedef struct s_writer
221 xbt_os_thread_t thread; /* asynchronous writer */
222 struct s_command* command; /* the command of the writer */
223 int failed; /* if 1, the writer failed */
224 int broken_pipe; /* if 1, the pipe used by the writer is broken */
225 xbt_os_sem_t written;
226 xbt_os_sem_t can_write;
228 }s_writer_t,* writer_t;
231 typedef struct s_units
234 int number_of_runned_units; /* the number of units runned */
235 int number_of_ended_units; /* the number of units over */
237 }s_units_t,* units_t;
240 * declaration of the tesh runner type
242 typedef struct s_runner
244 struct s_units* units;
245 int timeouted; /* if 1, the runner is timeouted */
246 int timeout; /* the timeout of the runner */
247 int interrupted; /* if 1, the runner failed */
248 int number_of_runned_units; /* the number of units runned by the runner */
249 int number_of_ended_units; /* the number of ended units */
250 int waiting; /* if 1, the runner is waiting the end of all the units */
251 xbt_os_thread_t thread; /* the timer thread */
252 xbt_dynar_t variables;
255 int total_of_successeded_tests;
256 int total_of_failed_tests;
257 int total_of_interrupted_tests;
260 int total_of_successeded_units;
261 int total_of_failed_units;
262 int total_of_interrupted_units;
265 int total_of_successeded_suites;
266 int total_of_failed_suites;
267 int total_of_interrupted_suites;
270 }s_runner_t,* runner_t;
273 typedef struct s_fstreams
276 }s_fstreams_t,* fstreams_t;
279 typedef struct s_excludes
282 }s_excludes_t,* excludes_t;
284 typedef struct s_directory
288 }s_directory_t,* directory_t;
290 typedef struct s_directories
293 }s_directories_t,* directories_t;
303 * declaration of the tesh context type
305 typedef struct s_context
307 char* command_line; /* the command line of the command to execute */
308 const char* line; /* the current parsed line */
310 int exit_code; /* the expected exit code of the command */
311 char* signal; /* the expected signal raised by the command */
312 int timeout; /* the timeout of the test */
313 xbt_strbuff_t input; /* the input to write in the stdin of the command to run */
314 xbt_strbuff_t output; /* the expected output of the command of the test */
315 output_handling_t output_handling;
316 int async; /* if 1, the command is asynchronous */
317 }s_context_t,* context_t;
320 * declaration of the tesh command type
322 typedef struct s_command
325 unit_t unit; /* the unit of the command */
326 struct s_context* context; /* the context of the execution of the command */
327 xbt_os_thread_t thread; /* asynchronous command */
328 struct s_writer* writer; /* the writer used to write in the command stdin */
329 struct s_reader* reader; /* the reader used to read from the command stout */
330 struct s_timer* timer; /* the timer used for the command */
331 command_status_t status; /* the current status of the command */
332 cs_reason_t reason; /* the reason of the state of the command */
333 int successeded; /* if 1, the command is successeded */
334 int interrupted; /* if 1, the command is interrupted */
335 int failed; /* if 1, the command is failed */
336 pid_t pid; /* the program id of the command */
337 xbt_strbuff_t output; /* the output of the command */
338 fd_t stdout_fd; /* the stdout fd of the command */
339 fd_t stdin_fd; /* the stdin fd of the command */
340 int exit_code; /* the exit code of the command */
342 unsigned long stat_val;
346 char* signal; /* the signal raised by the command if any */
347 xbt_os_mutex_t mutex;
350 int killed; /* if 1, the command was killed */
354 }s_command_t,* command_t;
360 #endif /* !__TYPES_H */