logwrap.h revision f5200c075098a6fb6a69ac4e2baa2fdd3809cbbd 
1/* system/core/include/logwrap/logwrap.h
2 *
3 * Copyright 2013, The Android Open Source Project
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef __LIBS_LOGWRAP_H
19#define __LIBS_LOGWRAP_H
20
21#include <stdbool.h>
22
23__BEGIN_DECLS
24
25/*
26 * Run a command while logging its stdout and stderr
27 *
28 * WARNING: while this function is running it will clear all SIGCHLD handlers
29 * if you rely on SIGCHLD in the caller there is a chance zombies will be
30 * created if you're not calling waitpid after calling this. This function will
31 * log a warning when it clears SIGCHLD for processes other than the child it
32 * created.
33 *
34 * Arguments:
35 *   argc:   the number of elements in argv
36 *   argv:   an array of strings containing the command to be executed and its
37 *           arguments as separate strings. argv does not need to be
38 *           NULL-terminated
39 *   status: the equivalent child status as populated by wait(status). This
40 *           value is only valid when logwrap successfully completes
41 *   ignore_int_quit: set to true if you want to completely ignore SIGINT and
42 *           SIGQUIT while logwrap is running. This may force the end-user to
43 *           send a signal twice to signal the caller (once for the child, and
44 *           once for the caller)
45 *   quiet: when true, don't display log messages
46 *
47 * Return value:
48 *   0 when logwrap successfully run the child process and captured its status
49 *   -1 when an internal error occurred
50 *
51 */
52int logwrap(int argc, char* argv[], int *status, bool ignore_int_quit,
53        bool quiet);
54
55__END_DECLS
56
57#endif /* __LIBS_LOGWRAP_H */
58