xref: /illumos-gate/usr/src/man/man3proc/Psignal.3proc (revision 43051d2742bbe5911de73322064cb573b6aff975)
1*43051d27SRobert Mustacchi.\"
2*43051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*43051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*43051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*43051d27SRobert Mustacchi.\" 1.0 of the CDDL.
6*43051d27SRobert Mustacchi.\"
7*43051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*43051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*43051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*43051d27SRobert Mustacchi.\"
11*43051d27SRobert Mustacchi.\"
12*43051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
13*43051d27SRobert Mustacchi.\"
14*43051d27SRobert Mustacchi.Dd May 11, 2016
15*43051d27SRobert Mustacchi.Dt PSIGNAL 3PROC
16*43051d27SRobert Mustacchi.Os
17*43051d27SRobert Mustacchi.Sh NAME
18*43051d27SRobert Mustacchi.Nm Psignal
19*43051d27SRobert Mustacchi.Nd set signal tracing action
20*43051d27SRobert Mustacchi.Sh SYNOPSIS
21*43051d27SRobert Mustacchi.Lb libproc
22*43051d27SRobert Mustacchi.In libproc.h
23*43051d27SRobert Mustacchi.Ft int
24*43051d27SRobert Mustacchi.Fo Psignal
25*43051d27SRobert Mustacchi.Fa "struct ps_prochandle *P"
26*43051d27SRobert Mustacchi.Fa "int which"
27*43051d27SRobert Mustacchi.Fa "int stop"
28*43051d27SRobert Mustacchi.Fc
29*43051d27SRobert Mustacchi.Sh DESCRIPTION
30*43051d27SRobert MustacchiThe
31*43051d27SRobert Mustacchi.Fn Psignal
32*43051d27SRobert Mustacchifunction sets the signal tracing flag for the process handle
33*43051d27SRobert Mustacchi.Fa P .
34*43051d27SRobert MustacchiIf
35*43051d27SRobert Mustacchi.Fa stop
36*43051d27SRobert Mustacchiis
37*43051d27SRobert Mustacchi.Sy non-zero
38*43051d27SRobert Mustacchiit causes the process handle to stop threads that encounter the signal
39*43051d27SRobert Mustacchi.Fa which .
40*43051d27SRobert MustacchiIf
41*43051d27SRobert Mustacchi.Fa stop
42*43051d27SRobert Mustacchiis
43*43051d27SRobert Mustacchi.Sy zero ,
44*43051d27SRobert Mustacchithen it disables tracing for the signal
45*43051d27SRobert Mustacchi.Fa which .
46*43051d27SRobert Mustacchi.Pp
47*43051d27SRobert MustacchiThe signal constants, representing valid values for
48*43051d27SRobert Mustacchi.Fa which ,
49*43051d27SRobert Mustacchican be found in
50*43051d27SRobert Mustacchi.Xr signal.h 3HEAD.
51*43051d27SRobert MustacchiThe signal
52*43051d27SRobert Mustacchi.Dv SIGKILL
53*43051d27SRobert Mustacchimay not be stopped.
54*43051d27SRobert Mustacchi.Pp
55*43051d27SRobert MustacchiNote, only active processes may have their signal tracing flags updated.
56*43051d27SRobert MustacchiProcess handles that refer to core files, zombie processes, and files do
57*43051d27SRobert Mustacchinot have signal tracing flags. Calling this function on them is an error.
58*43051d27SRobert Mustacchi.Sh RETURN VALUES
59*43051d27SRobert MustacchiUpon successful completion, the
60*43051d27SRobert Mustacchi.Fn Psignal
61*43051d27SRobert Mustacchifunction returns the previous disposition of the signal
62*43051d27SRobert Mustacchi.Fa which .
63*43051d27SRobert MustacchiIt returns
64*43051d27SRobert Mustacchi.Sy 1
65*43051d27SRobert Mustacchiif it was set and
66*43051d27SRobert Mustacchi.Sy 0
67*43051d27SRobert Mustacchiif not. Otherwise,
68*43051d27SRobert Mustacchi.Sy -1
69*43051d27SRobert Mustacchiis returned and
70*43051d27SRobert Mustacchi.Sy errno
71*43051d27SRobert Mustacchiis set to indicate the error.
72*43051d27SRobert Mustacchi.Sh ERRORS
73*43051d27SRobert MustacchiThe
74*43051d27SRobert Mustacchi.Fn Psignal
75*43051d27SRobert Mustacchifunction will fail if:
76*43051d27SRobert Mustacchi.Bl -tag -width Er
77*43051d27SRobert Mustacchi.It Er EINVAL
78*43051d27SRobert Mustacchi.Fa which
79*43051d27SRobert Mustacchiis
80*43051d27SRobert Mustacchi.Dv SIGKILL
81*43051d27SRobert Mustacchiand
82*43051d27SRobert Mustacchi.Fa stop
83*43051d27SRobert Mustacchiis non-zero .
84*43051d27SRobert Mustacchi.Pp
85*43051d27SRobert Mustacchi.Fa which
86*43051d27SRobert Mustacchiis not a valid signal.
87*43051d27SRobert Mustacchi.It Er ENOENT
88*43051d27SRobert Mustacchi.Fa P
89*43051d27SRobert Mustacchidoes not correspond to an active process.
90*43051d27SRobert Mustacchi.El
91*43051d27SRobert Mustacchi.Sh INTERFACE STABILITY
92*43051d27SRobert Mustacchi.Sy Uncommitted
93*43051d27SRobert Mustacchi.Sh MT-LEVEL
94*43051d27SRobert MustacchiSee
95*43051d27SRobert Mustacchi.Sy LOCKING
96*43051d27SRobert Mustacchiin
97*43051d27SRobert Mustacchi.Xr libproc 3LIB .
98*43051d27SRobert Mustacchi.Sh SEE ALSO
99*43051d27SRobert Mustacchi.Xr signal.h 3HEAD ,
100*43051d27SRobert Mustacchi.Xr libproc 3LIB ,
101*43051d27SRobert Mustacchi.Xr Psetsignal 3PROC ,
102*43051d27SRobert Mustacchi.Xr proc 4
103