Steve Block | a7e24c1 | 2009-10-30 11:49:00 +0000 | [diff] [blame^] | 1 | // Copyright 2006-2008 the V8 project authors. All rights reserved. |
| 2 | // Redistribution and use in source and binary forms, with or without |
| 3 | // modification, are permitted provided that the following conditions are |
| 4 | // met: |
| 5 | // |
| 6 | // * Redistributions of source code must retain the above copyright |
| 7 | // notice, this list of conditions and the following disclaimer. |
| 8 | // * Redistributions in binary form must reproduce the above |
| 9 | // copyright notice, this list of conditions and the following |
| 10 | // disclaimer in the documentation and/or other materials provided |
| 11 | // with the distribution. |
| 12 | // * Neither the name of Google Inc. nor the names of its |
| 13 | // contributors may be used to endorse or promote products derived |
| 14 | // from this software without specific prior written permission. |
| 15 | // |
| 16 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 17 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 18 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 19 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 20 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 21 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 22 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 23 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 24 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 25 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 26 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | |
| 28 | #ifndef V8_LOG_H_ |
| 29 | #define V8_LOG_H_ |
| 30 | |
| 31 | #include "platform.h" |
| 32 | #include "log-utils.h" |
| 33 | |
| 34 | namespace v8 { |
| 35 | namespace internal { |
| 36 | |
| 37 | // Logger is used for collecting logging information from V8 during |
| 38 | // execution. The result is dumped to a file. |
| 39 | // |
| 40 | // Available command line flags: |
| 41 | // |
| 42 | // --log |
| 43 | // Minimal logging (no API, code, or GC sample events), default is off. |
| 44 | // |
| 45 | // --log-all |
| 46 | // Log all events to the file, default is off. This is the same as combining |
| 47 | // --log-api, --log-code, --log-gc, and --log-regexp. |
| 48 | // |
| 49 | // --log-api |
| 50 | // Log API events to the logfile, default is off. --log-api implies --log. |
| 51 | // |
| 52 | // --log-code |
| 53 | // Log code (create, move, and delete) events to the logfile, default is off. |
| 54 | // --log-code implies --log. |
| 55 | // |
| 56 | // --log-gc |
| 57 | // Log GC heap samples after each GC that can be processed by hp2ps, default |
| 58 | // is off. --log-gc implies --log. |
| 59 | // |
| 60 | // --log-regexp |
| 61 | // Log creation and use of regular expressions, Default is off. |
| 62 | // --log-regexp implies --log. |
| 63 | // |
| 64 | // --logfile <filename> |
| 65 | // Specify the name of the logfile, default is "v8.log". |
| 66 | // |
| 67 | // --prof |
| 68 | // Collect statistical profiling information (ticks), default is off. The |
| 69 | // tick profiler requires code events, so --prof implies --log-code. |
| 70 | |
| 71 | // Forward declarations. |
| 72 | class Ticker; |
| 73 | class Profiler; |
| 74 | class Semaphore; |
| 75 | class SlidingStateWindow; |
| 76 | class LogMessageBuilder; |
| 77 | class CompressionHelper; |
| 78 | |
| 79 | #undef LOG |
| 80 | #ifdef ENABLE_LOGGING_AND_PROFILING |
| 81 | #define LOG(Call) \ |
| 82 | do { \ |
| 83 | if (v8::internal::Logger::is_logging()) \ |
| 84 | v8::internal::Logger::Call; \ |
| 85 | } while (false) |
| 86 | #else |
| 87 | #define LOG(Call) ((void) 0) |
| 88 | #endif |
| 89 | |
| 90 | |
| 91 | class VMState BASE_EMBEDDED { |
| 92 | #ifdef ENABLE_LOGGING_AND_PROFILING |
| 93 | public: |
| 94 | inline explicit VMState(StateTag state); |
| 95 | inline ~VMState(); |
| 96 | |
| 97 | StateTag state() { return state_; } |
| 98 | |
| 99 | private: |
| 100 | bool disabled_; |
| 101 | StateTag state_; |
| 102 | VMState* previous_; |
| 103 | #else |
| 104 | public: |
| 105 | explicit VMState(StateTag state) {} |
| 106 | #endif |
| 107 | }; |
| 108 | |
| 109 | |
| 110 | #define LOG_EVENTS_AND_TAGS_LIST(V) \ |
| 111 | V(CODE_CREATION_EVENT, "code-creation", "cc") \ |
| 112 | V(CODE_MOVE_EVENT, "code-move", "cm") \ |
| 113 | V(CODE_DELETE_EVENT, "code-delete", "cd") \ |
| 114 | V(TICK_EVENT, "tick", "t") \ |
| 115 | V(REPEAT_META_EVENT, "repeat", "r") \ |
| 116 | V(BUILTIN_TAG, "Builtin", "bi") \ |
| 117 | V(CALL_DEBUG_BREAK_TAG, "CallDebugBreak", "cdb") \ |
| 118 | V(CALL_DEBUG_PREPARE_STEP_IN_TAG, "CallDebugPrepareStepIn", "cdbsi") \ |
| 119 | V(CALL_IC_TAG, "CallIC", "cic") \ |
| 120 | V(CALL_INITIALIZE_TAG, "CallInitialize", "ci") \ |
| 121 | V(CALL_MEGAMORPHIC_TAG, "CallMegamorphic", "cmm") \ |
| 122 | V(CALL_MISS_TAG, "CallMiss", "cm") \ |
| 123 | V(CALL_NORMAL_TAG, "CallNormal", "cn") \ |
| 124 | V(CALL_PRE_MONOMORPHIC_TAG, "CallPreMonomorphic", "cpm") \ |
| 125 | V(EVAL_TAG, "Eval", "e") \ |
| 126 | V(FUNCTION_TAG, "Function", "f") \ |
| 127 | V(KEYED_LOAD_IC_TAG, "KeyedLoadIC", "klic") \ |
| 128 | V(KEYED_STORE_IC_TAG, "KeyedStoreIC", "ksic") \ |
| 129 | V(LAZY_COMPILE_TAG, "LazyCompile", "lc") \ |
| 130 | V(LOAD_IC_TAG, "LoadIC", "lic") \ |
| 131 | V(REG_EXP_TAG, "RegExp", "re") \ |
| 132 | V(SCRIPT_TAG, "Script", "sc") \ |
| 133 | V(STORE_IC_TAG, "StoreIC", "sic") \ |
| 134 | V(STUB_TAG, "Stub", "s") |
| 135 | |
| 136 | class Logger { |
| 137 | public: |
| 138 | #define DECLARE_ENUM(enum_item, ignore1, ignore2) enum_item, |
| 139 | enum LogEventsAndTags { |
| 140 | LOG_EVENTS_AND_TAGS_LIST(DECLARE_ENUM) |
| 141 | NUMBER_OF_LOG_EVENTS |
| 142 | }; |
| 143 | #undef DECLARE_ENUM |
| 144 | |
| 145 | // Acquires resources for logging if the right flags are set. |
| 146 | static bool Setup(); |
| 147 | |
| 148 | // Frees resources acquired in Setup. |
| 149 | static void TearDown(); |
| 150 | |
| 151 | // Enable the computation of a sliding window of states. |
| 152 | static void EnableSlidingStateWindow(); |
| 153 | |
| 154 | // Write a raw string to the log to be used as a preamble. |
| 155 | // No check is made that the 'preamble' is actually at the beginning |
| 156 | // of the log. The preample is used to write code events saved in the |
| 157 | // snapshot. |
| 158 | static void Preamble(const char* content); |
| 159 | |
| 160 | // Emits an event with a string value -> (name, value). |
| 161 | static void StringEvent(const char* name, const char* value); |
| 162 | |
| 163 | // Emits an event with an int value -> (name, value). |
| 164 | static void IntEvent(const char* name, int value); |
| 165 | |
| 166 | // Emits an event with an handle value -> (name, location). |
| 167 | static void HandleEvent(const char* name, Object** location); |
| 168 | |
| 169 | // Emits memory management events for C allocated structures. |
| 170 | static void NewEvent(const char* name, void* object, size_t size); |
| 171 | static void DeleteEvent(const char* name, void* object); |
| 172 | |
| 173 | // Emits an event with a tag, and some resource usage information. |
| 174 | // -> (name, tag, <rusage information>). |
| 175 | // Currently, the resource usage information is a process time stamp |
| 176 | // and a real time timestamp. |
| 177 | static void ResourceEvent(const char* name, const char* tag); |
| 178 | |
| 179 | // Emits an event that an undefined property was read from an |
| 180 | // object. |
| 181 | static void SuspectReadEvent(String* name, Object* obj); |
| 182 | |
| 183 | // Emits an event when a message is put on or read from a debugging queue. |
| 184 | // DebugTag lets us put a call-site specific label on the event. |
| 185 | static void DebugTag(const char* call_site_tag); |
| 186 | static void DebugEvent(const char* event_type, Vector<uint16_t> parameter); |
| 187 | |
| 188 | |
| 189 | // ==== Events logged by --log-api. ==== |
| 190 | static void ApiNamedSecurityCheck(Object* key); |
| 191 | static void ApiIndexedSecurityCheck(uint32_t index); |
| 192 | static void ApiNamedPropertyAccess(const char* tag, |
| 193 | JSObject* holder, |
| 194 | Object* name); |
| 195 | static void ApiIndexedPropertyAccess(const char* tag, |
| 196 | JSObject* holder, |
| 197 | uint32_t index); |
| 198 | static void ApiObjectAccess(const char* tag, JSObject* obj); |
| 199 | static void ApiEntryCall(const char* name); |
| 200 | |
| 201 | |
| 202 | // ==== Events logged by --log-code. ==== |
| 203 | // Emits a code create event. |
| 204 | static void CodeCreateEvent(LogEventsAndTags tag, |
| 205 | Code* code, const char* source); |
| 206 | static void CodeCreateEvent(LogEventsAndTags tag, Code* code, String* name); |
| 207 | static void CodeCreateEvent(LogEventsAndTags tag, Code* code, String* name, |
| 208 | String* source, int line); |
| 209 | static void CodeCreateEvent(LogEventsAndTags tag, Code* code, int args_count); |
| 210 | // Emits a code create event for a RegExp. |
| 211 | static void RegExpCodeCreateEvent(Code* code, String* source); |
| 212 | // Emits a code move event. |
| 213 | static void CodeMoveEvent(Address from, Address to); |
| 214 | // Emits a code delete event. |
| 215 | static void CodeDeleteEvent(Address from); |
| 216 | |
| 217 | // ==== Events logged by --log-gc. ==== |
| 218 | // Heap sampling events: start, end, and individual types. |
| 219 | static void HeapSampleBeginEvent(const char* space, const char* kind); |
| 220 | static void HeapSampleEndEvent(const char* space, const char* kind); |
| 221 | static void HeapSampleItemEvent(const char* type, int number, int bytes); |
| 222 | static void HeapSampleJSConstructorEvent(const char* constructor, |
| 223 | int number, int bytes); |
| 224 | static void HeapSampleJSRetainersEvent(const char* constructor, |
| 225 | const char* event); |
| 226 | static void HeapSampleStats(const char* space, const char* kind, |
| 227 | int capacity, int used); |
| 228 | |
| 229 | static void SharedLibraryEvent(const char* library_path, |
| 230 | uintptr_t start, |
| 231 | uintptr_t end); |
| 232 | static void SharedLibraryEvent(const wchar_t* library_path, |
| 233 | uintptr_t start, |
| 234 | uintptr_t end); |
| 235 | |
| 236 | // ==== Events logged by --log-regexp ==== |
| 237 | // Regexp compilation and execution events. |
| 238 | |
| 239 | static void RegExpCompileEvent(Handle<JSRegExp> regexp, bool in_cache); |
| 240 | |
| 241 | // Log an event reported from generated code |
| 242 | static void LogRuntime(Vector<const char> format, JSArray* args); |
| 243 | |
| 244 | #ifdef ENABLE_LOGGING_AND_PROFILING |
| 245 | static StateTag state() { |
| 246 | return current_state_ ? current_state_->state() : OTHER; |
| 247 | } |
| 248 | |
| 249 | static bool is_logging() { |
| 250 | return is_logging_; |
| 251 | } |
| 252 | |
| 253 | // Pause/Resume collection of profiling data. |
| 254 | // When data collection is paused, CPU Tick events are discarded until |
| 255 | // data collection is Resumed. |
| 256 | static void PauseProfiler(int flags); |
| 257 | static void ResumeProfiler(int flags); |
| 258 | static int GetActiveProfilerModules(); |
| 259 | |
| 260 | // If logging is performed into a memory buffer, allows to |
| 261 | // retrieve previously written messages. See v8.h. |
| 262 | static int GetLogLines(int from_pos, char* dest_buf, int max_size); |
| 263 | |
| 264 | // Logs all compiled functions found in the heap. |
| 265 | static void LogCompiledFunctions(); |
| 266 | |
| 267 | private: |
| 268 | |
| 269 | // Profiler's sampling interval (in milliseconds). |
| 270 | static const int kSamplingIntervalMs = 1; |
| 271 | |
| 272 | // Size of window used for log records compression. |
| 273 | static const int kCompressionWindowSize = 4; |
| 274 | |
| 275 | // Emits the profiler's first message. |
| 276 | static void ProfilerBeginEvent(); |
| 277 | |
| 278 | // Emits aliases for compressed messages. |
| 279 | static void LogAliases(); |
| 280 | |
| 281 | // Emits the source code of a regexp. Used by regexp events. |
| 282 | static void LogRegExpSource(Handle<JSRegExp> regexp); |
| 283 | |
| 284 | // Emits a profiler tick event. Used by the profiler thread. |
| 285 | static void TickEvent(TickSample* sample, bool overflow); |
| 286 | |
| 287 | static void ApiEvent(const char* name, ...); |
| 288 | |
| 289 | // Logs a StringEvent regardless of whether FLAG_log is true. |
| 290 | static void UncheckedStringEvent(const char* name, const char* value); |
| 291 | |
| 292 | // Stops logging and profiling in case of insufficient resources. |
| 293 | static void StopLoggingAndProfiling(); |
| 294 | |
| 295 | // Returns whether profiler's sampler is active. |
| 296 | static bool IsProfilerSamplerActive(); |
| 297 | |
| 298 | // The sampler used by the profiler and the sliding state window. |
| 299 | static Ticker* ticker_; |
| 300 | |
| 301 | // When the statistical profile is active, profiler_ |
| 302 | // points to a Profiler, that handles collection |
| 303 | // of samples. |
| 304 | static Profiler* profiler_; |
| 305 | |
| 306 | // A stack of VM states. |
| 307 | static VMState* current_state_; |
| 308 | |
| 309 | // Singleton bottom or default vm state. |
| 310 | static VMState bottom_state_; |
| 311 | |
| 312 | // SlidingStateWindow instance keeping a sliding window of the most |
| 313 | // recent VM states. |
| 314 | static SlidingStateWindow* sliding_state_window_; |
| 315 | |
| 316 | // An array of log events names. |
| 317 | static const char** log_events_; |
| 318 | |
| 319 | // An instance of helper created if log compression is enabled. |
| 320 | static CompressionHelper* compression_helper_; |
| 321 | |
| 322 | // Internal implementation classes with access to |
| 323 | // private members. |
| 324 | friend class CompressionHelper; |
| 325 | friend class EventLog; |
| 326 | friend class TimeLog; |
| 327 | friend class Profiler; |
| 328 | friend class SlidingStateWindow; |
| 329 | friend class VMState; |
| 330 | |
| 331 | friend class LoggerTestHelper; |
| 332 | |
| 333 | static bool is_logging_; |
| 334 | #else |
| 335 | static bool is_logging() { return false; } |
| 336 | #endif |
| 337 | }; |
| 338 | |
| 339 | |
| 340 | // Class that extracts stack trace, used for profiling. |
| 341 | class StackTracer : public AllStatic { |
| 342 | public: |
| 343 | static void Trace(TickSample* sample); |
| 344 | }; |
| 345 | |
| 346 | |
| 347 | } } // namespace v8::internal |
| 348 | |
| 349 | #endif // V8_LOG_H_ |