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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* The ptid_t type and common functions operating on it.
Copyright (C) 1986-2024 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef COMMON_PTID_H
#define COMMON_PTID_H
/* The ptid struct is a collection of the various "ids" necessary for
identifying the inferior process/thread being debugged. This
consists of the process id (pid), lightweight process id (lwp) and
thread id (tid). When manipulating ptids, the constructors,
accessors, and predicates declared in this file should be used. Do
NOT access the struct ptid members directly.
process_stratum targets that handle threading themselves should
prefer using the ptid.lwp field, leaving the ptid.tid field for any
thread_stratum target that might want to sit on top.
*/
#include <functional>
#include <string>
#include "gdbsupport/common-types.h"
class ptid_t
{
public:
using pid_type = int;
using lwp_type = long;
using tid_type = ULONGEST;
/* Must have a trivial defaulted default constructor so that the
type remains POD. */
ptid_t () noexcept = default;
/* Make a ptid given the necessary PID, LWP, and TID components.
A ptid with only a PID (LWP and TID equal to zero) is usually used to
represent a whole process, including all its lwps/threads. */
explicit constexpr ptid_t (pid_type pid, lwp_type lwp = 0, tid_type tid = 0)
: m_pid (pid), m_lwp (lwp), m_tid (tid)
{}
/* Fetch the pid (process id) component from the ptid. */
constexpr pid_type pid () const
{ return m_pid; }
/* Return true if the ptid's lwp member is non-zero. */
constexpr bool lwp_p () const
{ return m_lwp != 0; }
/* Fetch the lwp (lightweight process) component from the ptid. */
constexpr lwp_type lwp () const
{ return m_lwp; }
/* Return true if the ptid's tid member is non-zero. */
constexpr bool tid_p () const
{ return m_tid != 0; }
/* Fetch the tid (thread id) component from a ptid. */
constexpr tid_type tid () const
{ return m_tid; }
/* Return true if the ptid represents a whole process, including all its
lwps/threads. Such ptids have the form of (pid, 0, 0), with
pid != -1. */
constexpr bool is_pid () const
{
return (*this != make_null ()
&& *this != make_minus_one ()
&& m_lwp == 0
&& m_tid == 0);
}
/* Compare two ptids to see if they are equal. */
constexpr bool operator== (const ptid_t &other) const
{
return (m_pid == other.m_pid
&& m_lwp == other.m_lwp
&& m_tid == other.m_tid);
}
/* Compare two ptids to see if they are different. */
constexpr bool operator!= (const ptid_t &other) const
{
return !(*this == other);
}
/* Return true if the ptid matches FILTER. FILTER can be the wild
card MINUS_ONE_PTID (all ptids match it); can be a ptid representing
a process (ptid.is_pid () returns true), in which case, all lwps and
threads of that given process match, lwps and threads of other
processes do not; or, it can represent a specific thread, in which
case, only that thread will match true. The ptid must represent a
specific LWP or THREAD, it can never be a wild card. */
constexpr bool matches (const ptid_t &filter) const
{
return (/* If filter represents any ptid, it's always a match. */
filter == make_minus_one ()
/* If filter is only a pid, any ptid with that pid
matches. */
|| (filter.is_pid () && m_pid == filter.pid ())
/* Otherwise, this ptid only matches if it's exactly equal
to filter. */
|| *this == filter);
}
/* Return a string representation of the ptid.
This is only meant to be used in debug messages. */
std::string to_string () const;
/* Make a null ptid. */
static constexpr ptid_t make_null ()
{ return ptid_t (0, 0, 0); }
/* Make a minus one ptid. */
static constexpr ptid_t make_minus_one ()
{ return ptid_t (-1, 0, 0); }
private:
/* Process id. */
pid_type m_pid;
/* Lightweight process id. */
lwp_type m_lwp;
/* Thread id. */
tid_type m_tid;
};
namespace std
{
template<>
struct hash<ptid_t>
{
size_t operator() (const ptid_t &ptid) const
{
std::hash<long> long_hash;
return (long_hash (ptid.pid ())
+ long_hash (ptid.lwp ())
+ long_hash (ptid.tid ()));
}
};
}
/* The null or zero ptid, often used to indicate no process. */
extern const ptid_t null_ptid;
/* The (-1,0,0) ptid, often used to indicate either an error condition
or a "don't care" condition, i.e, "run all threads." */
extern const ptid_t minus_one_ptid;
#endif /* COMMON_PTID_H */
|
