xref: /illumos-gate/usr/src/man/man3proc/Pxecbkpt.3proc (revision b1e2e3fb17324e9ddf43db264a0c64da7756d9e6)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd May 11, 2016
15.Dt PXECBKPT 3PROC
16.Os
17.Sh NAME
18.Nm Pxecbkpt ,
19.Nm Pxecwapt ,
20.Nm Lxecbkpt ,
21.Nm Lxecwapt
22.Nd step over a breakpoint or watchpoint
23.Sh SYNOPSIS
24.Ft int
25.Fo Pxecbkpt
26.Fa "struct ps_prochandle *P"
27.Fa "ulong_t saved"
28.Fc
29.Ft int
30.Fo Pxecwapt
31.Fa "struct ps_prochandle *P"
32.Fa "ulong_t saved"
33.Fc
34.Ft int
35.Fo Lxecbkpt
36.Fa "struct ps_lwphandle *L"
37.Fa "ulong_t saved"
38.Fc
39.Ft int
40.Fo Lxecwapt
41.Fa "struct ps_lwphandle *L"
42.Fa "ulong_t saved"
43.Fc
44.Sh DESCRIPTION
45The
46.Fn Pxecbkpt
47and
48.Fn Pxecwapt
49functions step over a breakpoint or watchpoint respectively in the
50corresponding process handle
51.Fa P .
52The functions execute the original instruction that was at the current
53program counter, provided by
54.Fa saved ,
55and then leave the process stopped at the next instruction.
56.Pp
57The process must be stopped at the time that the
58.Fn Pxecbkpt
59or
60.Fn Pxecwapt
61functions are called.
62.Pp
63The
64.Fn Lxecbkpt
65and
66.Fn Lxecwapt
67functions are identical to
68.Fn Pxecbkpt
69and
70.Fn Pxecwapt ,
71respectively; except rather than operating on the process as a
72whole, they operate on the thread handle
73.Fa L .
74These functions only require that the thread represented by
75.Fa L
76be stopped and not the entire process.
77.Sh RETURN VALUES
78Upon successful completion, the
79.Fn Pxecbkpt ,
80.Fn Pxecwapt ,
81.Fn Lxecbkpt ,
82and
83.Fn Lxecwapt
84functions return
85.Sy 0
86having executed the original instruction at
87.Fa saved .
88Otherwise,
89.Sy -1
90is returned and
91.Sy errno
92is set to indicate the error.
93.Sh ERRORS
94For a full list of errors see the
95.Sy DIAGNOSTICS
96section in
97.Xr proc 4 .
98The
99.Fn Pxecbkpt ,
100.Fn Pxecwapt ,
101.Fn Lxecbkpt ,
102and
103.Fn Lxecwapt
104functions will fail if:
105.Bl -tag -width Er
106.It Er EBUSY
107Either
108.Fa P
109or
110.Fa L
111is not stopped.
112.El
113.Sh INTERFACE STABILITY
114.Sy Uncommitted
115.Sh MT-LEVEL
116See
117.Sy LOCKING
118in
119.Xr libproc 3LIB .
120.Sh SEE ALSO
121.Xr libproc 3LIB ,
122.Xr Pdelbkpt 3PROC ,
123.Xr Pdelwapt 3PROC ,
124.Xr Psetbkpt 3PROC ,
125.Xr Psetwapt 3PROC ,
126.Xr proc 4
127