855c7c87a3
ChattyLogBuffer::FlushTo() needs an array of pid_t's to differentiate between deduplication and spam removal chatty messages, but that won't be useful to other log buffers, so it doesn't deserve its own entry in the abstruct LogBuffer::FlushTo() function. Other log buffers may need their own data stored for each reader, so we create an interface that the reader itself owns and passes to the log buffer. It uses a unique_ptr, such that the when the reader is destroyed, so will this state. FlushToState will additionally contain the start point, that it will increment itself and the log mask, which LogBuffers can use to efficiently keep track of the next elements that will be read during a call to FlushTo(). Side benefit: this allows ChattyLogBufferTests to correctly report 'identical' instead of 'expired' lines the deduplication tests. Side benefit #2: This updates LogReaderThread::start() more aggressively, which should result in readers being disconnected less often, particularly readers who read only a certain UID. Test: logging unit tests Change-Id: I969565eb2996afb1431f20e7ccaaa906fcb8f6d1
111 lines
4.4 KiB
C++
111 lines
4.4 KiB
C++
/*
|
|
* Copyright (C) 2012-2013 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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <pthread.h>
|
|
#include <sys/socket.h>
|
|
#include <sys/types.h>
|
|
#include <time.h>
|
|
|
|
#include <chrono>
|
|
#include <condition_variable>
|
|
#include <list>
|
|
#include <memory>
|
|
|
|
#include <log/log.h>
|
|
#include <sysutils/SocketClient.h>
|
|
|
|
#include "LogBuffer.h"
|
|
#include "LogWriter.h"
|
|
|
|
class LogReaderList;
|
|
|
|
class LogReaderThread {
|
|
public:
|
|
LogReaderThread(LogBuffer* log_buffer, LogReaderList* reader_list,
|
|
std::unique_ptr<LogWriter> writer, bool non_block, unsigned long tail,
|
|
LogMask log_mask, pid_t pid, log_time start_time, uint64_t sequence,
|
|
std::chrono::steady_clock::time_point deadline);
|
|
void triggerReader_Locked() { thread_triggered_condition_.notify_all(); }
|
|
|
|
void triggerSkip_Locked(log_id_t id, unsigned int skip) { skip_ahead_[id] = skip; }
|
|
void cleanSkip_Locked();
|
|
|
|
void release_Locked() {
|
|
// gracefully shut down the socket.
|
|
writer_->Shutdown();
|
|
release_ = true;
|
|
thread_triggered_condition_.notify_all();
|
|
}
|
|
|
|
bool IsWatching(log_id_t id) const { return flush_to_state_->log_mask() & (1 << id); }
|
|
bool IsWatchingMultiple(LogMask log_mask) const {
|
|
return flush_to_state_->log_mask() & log_mask;
|
|
}
|
|
|
|
std::string name() const { return writer_->name(); }
|
|
uint64_t start() const { return flush_to_state_->start(); }
|
|
std::chrono::steady_clock::time_point deadline() const { return deadline_; }
|
|
|
|
private:
|
|
void ThreadFunction();
|
|
// flushTo filter callbacks
|
|
FilterResult FilterFirstPass(log_id_t log_id, pid_t pid, uint64_t sequence, log_time realtime,
|
|
uint16_t dropped_count);
|
|
FilterResult FilterSecondPass(log_id_t log_id, pid_t pid, uint64_t sequence, log_time realtime,
|
|
uint16_t dropped_count);
|
|
|
|
std::condition_variable thread_triggered_condition_;
|
|
LogBuffer* log_buffer_;
|
|
LogReaderList* reader_list_;
|
|
std::unique_ptr<LogWriter> writer_;
|
|
|
|
// Set to true to cause the thread to end and the LogReaderThread to delete itself.
|
|
bool release_ = false;
|
|
// Indicates whether or not 'leading' (first logs seen starting from start_) 'dropped' (chatty)
|
|
// messages should be ignored.
|
|
bool leading_dropped_;
|
|
|
|
// If set to non-zero, only pids equal to this are read by the reader.
|
|
const pid_t pid_;
|
|
// When a reader is referencing (via start_) old elements in the log buffer, and the log
|
|
// buffer's size grows past its memory limit, the log buffer may request the reader to skip
|
|
// ahead a specified number of logs.
|
|
unsigned int skip_ahead_[LOG_ID_MAX];
|
|
// LogBuffer::FlushTo() needs to store state across subsequent calls.
|
|
std::unique_ptr<FlushToState> flush_to_state_;
|
|
|
|
// These next three variables are used for reading only the most recent lines aka `adb logcat
|
|
// -t` / `adb logcat -T`.
|
|
// tail_ is the number of most recent lines to print.
|
|
unsigned long tail_;
|
|
// count_ is the result of a first pass through the log buffer to determine how many total
|
|
// messages there are.
|
|
unsigned long count_;
|
|
// index_ is used along with count_ to only start sending lines once index_ > (count_ - tail_)
|
|
// and to disconnect the reader (if it is dumpAndClose, `adb logcat -t`), when index_ >= count_.
|
|
unsigned long index_;
|
|
|
|
// When a reader requests logs starting from a given timestamp, its stored here for the first
|
|
// pass, such that logs before this time stamp that are accumulated in the buffer are ignored.
|
|
log_time start_time_;
|
|
// CLOCK_MONOTONIC based deadline used for log wrapping. If this deadline expires before logs
|
|
// wrap, then wake up and send the logs to the reader anyway.
|
|
std::chrono::steady_clock::time_point deadline_;
|
|
// If this reader is 'dumpAndClose' and will disconnect once it has read its intended logs.
|
|
const bool non_block_;
|
|
};
|