1 /* The ptid_t type and common functions operating on it.
3 Copyright (C) 1986-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* The ptid struct is a collection of the various "ids" necessary for
24 identifying the inferior process/thread being debugged. This
25 consists of the process id (pid), lightweight process id (lwp) and
26 thread id (tid). When manipulating ptids, the constructors,
27 accessors, and predicates declared in this file should be used. Do
28 NOT access the struct ptid members directly.
30 process_stratum targets that handle threading themselves should
31 prefer using the ptid.lwp field, leaving the ptid.tid field for any
32 thread_stratum target that might want to sit on top.
41 /* Must have a trivial defaulted default constructor so that the
43 ptid_t () noexcept
= default;
45 /* Make a ptid given the necessary PID, LWP, and TID components.
47 A ptid with only a PID (LWP and TID equal to zero) is usually used to
48 represent a whole process, including all its lwps/threads. */
50 explicit constexpr ptid_t (int pid
, long lwp
= 0, long tid
= 0)
51 : m_pid (pid
), m_lwp (lwp
), m_tid (tid
)
54 /* Fetch the pid (process id) component from the ptid. */
56 constexpr int pid () const
59 /* Return true if the ptid's lwp member is non-zero. */
61 constexpr bool lwp_p () const
62 { return m_lwp
!= 0; }
64 /* Fetch the lwp (lightweight process) component from the ptid. */
66 constexpr long lwp () const
69 /* Return true if the ptid's tid member is non-zero. */
71 constexpr bool tid_p () const
72 { return m_tid
!= 0; }
74 /* Fetch the tid (thread id) component from a ptid. */
76 constexpr long tid () const
79 /* Return true if the ptid represents a whole process, including all its
80 lwps/threads. Such ptids have the form of (pid, 0, 0), with
83 constexpr bool is_pid () const
85 return (*this != make_null ()
86 && *this != make_minus_one ()
91 /* Compare two ptids to see if they are equal. */
93 constexpr bool operator== (const ptid_t
&other
) const
95 return (m_pid
== other
.m_pid
96 && m_lwp
== other
.m_lwp
97 && m_tid
== other
.m_tid
);
100 /* Compare two ptids to see if they are different. */
102 constexpr bool operator!= (const ptid_t
&other
) const
104 return !(*this == other
);
107 /* Return true if the ptid matches FILTER. FILTER can be the wild
108 card MINUS_ONE_PTID (all ptids match it); can be a ptid representing
109 a process (ptid.is_pid () returns true), in which case, all lwps and
110 threads of that given process match, lwps and threads of other
111 processes do not; or, it can represent a specific thread, in which
112 case, only that thread will match true. The ptid must represent a
113 specific LWP or THREAD, it can never be a wild card. */
115 constexpr bool matches (const ptid_t
&filter
) const
117 return (/* If filter represents any ptid, it's always a match. */
118 filter
== make_minus_one ()
119 /* If filter is only a pid, any ptid with that pid
121 || (filter
.is_pid () && m_pid
== filter
.pid ())
123 /* Otherwise, this ptid only matches if it's exactly equal
128 /* Return a string representation of the ptid.
130 This is only meant to be used in debug messages. */
132 std::string
to_string () const;
134 /* Make a null ptid. */
136 static constexpr ptid_t
make_null ()
137 { return ptid_t (0, 0, 0); }
139 /* Make a minus one ptid. */
141 static constexpr ptid_t
make_minus_one ()
142 { return ptid_t (-1, 0, 0); }
148 /* Lightweight process id. */
155 /* Functor to hash a ptid. */
159 size_t operator() (const ptid_t
&ptid
) const
161 std::hash
<long> long_hash
;
163 return (long_hash (ptid
.pid ())
164 + long_hash (ptid
.lwp ())
165 + long_hash (ptid
.tid ()));
169 /* The null or zero ptid, often used to indicate no process. */
171 extern const ptid_t null_ptid
;
173 /* The (-1,0,0) ptid, often used to indicate either an error condition
174 or a "don't care" condition, i.e, "run all threads." */
176 extern const ptid_t minus_one_ptid
;
178 #endif /* COMMON_PTID_H */
This page took 0.040643 seconds and 4 git commands to generate.