include/android_stub/log/event_tag_map.h

   1 /*
   2  * Copyright (C) 2007 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <stddef.h>
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 #define EVENT_TAG_MAP_FILE "/system/etc/event-log-tags"
  26
  27 struct EventTagMap;
  28 typedef struct EventTagMap EventTagMap;
  29
  30 /*
  31  * Open the specified file as an event log tag map.
  32  *
  33  * Returns NULL on failure.
  34  */
  35 EventTagMap* android_openEventTagMap(const char* fileName);
  36
  37 /*
  38  * Close the map.
  39  */
  40 void android_closeEventTagMap(EventTagMap* map);
  41
  42 /*
  43  * Look up a tag by index.  Returns the tag string, or NULL if not found.
  44  */
  45 const char* android_lookupEventTag(const EventTagMap* map, unsigned int tag)
  46     __attribute__((
  47         deprecated("use android_lookupEventTag_len() instead to minimize "
  48                    "MAP_PRIVATE copy-on-write memory impact")));
  49
  50 /*
  51  * Look up a tag by index.  Returns the tag string & string length, or NULL if
  52  * not found.  Returned string is not guaranteed to be nul terminated.
  53  */
  54 const char* android_lookupEventTag_len(const EventTagMap* map, size_t* len,
  55                                        unsigned int tag);
  56
  57 /*
  58  * Look up a format by index. Returns the format string & string length,
  59  * or NULL if not found. Returned string is not guaranteed to be nul terminated.
  60  */
  61 const char* android_lookupEventFormat_len(const EventTagMap* map, size_t* len,
  62                                           unsigned int tag);
  63
  64 /*
  65  * Look up tagname, generate one if necessary, and return a tag
  66  */
  67 int android_lookupEventTagNum(EventTagMap* map, const char* tagname,
  68                               const char* format, int prio);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif