9a2c3737b0
The ptid_t contructors, accessors and predicates are documented in
_three_ places, and each place uses a different wording.
E.g, the descriptions in the .c file of the new ptid_lwp_p, ptid_tid_p
weren't updated in the final revision like the descriptions in the .h
file were. Clearly, switching to a style that has a single central
description avoids such issues.
Worse, some of the existing descriptions are plain wrong, such as:
/* Attempt to find and return an existing ptid with the given PID, LWP,
and TID components. If none exists, create a new one and return
that. */
ptid_t ptid_build (int pid, long lwp, long tid);
The function does nothing that complicated. It's just a simple
constructor.
So this gets rid of all the unnecessary descriptions, leaving only the
ones near the function declarations in the header file, and
fixes/clarifies those that remain.
gdb/
2013-10-04 Pedro Alves <palves@redhat.com>
* common/ptid.c (null_ptid, minus_one_ptid, ptid_build)
(pid_to_ptid, ptid_get_pid, ptid_get_lwp, ptid_get_tid)
(ptid_equal, ptid_is_pid, ptid_lwp_p, ptid_tid_p): Replace
describing comments with references to ptid.h.
* common/ptid.h: Remove intro description of constructors,
accessors and predicates.
(struct ptid): Reformat.
(minus_one_ptid, ptid_build, pid_to_ptid, ptid_get_pid)
(ptid_get_lwp, ptid_get_tid, ptid_equal, ptid_is_pid): Change
describing comments.
81 lines
2.6 KiB
C
81 lines
2.6 KiB
C
/* The ptid_t type and common functions operating on it.
|
|
|
|
Copyright (C) 1986-2013 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 PTID_H
|
|
#define 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. */
|
|
|
|
struct ptid
|
|
{
|
|
/* Process id. */
|
|
int pid;
|
|
|
|
/* Lightweight process id. */
|
|
long lwp;
|
|
|
|
/* Thread id. */
|
|
long tid;
|
|
};
|
|
|
|
typedef struct ptid ptid_t;
|
|
|
|
/* The null or zero ptid, often used to indicate no process. */
|
|
extern 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 ptid_t minus_one_ptid;
|
|
|
|
/* Make a ptid given the necessary PID, LWP, and TID components. */
|
|
ptid_t ptid_build (int pid, long lwp, long tid);
|
|
|
|
/* Make a new ptid from just a pid. This ptid is usually used to
|
|
represent a whole process, including all its lwps/threads. */
|
|
ptid_t pid_to_ptid (int pid);
|
|
|
|
/* Fetch the pid (process id) component from a ptid. */
|
|
int ptid_get_pid (ptid_t ptid);
|
|
|
|
/* Fetch the lwp (lightweight process) component from a ptid. */
|
|
long ptid_get_lwp (ptid_t ptid);
|
|
|
|
/* Fetch the tid (thread id) component from a ptid. */
|
|
long ptid_get_tid (ptid_t ptid);
|
|
|
|
/* Compare two ptids to see if they are equal. */
|
|
int ptid_equal (ptid_t ptid1, ptid_t ptid2);
|
|
|
|
/* Returns true if PTID represents a whole process, including all its
|
|
lwps/threads. Such ptids have the form of (pid,0,0), with pid !=
|
|
-1. */
|
|
int ptid_is_pid (ptid_t ptid);
|
|
|
|
/* Return true if PTID's lwp member is non-zero. */
|
|
int ptid_lwp_p (ptid_t ptid);
|
|
|
|
/* Return true if PTID's tid member is non-zero. */
|
|
int ptid_tid_p (ptid_t ptid);
|
|
|
|
#endif
|