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 | |
Florian Mayer | 88665be | 2018-10-03 13:15:38 +0100 | [diff] [blame] | 20 | #include <pthread.h> |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 21 | #include <stddef.h> |
Florian Mayer | af26602 | 2018-09-17 15:18:15 +0100 | [diff] [blame] | 22 | |
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" |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 28 | #include "src/profiling/memory/wire_protocol.h" |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 29 | |
| 30 | namespace perfetto { |
Florian Mayer | 8c0d048 | 2018-10-22 14:23:40 +0100 | [diff] [blame] | 31 | namespace profiling { |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 32 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 33 | class BorrowedSocket; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 34 | |
| 35 | class SocketPool { |
| 36 | public: |
| 37 | friend class BorrowedSocket; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 38 | SocketPool(std::vector<base::UnixSocketRaw> sockets); |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 39 | |
| 40 | BorrowedSocket Borrow(); |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 41 | void Shutdown(); |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 42 | |
| 43 | private: |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 44 | bool shutdown_ = false; |
| 45 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 46 | void Return(base::UnixSocketRaw); |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 47 | std::timed_mutex mutex_; |
| 48 | std::condition_variable_any cv_; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 49 | std::vector<base::UnixSocketRaw> sockets_; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 50 | size_t available_sockets_; |
Florian Mayer | af26602 | 2018-09-17 15:18:15 +0100 | [diff] [blame] | 51 | size_t dead_sockets_ = 0; |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 52 | }; |
| 53 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 54 | // Socket borrowed from a SocketPool. Gets returned once it goes out of scope. |
| 55 | class BorrowedSocket { |
| 56 | public: |
| 57 | BorrowedSocket(const BorrowedSocket&) = delete; |
| 58 | BorrowedSocket& operator=(const BorrowedSocket&) = delete; |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 59 | BorrowedSocket(BorrowedSocket&& other) noexcept |
| 60 | : sock_(std::move(other.sock_)), socket_pool_(other.socket_pool_) { |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 61 | other.socket_pool_ = nullptr; |
| 62 | } |
| 63 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 64 | BorrowedSocket(base::UnixSocketRaw sock, SocketPool* socket_pool) |
| 65 | : sock_(std::move(sock)), socket_pool_(socket_pool) {} |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 66 | |
| 67 | ~BorrowedSocket() { |
| 68 | if (socket_pool_ != nullptr) |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 69 | socket_pool_->Return(std::move(sock_)); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 70 | } |
| 71 | |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 72 | base::UnixSocketRaw* operator->() { return &sock_; } |
| 73 | base::UnixSocketRaw* get() { return &sock_; } |
| 74 | void Shutdown() { sock_.Shutdown(); } |
| 75 | explicit operator bool() const { return !!sock_; } |
Florian Mayer | f1510c4 | 2018-10-17 11:40:52 +0100 | [diff] [blame] | 76 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 77 | private: |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 78 | base::UnixSocketRaw sock_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 79 | SocketPool* socket_pool_ = nullptr; |
| 80 | }; |
| 81 | |
| 82 | // Cache for frees that have been observed. It is infeasible to send every |
| 83 | // free separately, so we batch and send the whole buffer once it is full. |
| 84 | class FreePage { |
| 85 | public: |
| 86 | // Add address to buffer. Flush if necessary using a socket borrowed from |
| 87 | // pool. |
| 88 | // Can be called from any thread. Must not hold mutex_.` |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 89 | bool Add(const uint64_t addr, uint64_t sequence_number, SocketPool* pool); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 90 | |
| 91 | private: |
| 92 | // Needs to be called holding mutex_. |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 93 | bool FlushLocked(SocketPool* pool); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 94 | |
| 95 | FreeMetadata free_page_; |
Florian Mayer | 6508157 | 2018-12-18 13:41:08 +0000 | [diff] [blame] | 96 | std::timed_mutex mutex_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 97 | size_t offset_ = 0; |
| 98 | }; |
| 99 | |
| 100 | const char* GetThreadStackBase(); |
| 101 | |
Florian Mayer | 88665be | 2018-10-03 13:15:38 +0100 | [diff] [blame] | 102 | // RAII wrapper around pthread_key_t. This is different from a ScopedResource |
| 103 | // because it needs a separate boolean indicating validity. |
| 104 | class PThreadKey { |
| 105 | public: |
| 106 | PThreadKey(const PThreadKey&) = delete; |
| 107 | PThreadKey& operator=(const PThreadKey&) = delete; |
| 108 | |
| 109 | PThreadKey(void (*destructor)(void*)) noexcept |
| 110 | : valid_(pthread_key_create(&key_, destructor) == 0) {} |
| 111 | ~PThreadKey() noexcept { |
| 112 | if (valid_) |
| 113 | pthread_key_delete(key_); |
| 114 | } |
| 115 | bool valid() const { return valid_; } |
| 116 | pthread_key_t get() const { |
| 117 | PERFETTO_DCHECK(valid_); |
| 118 | return key_; |
| 119 | } |
| 120 | |
| 121 | private: |
| 122 | pthread_key_t key_; |
| 123 | bool valid_; |
| 124 | }; |
| 125 | |
Ryan Savitski | 14c12d6 | 2019-01-08 22:38:53 +0000 | [diff] [blame] | 126 | constexpr uint32_t kClientSockTxTimeoutMs = 1000; |
| 127 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 128 | // This is created and owned by the malloc hooks. |
| 129 | class Client { |
| 130 | public: |
Primiano Tucci | 43ebf4d | 2019-01-02 20:04:34 +0100 | [diff] [blame] | 131 | Client(std::vector<base::UnixSocketRaw> sockets); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 132 | Client(const std::string& sock_name, size_t conns); |
Florian Mayer | 20c4b3c | 2019-01-24 18:25:35 +0000 | [diff] [blame^] | 133 | bool RecordMalloc(uint64_t alloc_size, |
Florian Mayer | 9a7fb2b | 2018-10-17 18:17:40 +0100 | [diff] [blame] | 134 | uint64_t total_size, |
| 135 | uint64_t alloc_address); |
Florian Mayer | 20c4b3c | 2019-01-24 18:25:35 +0000 | [diff] [blame^] | 136 | bool RecordFree(uint64_t alloc_address); |
| 137 | bool MaybeSampleAlloc(uint64_t alloc_size, |
Florian Mayer | 9a7fb2b | 2018-10-17 18:17:40 +0100 | [diff] [blame] | 138 | uint64_t alloc_address, |
| 139 | void* (*unhooked_malloc)(size_t), |
| 140 | void (*unhooked_free)(void*)); |
Florian Mayer | 2da2841 | 2018-10-30 17:33:10 +0000 | [diff] [blame] | 141 | void Shutdown(); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 142 | |
Florian Mayer | 1fe7773 | 2018-10-02 17:25:53 +0100 | [diff] [blame] | 143 | ClientConfiguration client_config_for_testing() { return client_config_; } |
Florian Mayer | b12c4f2 | 2018-11-14 16:13:02 +0000 | [diff] [blame] | 144 | bool inited() { return inited_; } |
Florian Mayer | 1fe7773 | 2018-10-02 17:25:53 +0100 | [diff] [blame] | 145 | |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 146 | private: |
Florian Mayer | 20c4b3c | 2019-01-24 18:25:35 +0000 | [diff] [blame^] | 147 | ssize_t ShouldSampleAlloc(uint64_t alloc_size, |
| 148 | void* (*unhooked_malloc)(size_t), |
| 149 | void (*unhooked_free)(void*)); |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 150 | const char* GetStackBase(); |
| 151 | |
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_; |
Florian Mayer | 88665be | 2018-10-03 13:15:38 +0100 | [diff] [blame] | 154 | PThreadKey pthread_key_; |
Florian Mayer | b85a938 | 2018-09-27 13:59:01 +0100 | [diff] [blame] | 155 | SocketPool socket_pool_; |
| 156 | FreePage free_page_; |
| 157 | const char* main_thread_stack_base_ = nullptr; |
| 158 | std::atomic<uint64_t> sequence_number_{0}; |
| 159 | }; |
| 160 | |
Florian Mayer | 8c0d048 | 2018-10-22 14:23:40 +0100 | [diff] [blame] | 161 | } // namespace profiling |
Florian Mayer | 824274d | 2018-09-17 11:33:45 +0100 | [diff] [blame] | 162 | } // namespace perfetto |
| 163 | |
| 164 | #endif // SRC_PROFILING_MEMORY_CLIENT_H_ |