LogBuffer.h revision f5fc50958978fc039bc3207cbfcb140a277442eb 
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
33typedef android::List<LogBufferElement *> LogBufferElementCollection;
34
35class LogBuffer {
36    LogBufferElementCollection mLogElements;
37    pthread_mutex_t mLogElementsLock;
38
39    LogStatistics stats;
40    bool dgramQlenStatistics;
41
42    PruneList mPrune;
43
44    unsigned long mMaxSize[LOG_ID_MAX];
45
46public:
47    LastLogTimes &mTimes;
48
49    LogBuffer(LastLogTimes *times);
50
51    void 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    log_time flushTo(SocketClient *writer, const log_time start,
55                     bool privileged,
56                     bool (*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 enableDgramQlenStatistics() {
67        stats.enableDgramQlenStatistics();
68        dgramQlenStatistics = true;
69    }
70
71    void enableStatistics() {
72        stats.enableStatistics();
73    }
74
75    int initPrune(char *cp) { return mPrune.init(cp); }
76    // *strp uses malloc, use free to release.
77    void formatPrune(char **strp) { mPrune.format(strp); }
78
79    // helper
80    char *pidToName(pid_t pid) { return stats.pidToName(pid); }
81    uid_t pidToUid(pid_t pid) { return stats.pidToUid(pid); }
82
83private:
84    void maybePrune(log_id_t id);
85    void prune(log_id_t id, unsigned long pruneRows, uid_t uid = AID_ROOT);
86
87};
88
89#endif // _LOGD_LOG_BUFFER_H__
90