1 /* The ptid_t type and common functions operating on it.
3 Copyright (C) 1986-2017 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.
38 /* Must have a trivial defaulted default constructor so that the
40 ptid_t () noexcept
= default;
42 /* Make a ptid given the necessary PID, LWP, and TID components.
44 A ptid with only a PID (LWP and TID equal to zero) is usually used to
45 represent a whole process, including all its lwps/threads. */
47 explicit constexpr ptid_t (int pid
, long lwp
= 0, long tid
= 0)
48 : m_pid (pid
), m_lwp (lwp
), m_tid (tid
)
51 /* Fetch the pid (process id) component from the ptid. */
53 constexpr int pid () const
56 /* Return true if the ptid's lwp member is non-zero. */
58 constexpr bool lwp_p () const
59 { return m_lwp
!= 0; }
61 /* Fetch the lwp (lightweight process) component from the ptid. */
63 constexpr long lwp () const
66 /* Return true if the ptid's tid member is non-zero. */
68 constexpr bool tid_p () const
69 { return m_tid
!= 0; }
71 /* Fetch the tid (thread id) component from a ptid. */
73 constexpr long tid () const
76 /* Return true if the ptid represents a whole process, including all its
77 lwps/threads. Such ptids have the form of (pid, 0, 0), with
80 constexpr bool is_pid () const
82 return (*this != make_null ()
83 && *this != make_minus_one ()
88 /* Compare two ptids to see if they are equal. */
90 constexpr bool operator== (const ptid_t
&other
) const
92 return (m_pid
== other
.m_pid
93 && m_lwp
== other
.m_lwp
94 && m_tid
== other
.m_tid
);
97 /* Compare two ptids to see if they are different. */
99 constexpr bool operator!= (const ptid_t
&other
) const
101 return !(*this == other
);
104 /* Return true if the ptid matches FILTER. FILTER can be the wild
105 card MINUS_ONE_PTID (all ptids match it); can be a ptid representing
106 a process (ptid.is_pid () returns true), in which case, all lwps and
107 threads of that given process match, lwps and threads of other
108 processes do not; or, it can represent a specific thread, in which
109 case, only that thread will match true. The ptid must represent a
110 specific LWP or THREAD, it can never be a wild card. */
112 constexpr bool matches (const ptid_t
&filter
) const
114 return (/* If filter represents any ptid, it's always a match. */
115 filter
== make_minus_one ()
116 /* If filter is only a pid, any ptid with that pid
118 || (filter
.is_pid () && m_pid
== filter
.pid ())
120 /* Otherwise, this ptid only matches if it's exactly equal
125 /* Make a null ptid. */
127 static constexpr ptid_t
make_null ()
128 { return ptid_t (0, 0, 0); }
130 /* Make a minus one ptid. */
132 static constexpr ptid_t
make_minus_one ()
133 { return ptid_t (-1, 0, 0); }
139 /* Lightweight process id. */
146 /* The null or zero ptid, often used to indicate no process. */
148 extern ptid_t null_ptid
;
150 /* The (-1,0,0) ptid, often used to indicate either an error condition
151 or a "don't care" condition, i.e, "run all threads." */
153 extern ptid_t minus_one_ptid
;
156 /* The following functions are kept for backwards compatibility. The use of
157 the ptid_t methods is preferred. */
159 /* See ptid_t::ptid_t. */
161 extern ptid_t
ptid_build (int pid
, long lwp
, long tid
);
163 /* See ptid_t::ptid_t. */
165 extern ptid_t
pid_to_ptid (int pid
);
167 /* See ptid_t::pid. */
169 extern int ptid_get_pid (const ptid_t
&ptid
);
171 /* See ptid_t::lwp. */
173 extern long ptid_get_lwp (const ptid_t
&ptid
);
175 /* See ptid_t::tid. */
177 extern long ptid_get_tid (const ptid_t
&ptid
);
179 /* See ptid_t::operator== and ptid_t::operator!=. */
181 extern int ptid_equal (const ptid_t
&ptid1
, const ptid_t
&ptid2
);
183 /* See ptid_t::is_pid. */
185 extern int ptid_is_pid (const ptid_t
&ptid
);
187 /* See ptid_t::lwp_p. */
189 extern int ptid_lwp_p (const ptid_t
&ptid
);
191 /* See ptid_t::tid_p. */
193 extern int ptid_tid_p (const ptid_t
&ptid
);
195 /* See ptid_t::matches. */
197 extern int ptid_match (const ptid_t
&ptid
, const ptid_t
&filter
);
This page took 0.033944 seconds and 4 git commands to generate.