Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 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 SRC_PROFILING_MEMORY_CLIENT_H_ |
| 18 | #define SRC_PROFILING_MEMORY_CLIENT_H_ |
| 19 | |
| 20 | #include <stddef.h> |
Florian Mayer | af26602 | 2018-09-17 15:18:15 +0100 | [diff] [blame] | 21 | |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 22 | #include <atomic> |
Florian Mayer | eff9804 | 2018-12-10 17:44:44 +0000 | [diff] [blame] | 23 | #include <condition_variable> |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 24 | #include <mutex> |
| 25 | #include <vector> |
| 26 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 27 | #include "perfetto/base/unix_socket.h" |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 28 | #include "src/profiling/memory/sampler.h" |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 29 | #include "src/profiling/memory/wire_protocol.h" |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 30 | |
| 31 | namespace perfetto { |
Florian Mayer | 8c0d048 | 2018-10-22 14:23:40 +0100 | [diff] [blame] | 32 | namespace profiling { |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 33 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 34 | class BorrowedSocket; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 35 | |
| 36 | class SocketPool { |
| 37 | public: |
| 38 | friend class BorrowedSocket; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 39 | SocketPool(std::vector<base::UnixSocketRaw> sockets); |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 40 | |
| 41 | BorrowedSocket Borrow(); |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 42 | void Shutdown(); |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 43 | |
| 44 | private: |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 45 | bool shutdown_ = false; |
| 46 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 47 | void Return(base::UnixSocketRaw); |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 48 | std::timed_mutex mutex_; |
| 49 | std::condition_variable_any cv_; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 50 | std::vector<base::UnixSocketRaw> sockets_; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 51 | size_t available_sockets_; |
Florian Mayer | af26602 | 2018-09-17 15:18:15 +0100 | [diff] [blame] | 52 | size_t dead_sockets_ = 0; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 53 | }; |
| 54 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 55 | // Socket borrowed from a SocketPool. Gets returned once it goes out of scope. |
| 56 | class BorrowedSocket { |
| 57 | public: |
| 58 | BorrowedSocket(const BorrowedSocket&) = delete; |
| 59 | BorrowedSocket& operator=(const BorrowedSocket&) = delete; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 60 | BorrowedSocket(BorrowedSocket&& other) noexcept |
| 61 | : sock_(std::move(other.sock_)), socket_pool_(other.socket_pool_) { |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 62 | other.socket_pool_ = nullptr; |
| 63 | } |
| 64 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 65 | BorrowedSocket(base::UnixSocketRaw sock, SocketPool* socket_pool) |
| 66 | : sock_(std::move(sock)), socket_pool_(socket_pool) {} |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 67 | |
| 68 | ~BorrowedSocket() { |
| 69 | if (socket_pool_ != nullptr) |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 70 | socket_pool_->Return(std::move(sock_)); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 71 | } |
| 72 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 73 | base::UnixSocketRaw* operator->() { return &sock_; } |
| 74 | base::UnixSocketRaw* get() { return &sock_; } |
| 75 | void Shutdown() { sock_.Shutdown(); } |
| 76 | explicit operator bool() const { return !!sock_; } |
Florian Mayer | f1510c4 | 2018-10-17 11:40:52 +0100 | [diff] [blame] | 77 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 78 | private: |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 79 | base::UnixSocketRaw sock_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 80 | SocketPool* socket_pool_ = nullptr; |
| 81 | }; |
| 82 | |
| 83 | // Cache for frees that have been observed. It is infeasible to send every |
| 84 | // free separately, so we batch and send the whole buffer once it is full. |
| 85 | class FreePage { |
| 86 | public: |
Florian Mayer | 192136e | 2019-01-30 18:04:34 +0000 | [diff] [blame] | 87 | FreePage(uint64_t client_generation) { |
| 88 | free_page_.client_generation = client_generation; |
| 89 | } |
| 90 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 91 | // Add address to buffer. Flush if necessary using a socket borrowed from |
| 92 | // pool. |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 93 | // Can be called from any thread. Must not hold mutex_. |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 94 | bool Add(const uint64_t addr, uint64_t sequence_number, SocketPool* pool); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 95 | |
| 96 | private: |
| 97 | // Needs to be called holding mutex_. |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 98 | bool FlushLocked(SocketPool* pool); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 99 | |
| 100 | FreeMetadata free_page_; |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 101 | std::timed_mutex mutex_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 102 | size_t offset_ = 0; |
| 103 | }; |
| 104 | |
| 105 | const char* GetThreadStackBase(); |
| 106 | |
Florian Mayer | dac3127 | 2019-02-26 12:07:02 +0000 | [diff] [blame] | 107 | constexpr uint32_t kClientSockTimeoutMs = 1000; |
Ryan Savitski | 14c12d6 | 2019-01-08 22:38:53 +0000 | [diff] [blame] | 108 | |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 109 | // Profiling client, used to sample and record the malloc/free family of calls, |
| 110 | // and communicate the necessary state to a separate profiling daemon process. |
| 111 | // |
| 112 | // Created and owned by the malloc hooks. |
| 113 | // |
| 114 | // Methods of this class are thread-safe unless otherwise stated, in which case |
| 115 | // the caller needs to synchronize calls behind a mutex or similar. |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 116 | class Client { |
| 117 | public: |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 118 | Client(std::vector<base::UnixSocketRaw> sockets); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 119 | Client(const std::string& sock_name, size_t conns); |
Florian Mayer | 20c4b3c | 2019-01-24 18:25:35 +0000 | [diff] [blame] | 120 | bool RecordMalloc(uint64_t alloc_size, |
Florian Mayer | 9a7fb2b | 2018-10-17 18:17:40 +0100 | [diff] [blame] | 121 | uint64_t total_size, |
| 122 | uint64_t alloc_address); |
Florian Mayer | 20c4b3c | 2019-01-24 18:25:35 +0000 | [diff] [blame] | 123 | bool RecordFree(uint64_t alloc_address); |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 124 | void Shutdown(); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 125 | |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 126 | // Returns the number of bytes to assign to an allocation with the given |
| 127 | // |alloc_size|, based on the current sampling rate. A return value of zero |
| 128 | // means that the allocation should not be recorded. Not idempotent, each |
| 129 | // invocation mutates the sampler state. |
| 130 | // |
| 131 | // Not thread-safe. |
| 132 | size_t GetSampleSizeLocked(size_t alloc_size) { |
| 133 | if (!inited_.load(std::memory_order_acquire)) |
| 134 | return 0; |
| 135 | return sampler_.SampleSize(alloc_size); |
| 136 | } |
| 137 | |
Florian Mayer | 1fe7773 | 2018-10-02 17:25:53 +0100 | [diff] [blame] | 138 | ClientConfiguration client_config_for_testing() { return client_config_; } |
Florian Mayer | b12c4f2 | 2018-11-14 16:13:02 +0000 | [diff] [blame] | 139 | bool inited() { return inited_; } |
Florian Mayer | 1fe7773 | 2018-10-02 17:25:53 +0100 | [diff] [blame] | 140 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 141 | private: |
| 142 | const char* GetStackBase(); |
| 143 | |
Florian Mayer | 192136e | 2019-01-30 18:04:34 +0000 | [diff] [blame] | 144 | static std::atomic<uint64_t> max_generation_; |
| 145 | const uint64_t generation_; |
| 146 | |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 147 | // TODO(rsavitski): used to check if the client is completely initialized |
| 148 | // after construction. The reads in RecordFree & GetSampleSizeLocked are no |
| 149 | // longer necessary (was an optimization to not do redundant work after |
| 150 | // shutdown). Turn into a normal bool, or indicate construction failures |
| 151 | // differently. |
Florian Mayer | f086799 | 2018-11-16 10:12:18 +0000 | [diff] [blame] | 152 | std::atomic<bool> inited_{false}; |
Florian Mayer | 1fe7773 | 2018-10-02 17:25:53 +0100 | [diff] [blame] | 153 | ClientConfiguration client_config_; |
Ryan Savitski | a502bde | 2019-02-26 21:34:03 +0000 | [diff] [blame^] | 154 | // sampler_ operations are not thread-safe. |
| 155 | Sampler sampler_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 156 | SocketPool socket_pool_; |
| 157 | FreePage free_page_; |
| 158 | const char* main_thread_stack_base_ = nullptr; |
| 159 | std::atomic<uint64_t> sequence_number_{0}; |
| 160 | }; |
| 161 | |
Florian Mayer | 8c0d048 | 2018-10-22 14:23:40 +0100 | [diff] [blame] | 162 | } // namespace profiling |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 163 | } // namespace perfetto |
| 164 | |
| 165 | #endif // SRC_PROFILING_MEMORY_CLIENT_H_ |