summaryrefslogtreecommitdiffstats
path: root/tools/profiler/public/ProfilerThreadRegistrationInfo.h
blob: e116c3059e8d053a63f3f6647f529d3ee0b1ca2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef ProfilerThreadRegistrationInfo_h
#define ProfilerThreadRegistrationInfo_h

#include "mozilla/BaseAndGeckoProfilerDetail.h"
#include "mozilla/ProfilerUtils.h"
#include "mozilla/TimeStamp.h"

#include <string>

namespace mozilla::profiler {

// This class contains immutable information about a thread which needs to be
// stored across restarts of the profiler and which can be useful even after the
// thread has stopped running.
class ThreadRegistrationInfo {
 public:
  // Construct on the thread.
  explicit ThreadRegistrationInfo(const char* aName) : mName(aName) {}

  // Construct for a foreign thread (e.g., Java).
  ThreadRegistrationInfo(const char* aName, ProfilerThreadId aThreadId,
                         bool aIsMainThread, const TimeStamp& aRegisterTime)
      : mName(aName),
        mRegisterTime(aRegisterTime),
        mThreadId(aThreadId),
        mIsMainThread(aIsMainThread) {}

  // Only allow move construction, for extraction when the thread ends.
  ThreadRegistrationInfo(ThreadRegistrationInfo&&) = default;

  // Other copies/moves disallowed.
  ThreadRegistrationInfo(const ThreadRegistrationInfo&) = delete;
  ThreadRegistrationInfo& operator=(const ThreadRegistrationInfo&) = delete;
  ThreadRegistrationInfo& operator=(ThreadRegistrationInfo&&) = delete;

  [[nodiscard]] const char* Name() const { return mName.c_str(); }
  [[nodiscard]] const TimeStamp& RegisterTime() const { return mRegisterTime; }
  [[nodiscard]] ProfilerThreadId ThreadId() const { return mThreadId; }
  [[nodiscard]] bool IsMainThread() const { return mIsMainThread; }

 private:
  static TimeStamp ExistingRegisterTimeOrNow() {
    TimeStamp registerTime = baseprofiler::detail::GetThreadRegistrationTime();
    if (!registerTime) {
      registerTime = TimeStamp::Now();
    }
    return registerTime;
  }

  const std::string mName;
  const TimeStamp mRegisterTime = ExistingRegisterTimeOrNow();
  const ProfilerThreadId mThreadId = profiler_current_thread_id();
  const bool mIsMainThread = profiler_is_main_thread();
};

}  // namespace mozilla::profiler

#endif  // ProfilerThreadRegistrationInfo_h