143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
1443051d27SRobert Mustacchi.Dd May 11, 2016
1543051d27SRobert Mustacchi.Dt PSETBKPT 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Psetbkpt
1943051d27SRobert Mustacchi.Nd set a breakpoint trap in a process
20ab618543SJohn Levon.Sh LIBRARY
2143051d27SRobert Mustacchi.Lb libproc
22ab618543SJohn Levon.Sh SYNOPSIS
2343051d27SRobert Mustacchi.In libproc.h
2443051d27SRobert Mustacchi.Ft int
2543051d27SRobert Mustacchi.Fo Psetbkpt
2643051d27SRobert Mustacchi.Fa "struct ps_prochandle *P"
2743051d27SRobert Mustacchi.Fa "uintptr_t address"
2843051d27SRobert Mustacchi.Fa "ulong_t *saved"
2943051d27SRobert Mustacchi.Fc
3043051d27SRobert Mustacchi.Sh DESCRIPTION
3143051d27SRobert MustacchiThe
3243051d27SRobert Mustacchi.Fn Psetbkpt
3343051d27SRobert Mustacchifunction sets a breakpoint instruction at the address
3443051d27SRobert Mustacchi.Fa address
3543051d27SRobert Mustacchiin the process handle
3643051d27SRobert Mustacchi.Fa P .
3743051d27SRobert MustacchiThe instruction that used to be set will be set in
3843051d27SRobert Mustacchi.Fa saved
3943051d27SRobert Mustacchiand should be retained.
4043051d27SRobert Mustacchi.Pp
4143051d27SRobert MustacchiA breakpoint will remain in place until a subsequent call to
4243051d27SRobert Mustacchi.Xr Pdelbkpt 3PROC .
4343051d27SRobert MustacchiThe value stored in
4443051d27SRobert Mustacchi.Fa saved
4543051d27SRobert Mustacchishould be passed as the third argument to
4643051d27SRobert Mustacchi.Xr Pdelbkpt 3PROC .
4743051d27SRobert Mustacchi.Pp
4843051d27SRobert MustacchiWhen a process executes an instruction that has been replaced with a
4943051d27SRobert Mustacchibreakpoint it generates a
5043051d27SRobert Mustacchi.Sy FLTBPT
5143051d27SRobert Mustacchitrap
5243051d27SRobert Mustacchicausing the thread to stop.
5343051d27SRobert Mustacchi.Pp
5472d3dbb9SYuri PankovNote, breakpoints may only be set in active processes.
5572d3dbb9SYuri PankovThey may not be set in process handles that refer to core files, zombie
5672d3dbb9SYuri Pankovprocesses, or files.
5743051d27SRobert Mustacchi.Sh RETURN VALUES
5843051d27SRobert MustacchiUpon successful completion, the
5943051d27SRobert Mustacchi.Fn Psetbkpt
6043051d27SRobert Mustacchifunction sets the breakpoint and
6143051d27SRobert Mustacchireturns
6243051d27SRobert Mustacchi.Sy 0 .
6343051d27SRobert MustacchiOtherwise,
6443051d27SRobert Mustacchi.Sy -1
6543051d27SRobert Mustacchiis returned and
6643051d27SRobert Mustacchi.Sy errno
6743051d27SRobert Mustacchiis set to indicate the error.
6843051d27SRobert Mustacchi.Sh ERRORS
6943051d27SRobert MustacchiFor a full list of possible errors see the
7043051d27SRobert Mustacchi.Sy DIAGNOSTICS
7143051d27SRobert Mustacchisection in
72*bbf21555SRichard Lowe.Xr proc 5 .
7343051d27SRobert Mustacchi.Pp
7443051d27SRobert MustacchiThe
7543051d27SRobert Mustacchi.Fn Psetbkpt
7643051d27SRobert Mustacchifunction will fail if:
7743051d27SRobert Mustacchi.Bl -tag -width Er
7843051d27SRobert Mustacchi.It Er ENOENT
7943051d27SRobert Mustacchi.Fa P
8043051d27SRobert Mustacchidoes not refer to an active process.
8143051d27SRobert Mustacchi.It Er EBUSY
8243051d27SRobert MustacchiA breakpoint instruction was already written by another debugger.
8343051d27SRobert Mustacchi.El
8443051d27SRobert Mustacchi.Sh INTERFACE STABILITY
8543051d27SRobert Mustacchi.Sy Uncommitted
8643051d27SRobert Mustacchi.Sh MT-LEVEL
8743051d27SRobert MustacchiSee
8843051d27SRobert Mustacchi.Sy LOCKING
8943051d27SRobert Mustacchiin
9043051d27SRobert Mustacchi.Xr libproc 3LIB .
9143051d27SRobert Mustacchi.Sh SEE ALSO
9243051d27SRobert Mustacchi.Xr libproc 3LIB ,
9343051d27SRobert Mustacchi.Xr Pdelbkpt 3PROC ,
94*bbf21555SRichard Lowe.Xr proc 5
95