logd/LogBuffer.h

   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_H__
  18 #define _LOGD_LOG_BUFFER_H__
  19
  20 #include <sys/types.h>
  21
  22 #include <log/log.h>
  23 #include <sysutils/SocketClient.h>
  24 #include <utils/List.h>
  25
  26 #include <private/android_filesystem_config.h>
  27
  28 #include "LogBufferElement.h"
  29 #include "LogTimes.h"
  30 #include "LogStatistics.h"
  31 #include "LogWhiteBlackList.h"
  32
  33 typedef android::List<LogBufferElement *> LogBufferElementCollection;
  34
  35 class LogBuffer {
  36     LogBufferElementCollection mLogElements;
  37     pthread_mutex_t mLogElementsLock;
  38
  39     LogStatistics stats;
  40
  41     PruneList mPrune;
  42
  43     unsigned long mMaxSize[LOG_ID_MAX];
  44
  45 public:
  46     LastLogTimes &mTimes;
  47
  48     LogBuffer(LastLogTimes *times);
  49     void init();
  50
  51     int log(log_id_t log_id, log_time realtime,
  52             uid_t uid, pid_t pid, pid_t tid,
  53             const char *msg, unsigned short len);
  54     uint64_t flushTo(SocketClient *writer, const uint64_t start,
  55                      bool privileged,
  56                      int (*filter)(const LogBufferElement *element, void *arg) = NULL,
  57                      void *arg = NULL);
  58
  59     void clear(log_id_t id, uid_t uid = AID_ROOT);
  60     unsigned long getSize(log_id_t id);
  61     int setSize(log_id_t id, unsigned long size);
  62     unsigned long getSizeUsed(log_id_t id);
  63     // *strp uses malloc, use free to release.
  64     void formatStatistics(char **strp, uid_t uid, unsigned int logMask);
  65
  66     void enableStatistics() {
  67         stats.enableStatistics();
  68     }
  69
  70     int initPrune(char *cp) { return mPrune.init(cp); }
  71     // *strp uses malloc, use free to release.
  72     void formatPrune(char **strp) { mPrune.format(strp); }
  73
  74     // helper must be protected directly or implicitly by lock()/unlock()
  75     char *pidToName(pid_t pid) { return stats.pidToName(pid); }
  76     uid_t pidToUid(pid_t pid) { return stats.pidToUid(pid); }
  77     char *uidToName(uid_t uid) { return stats.uidToName(uid); }
  78     void lock() { pthread_mutex_lock(&mLogElementsLock); }
  79     void unlock() { pthread_mutex_unlock(&mLogElementsLock); }
  80
  81 private:
  82     void maybePrune(log_id_t id);
  83     void prune(log_id_t id, unsigned long pruneRows, uid_t uid = AID_ROOT);
  84     LogBufferElementCollection::iterator erase(LogBufferElementCollection::iterator it);
  85 };
  86
  87 #endif // _LOGD_LOG_BUFFER_H__