LogBufferElement.h revision 344bff4391dd434dda501e812f18f524290c5a7c
1/* 2 * Copyright (C) 2012-2014 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#ifndef _LOGD_LOG_BUFFER_ELEMENT_H__ 18#define _LOGD_LOG_BUFFER_ELEMENT_H__ 19 20#include <stdatomic.h> 21#include <stdlib.h> 22#include <sys/types.h> 23 24#include <sysutils/SocketClient.h> 25#include <log/log.h> 26#include <log/log_read.h> 27 28// Hijack this header as a common include file used by most all sources 29// to report some utilities defined here and there. 30 31namespace android { 32 33// Furnished in main.cpp. Caller must own and free returned value 34char *uidToName(uid_t uid); 35 36// Furnished in LogStatistics.cpp. Caller must own and free returned value 37char *pidToName(pid_t pid); 38 39// Furnished in main.cpp. Thread safe. 40const char *tagToName(uint32_t tag); 41 42} 43 44static inline bool worstUidEnabledForLogid(log_id_t id) { 45 return (id != LOG_ID_CRASH) && (id != LOG_ID_EVENTS); 46} 47 48class LogBuffer; 49 50class LogBufferElement { 51 const log_id_t mLogId; 52 const uid_t mUid; 53 const pid_t mPid; 54 const pid_t mTid; 55 char *mMsg; 56 union { 57 const unsigned short mMsgLen; // mMSg != NULL 58 unsigned short mDropped; // mMsg == NULL 59 }; 60 const uint64_t mSequence; 61 const log_time mRealTime; 62 static atomic_int_fast64_t sequence; 63 64 // assumption: mMsg == NULL 65 size_t populateDroppedMessage(char *&buffer, 66 LogBuffer *parent); 67 68public: 69 LogBufferElement(log_id_t log_id, log_time realtime, 70 uid_t uid, pid_t pid, pid_t tid, 71 const char *msg, unsigned short len); 72 virtual ~LogBufferElement(); 73 74 log_id_t getLogId() const { return mLogId; } 75 uid_t getUid(void) const { return mUid; } 76 pid_t getPid(void) const { return mPid; } 77 pid_t getTid(void) const { return mTid; } 78 unsigned short getDropped(void) const { return mMsg ? 0 : mDropped; } 79 unsigned short setDropped(unsigned short value) { 80 if (mMsg) { 81 free(mMsg); 82 mMsg = NULL; 83 } 84 return mDropped = value; 85 } 86 unsigned short getMsgLen() const { return mMsg ? mMsgLen : 0; } 87 uint64_t getSequence(void) const { return mSequence; } 88 static uint64_t getCurrentSequence(void) { return sequence.load(memory_order_relaxed); } 89 log_time getRealTime(void) const { return mRealTime; } 90 91 uint32_t getTag(void) const; 92 93 static const uint64_t FLUSH_ERROR; 94 uint64_t flushTo(SocketClient *writer, LogBuffer *parent); 95}; 96 97#endif 98