Coverage Report

Created: 2022-01-15 10:30

/Users/buildslave/jenkins/workspace/coverage/llvm-project/lldb/include/lldb/Target/ThreadSpec.h
Line
Count
Source (jump to first uncovered line)
1
//===-- ThreadSpec.h --------------------------------------------*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#ifndef LLDB_TARGET_THREADSPEC_H
10
#define LLDB_TARGET_THREADSPEC_H
11
12
#include "lldb/Utility/StructuredData.h"
13
#include "lldb/lldb-private.h"
14
#include <string>
15
16
namespace lldb_private {
17
18
// Note: For now the thread spec has only fixed elements -
19
//   Thread ID
20
//   Thread Index
21
//   Thread Name
22
//   Thread Queue Name
23
//
24
//  But if we need more generality, we can hang a key/value map off of this
25
//  structure.
26
//  That's why the thread matches spec test is done as a virtual method in
27
//  Thread::MatchesSpec,
28
//  since it is the native thread that would know how to interpret the keys.
29
//  I was going to do the Queue Name this way out of sheer orneriness, but that
30
//  seems a
31
//  sufficiently general concept, so I put it in here on its own.
32
33
class ThreadSpec {
34
public:
35
  ThreadSpec();
36
37
  static std::unique_ptr<ThreadSpec>
38
  CreateFromStructuredData(const StructuredData::Dictionary &data_dict,
39
                           Status &error);
40
41
  StructuredData::ObjectSP SerializeToStructuredData();
42
43
28
  static const char *GetSerializationKey() { return "ThreadSpec"; }
44
45
6
  void SetIndex(uint32_t index) { m_index = index; }
46
47
5.75k
  void SetTID(lldb::tid_t tid) { m_tid = tid; }
48
49
7
  void SetName(llvm::StringRef name) { m_name = std::string(name); }
50
51
6
  void SetQueueName(llvm::StringRef queue_name) {
52
6
    m_queue_name = std::string(queue_name);
53
6
  }
54
55
8
  uint32_t GetIndex() const { return m_index; }
56
57
5.75k
  lldb::tid_t GetTID() const { return m_tid; }
58
59
  const char *GetName() const;
60
61
  const char *GetQueueName() const;
62
63
5.37k
  bool TIDMatches(lldb::tid_t thread_id) const {
64
5.37k
    if (m_tid == LLDB_INVALID_THREAD_ID || thread_id == LLDB_INVALID_THREAD_ID)
65
0
      return true;
66
5.37k
    else
67
5.37k
      return thread_id == m_tid;
68
5.37k
  }
69
70
  bool TIDMatches(Thread &thread) const;
71
72
19
  bool IndexMatches(uint32_t index) const {
73
19
    if (m_index == UINT32_MAX || index == UINT32_MAX)
74
0
      return true;
75
19
    else
76
19
      return index == m_index;
77
19
  }
78
79
  bool IndexMatches(Thread &thread) const;
80
81
3
  bool NameMatches(const char *name) const {
82
3
    if (m_name.empty())
83
0
      return true;
84
3
    else if (name == nullptr)
85
1
      return false;
86
2
    else
87
2
      return m_name == name;
88
3
  }
89
90
  bool NameMatches(Thread &thread) const;
91
92
0
  bool QueueNameMatches(const char *queue_name) const {
93
0
    if (m_queue_name.empty())
94
0
      return true;
95
0
    else if (queue_name == nullptr)
96
0
      return false;
97
0
    else
98
0
      return m_queue_name == queue_name;
99
0
  }
100
101
  bool QueueNameMatches(Thread &thread) const;
102
103
  bool ThreadPassesBasicTests(Thread &thread) const;
104
105
  bool HasSpecification() const;
106
107
  void GetDescription(Stream *s, lldb::DescriptionLevel level) const;
108
109
private:
110
  enum class OptionNames {
111
    ThreadIndex = 0,
112
    ThreadID,
113
    ThreadName,
114
    QueueName,
115
    LastOptionName
116
  };
117
  static const char *g_option_names[(size_t)OptionNames::LastOptionName];
118
119
33
  static const char *GetKey(OptionNames enum_value) {
120
33
    return g_option_names[(size_t) enum_value];
121
33
  }
122
123
  uint32_t m_index = UINT32_MAX;
124
  lldb::tid_t m_tid = LLDB_INVALID_THREAD_ID;
125
  std::string m_name;
126
  std::string m_queue_name;
127
};
128
129
} // namespace lldb_private
130
131
#endif // LLDB_TARGET_THREADSPEC_H