Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | */ |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 16 | |
| 17 | #ifndef ART_SRC_TRACE_H_ |
| 18 | #define ART_SRC_TRACE_H_ |
| 19 | |
| 20 | #include <map> |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 21 | #include <ostream> |
| 22 | #include <set> |
| 23 | #include <string> |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 24 | |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 25 | #include "file.h" |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 26 | #include "globals.h" |
| 27 | #include "macros.h" |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 28 | #include "UniquePtr.h" |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 29 | |
| 30 | namespace art { |
| 31 | |
| 32 | class Method; |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 33 | class Thread; |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 34 | |
| 35 | struct TraceStackFrame { |
| 36 | TraceStackFrame(Method* method, uintptr_t return_pc) |
| 37 | : method_(method), return_pc_(return_pc) { |
| 38 | } |
| 39 | |
| 40 | Method* method_; |
| 41 | uintptr_t return_pc_; |
| 42 | }; |
| 43 | |
| 44 | class Trace { |
| 45 | public: |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 46 | |
| 47 | enum TraceEvent { |
| 48 | kMethodTraceEnter = 0, |
| 49 | kMethodTraceExit = 1, |
| 50 | kMethodTraceUnwind = 2, |
| 51 | }; |
| 52 | |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 53 | static void Start(const char* trace_filename, int trace_fd, int buffer_size, int flags, bool direct_to_ddms); |
| 54 | static void Stop(); |
| 55 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 56 | void LogMethodTraceEvent(Thread* self, const Method* method, TraceEvent event); |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 57 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 58 | void AddSavedCodeToMap(const Method* method, const void* code); |
| 59 | void RemoveSavedCodeFromMap(const Method* method); |
| 60 | const void* GetSavedCodeFromMap(const Method* method); |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 61 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 62 | void SaveAndUpdateCode(Method* method, const void* new_code); |
| 63 | void ResetSavedCode(Method* method); |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 64 | |
| 65 | private: |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 66 | explicit Trace(File* trace_file, int buffer_size) |
| 67 | : trace_file_(trace_file), buf_(new uint8_t[buffer_size]()), overflow_(false), buffer_size_(buffer_size), |
| 68 | start_time_(0), trace_version_(0), record_size_(0), cur_offset_(0) { |
| 69 | } |
| 70 | |
| 71 | void BeginTracing(); |
| 72 | void FinishTracing(); |
| 73 | |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 74 | // Replaces code of each method with a pointer to a stub for method tracing. |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 75 | void InstallStubs(); |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 76 | |
| 77 | // Restores original code for each method and fixes the return values of each thread's stack. |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 78 | void UninstallStubs(); |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 79 | |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 80 | // Methods to output traced methods and threads. |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 81 | void GetVisitedMethods(size_t end_offset); |
| 82 | void DumpMethodList(std::ostream& os); |
| 83 | void DumpThreadList(std::ostream& os); |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 84 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 85 | // Maps a method to its original code pointer. |
| 86 | std::map<const Method*, const void*> saved_code_map_; |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 87 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 88 | // Set of methods visited by the profiler. |
| 89 | std::set<const Method*> visited_methods_; |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 90 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 91 | // Maps a thread to its clock base. |
| 92 | std::map<Thread*, uint64_t> thread_clock_base_map_; |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 93 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 94 | // File to write trace data out to, NULL if direct to ddms. |
| 95 | UniquePtr<File> trace_file_; |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 96 | |
jeffhao | 2692b57 | 2011-12-16 15:42:28 -0800 | [diff] [blame] | 97 | // Buffer to store trace data. |
| 98 | UniquePtr<uint8_t> buf_; |
| 99 | |
| 100 | bool overflow_; |
| 101 | int buffer_size_; |
| 102 | uint64_t start_time_; |
| 103 | uint16_t trace_version_; |
| 104 | uint16_t record_size_; |
| 105 | |
| 106 | volatile int32_t cur_offset_; |
jeffhao | a9ef3fd | 2011-12-13 18:33:43 -0800 | [diff] [blame] | 107 | |
jeffhao | e343b76 | 2011-12-05 16:36:44 -0800 | [diff] [blame] | 108 | DISALLOW_COPY_AND_ASSIGN(Trace); |
| 109 | }; |
| 110 | |
| 111 | } // namespace art |
| 112 | |
| 113 | #endif // ART_SRC_TRACE_H_ |