You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
122 lines
4.5 KiB
122 lines
4.5 KiB
/* |
|
* Copyright (C) 2005-2017 The Android Open Source Project |
|
* |
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
* you may not use this file except in compliance with the License. |
|
* You may obtain a copy of the License at |
|
* |
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
* |
|
* Unless required by applicable law or agreed to in writing, software |
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
* See the License for the specific language governing permissions and |
|
* limitations under the License. |
|
*/ |
|
|
|
#ifndef _LIBS_LOGCAT_H /* header boilerplate */ |
|
#define _LIBS_LOGCAT_H |
|
|
|
#include <stdio.h> |
|
|
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
#ifndef __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE |
|
#ifndef __ANDROID_API__ |
|
#define __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE 1 |
|
#elif __ANDROID_API__ > 24 /* > Nougat */ |
|
#define __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE 1 |
|
#else |
|
#define __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE 0 |
|
#endif |
|
#endif |
|
|
|
#if __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE |
|
|
|
/* For managing an in-process logcat function, rather than forking/execing |
|
* |
|
* It also serves as the basis for the logcat command. |
|
* |
|
* The following C API allows a logcat instance to be created, run |
|
* to completion, and then release all the associated resources. |
|
*/ |
|
|
|
/* |
|
* The opaque context |
|
*/ |
|
#ifndef __android_logcat_context_defined /* typedef boilerplate */ |
|
#define __android_logcat_context_defined |
|
typedef struct android_logcat_context_internal* android_logcat_context; |
|
#endif |
|
|
|
/* Creates a context associated with this logcat instance |
|
* |
|
* Returns a pointer to the context, or a NULL on error. |
|
*/ |
|
android_logcat_context create_android_logcat(); |
|
|
|
/* Collects and outputs the logcat data to output and error file descriptors |
|
* |
|
* Will block, performed in-thread and in-process |
|
* |
|
* The output file descriptor variable, if greater than or equal to 0, is |
|
* where the output (ie: stdout) will be sent. The file descriptor is closed |
|
* on android_logcat_destroy which terminates the instance, or when an -f flag |
|
* (output redirect to a file) is present in the command. The error file |
|
* descriptor variable, if greater than or equal to 0, is where the error |
|
* stream (ie: stderr) will be sent, also closed on android_logcat_destroy. |
|
* The error file descriptor can be set to equal to the output file descriptor, |
|
* which will mix output and error stream content, and will defer closure of |
|
* the file descriptor on -f flag redirection. Negative values for the file |
|
* descriptors will use stdout and stderr FILE references respectively |
|
* internally, and will not close the references as noted above. |
|
* |
|
* Return value is 0 for success, non-zero for errors. |
|
*/ |
|
int android_logcat_run_command(android_logcat_context ctx, int output, int error, |
|
int argc, char* const* argv, char* const* envp); |
|
|
|
/* Will not block, performed in-process |
|
* |
|
* Starts a thread, opens a pipe, returns reading end fd, saves off argv. |
|
* The command supports 2>&1 (mix content) and 2>/dev/null (drop content) for |
|
* scripted error (stderr) redirection. |
|
*/ |
|
int android_logcat_run_command_thread(android_logcat_context ctx, int argc, |
|
char* const* argv, char* const* envp); |
|
int android_logcat_run_command_thread_running(android_logcat_context ctx); |
|
|
|
/* Finished with context |
|
* |
|
* Kill the command thread ASAP (if any), and free up all associated resources. |
|
* |
|
* Return value is the result of the android_logcat_run_command, or |
|
* non-zero for any errors. |
|
*/ |
|
int android_logcat_destroy(android_logcat_context* ctx); |
|
|
|
/* derived helpers */ |
|
|
|
/* |
|
* In-process thread that acts like somewhat like libc-like system and popen |
|
* respectively. Can not handle shell scripting, only pure calls to the |
|
* logcat operations. The android_logcat_system is a wrapper for the |
|
* create_android_logcat, android_logcat_run_command and android_logcat_destroy |
|
* API above. The android_logcat_popen is a wrapper for the |
|
* android_logcat_run_command_thread API above. The android_logcat_pclose is |
|
* a wrapper for a reasonable wait until output has subsided for command |
|
* completion, fclose on the FILE pointer and the android_logcat_destroy API. |
|
*/ |
|
int android_logcat_system(const char* command); |
|
FILE* android_logcat_popen(android_logcat_context* ctx, const char* command); |
|
int android_logcat_pclose(android_logcat_context* ctx, FILE* output); |
|
|
|
#endif /* __ANDROID_USE_LIBLOG_LOGCAT_INTERFACE */ |
|
|
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#endif /* _LIBS_LOGCAT_H */
|
|
|