1b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org/* 2b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved. 3b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * 4b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * Use of this source code is governed by a BSD-style license 5b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * that can be found in the LICENSE file in the root of the source 6b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * tree. An additional intellectual property rights grant can be found 7b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * in the file PATENTS. All contributing project authors may 8b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org * be found in the AUTHORS file in the root of the source tree. 9b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org */ 10b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 11b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#ifndef WEBRTC_SYSTEM_WRAPPERS_SOURCE_TRACE_IMPL_H_ 12b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#define WEBRTC_SYSTEM_WRAPPERS_SOURCE_TRACE_IMPL_H_ 13b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 147824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/critical_section_wrapper.h" 157824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/event_wrapper.h" 167824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/file_wrapper.h" 177824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/static_instance.h" 187824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/thread_wrapper.h" 197824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#include "webrtc/system_wrappers/interface/trace.h" 20b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 21b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.orgnamespace webrtc { 22b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 237824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org// TODO(pwestin) WEBRTC_TRACE_MAX_QUEUE needs to be tweaked 247824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org// TODO(hellner) the buffer should be close to how much the system can write to 257824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org// file. Increasing the buffer will not solve anything. Sooner or 267824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org// later the buffer is going to fill up anyways. 27b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#if defined(WEBRTC_IOS) 287824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#define WEBRTC_TRACE_MAX_QUEUE 2000 29b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#else 307824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#define WEBRTC_TRACE_MAX_QUEUE 8000 31b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#endif 32b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#define WEBRTC_TRACE_NUM_ARRAY 2 33b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#define WEBRTC_TRACE_MAX_MESSAGE_SIZE 256 34b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// Total buffer size is WEBRTC_TRACE_NUM_ARRAY (number of buffer partitions) * 35b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// WEBRTC_TRACE_MAX_QUEUE (number of lines per buffer partition) * 36b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// WEBRTC_TRACE_MAX_MESSAGE_SIZE (number of 1 byte charachters per line) = 377824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org// 1 or 4 Mbyte. 38b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 39b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org#define WEBRTC_TRACE_MAX_FILE_SIZE 100*1000 40b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// Number of rows that may be written to file. On average 110 bytes per row (max 41b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// 256 bytes per row). So on average 110*100*1000 = 11 Mbyte, max 256*100*1000 = 42b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org// 25.6 Mbyte 43b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 447824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.orgclass TraceImpl : public Trace { 457824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org public: 467824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org virtual ~TraceImpl(); 47b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 487824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org static TraceImpl* CreateInstance(); 497824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org static TraceImpl* GetTrace(const TraceLevel level = kTraceAll); 50b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 51c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t SetTraceFileImpl(const char* file_name, const bool add_file_counter); 52c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t TraceFileImpl(char file_name[FileWrapper::kMaxFileNameSize]); 53b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 54c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t SetTraceCallbackImpl(TraceCallback* callback); 55b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 567824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org void AddImpl(const TraceLevel level, const TraceModule module, 57c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const int32_t id, const char* msg); 58b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 597824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org bool StopThread(); 60b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 617824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org bool TraceCheck(const TraceLevel level) const; 62b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 637824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org protected: 647824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org TraceImpl(); 65b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 667824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org static TraceImpl* StaticInstance(CountOperation count_operation, 677824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org const TraceLevel level = kTraceAll); 68b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 69c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t AddThreadId(char* trace_message) const; 70b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 717824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org // OS specific implementations. 72c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org virtual int32_t AddTime(char* trace_message, 73c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const TraceLevel level) const = 0; 74b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 75c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org virtual int32_t AddBuildInfo(char* trace_message) const = 0; 76c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org virtual int32_t AddDateTimeInfo(char* trace_message) const = 0; 77b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 787824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org static bool Run(void* obj); 797824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org bool Process(); 80b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 817824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org private: 827824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org friend class Trace; 83b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 84c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t AddLevel(char* sz_message, const TraceLevel level) const; 85b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 86c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t AddModuleAndId(char* trace_message, const TraceModule module, 87c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const int32_t id) const; 88b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 89c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org int32_t AddMessage(char* trace_message, 90c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const char msg[WEBRTC_TRACE_MAX_MESSAGE_SIZE], 91c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const uint16_t written_so_far) const; 92b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 937824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org void AddMessageToList( 947824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org const char trace_message[WEBRTC_TRACE_MAX_MESSAGE_SIZE], 95c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const uint16_t length, 967824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org const TraceLevel level); 97b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 987824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org bool UpdateFileName( 997824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org const char file_name_utf8[FileWrapper::kMaxFileNameSize], 1007824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org char file_name_with_counter_utf8[FileWrapper::kMaxFileNameSize], 101c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const uint32_t new_count) const; 102b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1037824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org bool CreateFileName( 1047824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org const char file_name_utf8[FileWrapper::kMaxFileNameSize], 1057824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org char file_name_with_counter_utf8[FileWrapper::kMaxFileNameSize], 106c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org const uint32_t new_count) const; 107b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1087824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org void WriteToFile(); 109b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1107824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org CriticalSectionWrapper* critsect_interface_; 1117824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org TraceCallback* callback_; 112c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org uint32_t row_count_text_; 113c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org uint32_t file_count_text_; 114b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1157824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org FileWrapper& trace_file_; 1167824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org ThreadWrapper& thread_; 1177824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org EventWrapper& event_; 118b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1197824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org // critsect_array_ protects active_queue_. 1207824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org CriticalSectionWrapper* critsect_array_; 121c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org uint16_t next_free_idx_[WEBRTC_TRACE_NUM_ARRAY]; 1227824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org TraceLevel level_[WEBRTC_TRACE_NUM_ARRAY][WEBRTC_TRACE_MAX_QUEUE]; 123c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org uint16_t length_[WEBRTC_TRACE_NUM_ARRAY][WEBRTC_TRACE_MAX_QUEUE]; 1247824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org char* message_queue_[WEBRTC_TRACE_NUM_ARRAY][WEBRTC_TRACE_MAX_QUEUE]; 125c0231afbbf1d7bac40b77da5933715dc63c88144pbos@webrtc.org uint8_t active_queue_; 126b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org}; 127b015cbede88899f67a53fbbe581b02ce8e32794andrew@webrtc.org 1287824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org} // namespace webrtc 1297824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org 1307824ff1bacbd3be5af8088fc7d81c33fe0647f36phoglund@webrtc.org#endif // WEBRTC_SYSTEM_WRAPPERS_SOURCE_TRACE_IMPL_H_ 131