src/profiling/memory/client.h

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SRC_PROFILING_MEMORY_CLIENT_H_
#define SRC_PROFILING_MEMORY_CLIENT_H_

#include <stddef.h>

#include <atomic>
#include <condition_variable>
#include <mutex>
#include <vector>

#include "perfetto/base/unix_socket.h"
#include "src/profiling/memory/sampler.h"
#include "src/profiling/memory/shared_ring_buffer.h"
#include "src/profiling/memory/wire_protocol.h"

namespace perfetto {
namespace profiling {

class Client;

// Cache for frees that have been observed. It is infeasible to send every
// free separately, so we batch and send the whole buffer once it is full.
class FreePage {
 public:
  FreePage() { free_page_.num_entries = 0; }

  // Add address to buffer. Flush if necessary.
  // Can be called from any thread. Must not hold mutex_.
  bool Add(const uint64_t addr, uint64_t sequence_number, Client* client);

 private:
  // TODO(fmayer): Sort out naming. It's confusing data FreePage has a member
  // called free_page_ that is of type FreeMetadata.
  FreeMetadata free_page_;
  std::timed_mutex mutex_;
};

const char* GetThreadStackBase();

constexpr uint32_t kClientSockTimeoutMs = 1000;

// Profiling client, used to sample and record the malloc/free family of calls,
// and communicate the necessary state to a separate profiling daemon process.
//
// Created and owned by the malloc hooks.
//
// Methods of this class are thread-safe unless otherwise stated, in which case
// the caller needs to synchronize calls behind a mutex or similar.
class Client {
 public:
  Client(base::Optional<base::UnixSocketRaw> sock);
  Client(const std::string& sock_name);
  bool RecordMalloc(uint64_t alloc_size,
                    uint64_t total_size,
                    uint64_t alloc_address);
  bool RecordFree(uint64_t alloc_address);
  void Shutdown();
  bool FlushFrees(FreeMetadata* free_metadata);

  // Returns the number of bytes to assign to an allocation with the given
  // |alloc_size|, based on the current sampling rate. A return value of zero
  // means that the allocation should not be recorded. Not idempotent, each
  // invocation mutates the sampler state.
  //
  // Not thread-safe.
  size_t GetSampleSizeLocked(size_t alloc_size) {
    if (!inited_.load(std::memory_order_acquire))
      return 0;
    return sampler_.SampleSize(alloc_size);
  }

  ClientConfiguration client_config_for_testing() { return client_config_; }
  bool inited() { return inited_; }

 private:
  const char* GetStackBase();

  // TODO(rsavitski): used to check if the client is completely initialized
  // after construction. The reads in RecordFree & GetSampleSizeLocked are no
  // longer necessary (was an optimization to not do redundant work after
  // shutdown). Turn into a normal bool, or indicate construction failures
  // differently.
  std::atomic<bool> inited_{false};
  ClientConfiguration client_config_;
  // sampler_ operations are not thread-safe.
  Sampler sampler_;
  base::UnixSocketRaw sock_;
  FreePage free_page_;
  const char* main_thread_stack_base_ = nullptr;
  std::atomic<uint64_t> sequence_number_{0};
  SharedRingBuffer shmem_;
};

}  // namespace profiling
}  // namespace perfetto

#endif  // SRC_PROFILING_MEMORY_CLIENT_H_