Remove liblog, logcat, logd, logwrapper am: d2c21a10 am: e55e30f5

../.clang-format-2

 No newline at end of file

//

// Copyright (C) 2008-2014 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.

//

liblog_sources = [

    "log_event_list.cpp",

    "log_event_write.cpp",

    "logger_name.cpp",

    "logger_read.cpp",

    "logger_write.cpp",

    "logprint.cpp",

    "properties.cpp",

]

liblog_target_sources = [

    "event_tag_map.cpp",

    "log_time.cpp",

    "pmsg_reader.cpp",

    "pmsg_writer.cpp",

    "logd_reader.cpp",

    "logd_writer.cpp",

]

cc_library_headers {

    name: "liblog_headers",

    host_supported: true,

    vendor_available: true,

    ramdisk_available: true,

    recovery_available: true,

    apex_available: [

        "//apex_available:platform",

        "//apex_available:anyapex",

    ],

    min_sdk_version: "29",

    sdk_version: "minimum",

    native_bridge_supported: true,

    export_include_dirs: ["include"],

    system_shared_libs: [],

    stl: "none",

    target: {

        windows: {

            enabled: true,

        },

        linux_bionic: {

            enabled: true,

        },

        vendor: {

            override_export_include_dirs: ["include_vndk"],

        },

    },

}

// Shared and static library for host and device

// ========================================================

cc_library {

    name: "liblog",

    host_supported: true,

    ramdisk_available: true,

    recovery_available: true,

    native_bridge_supported: true,

    srcs: liblog_sources,

    target: {

        android: {

            version_script: "liblog.map.txt",

            srcs: liblog_target_sources,

            // AddressSanitizer runtime library depends on liblog.

            sanitize: {

                address: false,

            },

        },

        android_arm: {

            // TODO: This is to work around b/24465209. Remove after root cause is fixed

            pack_relocations: false,

            ldflags: ["-Wl,--hash-style=both"],

        },

        windows: {

            enabled: true,

        },

        not_windows: {

            srcs: ["event_tag_map.cpp"],

        },

        linux_bionic: {

            enabled: true,

        },

    },

    header_libs: [

        "libbase_headers",

        "libcutils_headers",

        "liblog_headers",

    ],

    export_header_lib_headers: ["liblog_headers"],

    stubs: {

        symbol_file: "liblog.map.txt",

        versions: ["29", "30"],

    },

    cflags: [

        "-Wall",

        "-Werror",

        "-Wextra",

        // This is what we want to do:

        //  liblog_cflags := $(shell \

        //   sed -n \

        //       's/^\([0-9]*\)[ \t]*liblog[ \t].*/-DLIBLOG_LOG_TAG=\1/p' \

        //       $(LOCAL_PATH)/event.logtags)

        // so make sure we do not regret hard-coding it as follows:

        "-DLIBLOG_LOG_TAG=1006",

        "-DSNET_EVENT_LOG_TAG=1397638484",

    ],

    logtags: ["event.logtags"],

    compile_multilib: "both",

    apex_available: [

        "//apex_available:platform",

        // liblog is exceptionally available to the runtime APEX

        // because the dynamic linker has to use it statically.

        // See b/151051671

        "com.android.runtime",

        // DO NOT add more apex names here

    ],

}

ndk_headers {

    name: "liblog_ndk_headers",

    from: "include/android",

    to: "android",

    srcs: ["include/android/log.h"],

    license: "NOTICE",

}

ndk_library {

    name: "liblog",

    symbol_file: "liblog.map.txt",

    first_version: "9",

    unversioned_until: "current",

}

llndk_library {

    name: "liblog",

    native_bridge_supported: true,

    symbol_file: "liblog.map.txt",

    export_include_dirs: ["include_vndk"],

}

   Copyright (c) 2005-2014, 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.

   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.

                                 Apache License

                           Version 2.0, January 2004

                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,

      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by

      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all

      other entities that control, are controlled by, or are under common

      control with that entity. For the purposes of this definition,

      "control" means (i) the power, direct or indirect, to cause the

      direction or management of such entity, whether by contract or

      otherwise, or (ii) ownership of fifty percent (50%) or more of the

      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity

      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,

      including but not limited to software source code, documentation

      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical

      transformation or translation of a Source form, including but

      not limited to compiled object code, generated documentation,

      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or

      Object form, made available under the License, as indicated by a

      copyright notice that is included in or attached to the work

      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object

      form, that is based on (or derived from) the Work and for which the

      editorial revisions, annotations, elaborations, or other modifications

      represent, as a whole, an original work of authorship. For the purposes

      of this License, Derivative Works shall not include works that remain

      separable from, or merely link (or bind by name) to the interfaces of,

      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including

      the original version of the Work and any modifications or additions

      to that Work or Derivative Works thereof, that is intentionally

      submitted to Licensor for inclusion in the Work by the copyright owner

      or by an individual or Legal Entity authorized to submit on behalf of

      the copyright owner. For the purposes of this definition, "submitted"

      means any form of electronic, verbal, or written communication sent

      to the Licensor or its representatives, including but not limited to

      communication on electronic mailing lists, source code control systems,

      and issue tracking systems that are managed by, or on behalf of, the

      Licensor for the purpose of discussing and improving the Work, but

      excluding communication that is conspicuously marked or otherwise

      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity

      on behalf of whom a Contribution has been received by Licensor and

      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      copyright license to reproduce, prepare Derivative Works of,

      publicly display, publicly perform, sublicense, and distribute the

      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      (except as stated in this section) patent license to make, have made,

      use, offer to sell, sell, import, and otherwise transfer the Work,

      where such license applies only to those patent claims licensable

      by such Contributor that are necessarily infringed by their

      Contribution(s) alone or by combination of their Contribution(s)

      with the Work to which such Contribution(s) was submitted. If You

      institute patent litigation against any entity (including a

      cross-claim or counterclaim in a lawsuit) alleging that the Work

      or a Contribution incorporated within the Work constitutes direct

      or contributory patent infringement, then any patent licenses

      granted to You under this License for that Work shall terminate

      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the

      Work or Derivative Works thereof in any medium, with or without

      modifications, and in Source or Object form, provided that You

      meet the following conditions:

      (a) You must give any other recipients of the Work or

          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices

          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works

          that You distribute, all copyright, patent, trademark, and

          attribution notices from the Source form of the Work,

          excluding those notices that do not pertain to any part of

          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its

          distribution, then any Derivative Works that You distribute must

          include a readable copy of the attribution notices contained

          within such NOTICE file, excluding those notices that do not

          pertain to any part of the Derivative Works, in at least one

          of the following places: within a NOTICE text file distributed

          as part of the Derivative Works; within the Source form or

          documentation, if provided along with the Derivative Works; or,

          within a display generated by the Derivative Works, if and

          wherever such third-party notices normally appear. The contents

          of the NOTICE file are for informational purposes only and

          do not modify the License. You may add Your own attribution

          notices within Derivative Works that You distribute, alongside

          or as an addendum to the NOTICE text from the Work, provided

          that such additional attribution notices cannot be construed

          as modifying the License.

      You may add Your own copyright statement to Your modifications and

      may provide additional or different license terms and conditions

      for use, reproduction, or distribution of Your modifications, or

      for any such Derivative Works as a whole, provided Your use,

      reproduction, and distribution of the Work otherwise complies with

      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,

      any Contribution intentionally submitted for inclusion in the Work

      by You to the Licensor shall be under the terms and conditions of

      this License, without any additional terms or conditions.

      Notwithstanding the above, nothing herein shall supersede or modify

      the terms of any separate license agreement you may have executed

      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade

      names, trademarks, service marks, or product names of the Licensor,

      except as required for reasonable and customary use in describing the

      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or

      agreed to in writing, Licensor provides the Work (and each

      Contributor provides its Contributions) on an "AS IS" BASIS,

      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

      implied, including, without limitation, any warranties or conditions

      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

      PARTICULAR PURPOSE. You are solely responsible for determining the

      appropriateness of using or redistributing the Work and assume any

      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,

      whether in tort (including negligence), contract, or otherwise,

      unless required by applicable law (such as deliberate and grossly

      negligent acts) or agreed to in writing, shall any Contributor be

      liable to You for damages, including any direct, indirect, special,

      incidental, or consequential damages of any character arising as a

      result of this License or out of the use or inability to use the

      Work (including but not limited to damages for loss of goodwill,

      work stoppage, computer failure or malfunction, or any and all

      other commercial damages or losses), even if such Contributor

      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing

      the Work or Derivative Works thereof, You may choose to offer,

      and charge a fee for, acceptance of support, warranty, indemnity,

      or other liability obligations and/or rights consistent with this

      License. However, in accepting such obligations, You may act only

      on Your own behalf and on Your sole responsibility, not on behalf

      of any other Contributor, and only if You agree to indemnify,

      defend, and hold each Contributor harmless for any liability

      incurred by, or claims asserted against, such Contributor by reason

      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

tomcherry@google.com

Android liblog

--------------

Public Functions and Macros

---------------------------

    /*

     * Please limit to 24 characters for runtime is loggable,

     * 16 characters for persist is loggable, and logcat pretty

     * alignment with limit of 7 characters.

    */

    #define LOG_TAG "yourtag"

    #include <log/log.h>

    ALOG(android_priority, tag, format, ...)

    IF_ALOG(android_priority, tag)

    LOG_PRI(priority, tag, format, ...)

    LOG_PRI_VA(priority, tag, format, args)

    #define LOG_TAG NULL

    ALOGV(format, ...)

    SLOGV(format, ...)

    RLOGV(format, ...)

    ALOGV_IF(cond, format, ...)

    SLOGV_IF(cond, format, ...)

    RLOGV_IF(cond, format, ...)

    IF_ALOGC()

    ALOGD(format, ...)

    SLOGD(format, ...)

    RLOGD(format, ...)

    ALOGD_IF(cond, format, ...)

    SLOGD_IF(cond, format, ...)

    RLOGD_IF(cond, format, ...)

    IF_ALOGD()

    ALOGI(format, ...)

    SLOGI(format, ...)

    RLOGI(format, ...)

    ALOGI_IF(cond, format, ...)

    SLOGI_IF(cond, format, ...)

    RLOGI_IF(cond, format, ...)

    IF_ALOGI()

    ALOGW(format, ...)

    SLOGW(format, ...)

    RLOGW(format, ...)

    ALOGW_IF(cond, format, ...)

    SLOGW_IF(cond, format, ...)

    RLOGW_IF(cond, format, ...)

    IF_ALOGW()

    ALOGE(format, ...)

    SLOGE(format, ...)

    RLOGE(format, ...)

    ALOGE_IF(cond, format, ...)

    SLOGE_IF(cond, format, ...)

    RLOGE_IF(cond, format, ...)

    IF_ALOGE()

    LOG_FATAL(format, ...)

    LOG_ALWAYS_FATAL(format, ...)

    LOG_FATAL_IF(cond, format, ...)

    LOG_ALWAYS_FATAL_IF(cond, format, ...)

    ALOG_ASSERT(cond, format, ...)

    LOG_EVENT_INT(tag, value)

    LOG_EVENT_LONG(tag, value)

    log_id_t android_logger_get_id(struct logger *logger)

    int android_logger_clear(struct logger *logger)

    int android_logger_get_log_size(struct logger *logger)

    int android_logger_get_log_readable_size(struct logger *logger)

    int android_logger_get_log_version(struct logger *logger)

    struct logger_list *android_logger_list_alloc(int mode, unsigned int tail, pid_t pid)

    struct logger *android_logger_open(struct logger_list *logger_list, log_id_t id)

    struct logger_list *android_logger_list_open(log_id_t id, int mode, unsigned int tail, pid_t pid)

    int android_logger_list_read(struct logger_list *logger_list, struct log_msg *log_msg)

    void android_logger_list_free(struct logger_list *logger_list)

    log_id_t android_name_to_log_id(const char *logName)

    const char *android_log_id_to_name(log_id_t log_id)

    android_log_context create_android_logger(uint32_t tag)

    int android_log_write_list_begin(android_log_context ctx)

    int android_log_write_list_end(android_log_context ctx)

    int android_log_write_int32(android_log_context ctx, int32_t value)

    int android_log_write_int64(android_log_context ctx, int64_t value)

    int android_log_write_string8(android_log_context ctx, const char *value)

    int android_log_write_string8_len(android_log_context ctx, const char *value, size_t maxlen)

    int android_log_write_float32(android_log_context ctx, float value)

    int android_log_write_list(android_log_context ctx, log_id_t id = LOG_ID_EVENTS)

    android_log_context create_android_log_parser(const char *msg, size_t len)

    android_log_list_element android_log_read_next(android_log_context ctx)

    android_log_list_element android_log_peek_next(android_log_context ctx)

    int android_log_destroy(android_log_context *ctx)

Description

-----------

liblog represents an interface to the volatile Android Logging system for NDK (Native) applications

and libraries.  Interfaces for either writing or reading logs.  The log buffers are divided up in

Main, System, Radio and Events sub-logs.

The logging interfaces are a series of macros, all of which can be overridden individually in order

to control the verbosity of the application or library.  `[ASR]LOG[VDIWE]` calls are used to log to

BAsic, System or Radio sub-logs in either the Verbose, Debug, Info, Warning or Error priorities.

`[ASR]LOG[VDIWE]_IF` calls are used to perform thus based on a condition being true.

`IF_ALOG[VDIWE]` calls are true if the current `LOG_TAG` is enabled at the specified priority.

`LOG_ALWAYS_FATAL` is used to `ALOG` a message, then kill the process.  `LOG_FATAL` call is a

variant of `LOG_ALWAYS_FATAL`, only enabled in engineering, and not release builds.  `ALOG_ASSERT`

is used to `ALOG` a message if the condition is false; the condition is part of the logged message.

`LOG_EVENT_(INT|LONG)` is used to drop binary content into the Events sub-log.

The log reading interfaces permit opening the logs either singly or multiply, retrieving a log entry

at a time in time sorted order, optionally limited to a specific pid and tail of the log(s) and

finally a call closing the logs.  A single log can be opened with `android_logger_list_open()`; or

multiple logs can be opened with `android_logger_list_alloc()`, calling in turn the

`android_logger_open()` for each log id.  Each entry can be retrieved with

`android_logger_list_read()`.  The log(s) can be closed with `android_logger_list_free()`.

`ANDROID_LOG_NONBLOCK` mode will report when the log reading is done with an `EAGAIN` error return

code, otherwise the `android_logger_list_read()` call will block for new entries.

The `ANDROID_LOG_WRAP` mode flag to the `android_logger_list_alloc_time()` signals logd to quiesce

the reader until the buffer is about to prune at the start time then proceed to dumping content.

The `ANDROID_LOG_PSTORE` mode flag to the `android_logger_open()` is used to switch from the active

logs to the persistent logs from before the last reboot.

The value returned by `android_logger_open()` can be used as a parameter to the

`android_logger_clear()` function to empty the sub-log.

The value returned by `android_logger_open()` can be used as a parameter to the

`android_logger_get_log_(size|readable_size|version)` to retrieve the sub-log maximum size, readable

size and log buffer format protocol version respectively.  `android_logger_get_id()` returns the id

that was used when opening the sub-log.

Errors

------

If messages fail, a negative error code will be returned to the caller.

The `-ENOTCONN` return code indicates that the logger daemon is stopped.

The `-EBADF` return code indicates that the log access point can not be opened, or the log buffer id

is out of range.

For the `-EAGAIN` return code, this means that the logging message was temporarily backed-up either

because of Denial Of Service (DOS) logging pressure from some chatty application or service in the

Android system, or if too small of a value is set in /proc/sys/net/unix/max_dgram_qlen.  To aid in

diagnosing the occurence of this, a binary event from liblog will be sent to the log daemon once a

new message can get through indicating how many messages were dropped as a result.  Please take

action to resolve the structural problems at the source.

It is generally not advised for the caller to retry the `-EAGAIN` return code as this will only make

the problem(s) worse and cause your application to temporarily drop to the logger daemon priority,

BATCH scheduling policy and background task cgroup. If you require a group of messages to be passed

atomically, merge them into one message with embedded newlines to the maximum length

`LOGGER_ENTRY_MAX_PAYLOAD`.

Other return codes from writing operation can be returned.  Since the library retries on `EINTR`,

`-EINTR` should never be returned.