xref: /illumos-gate/usr/src/man/man3proc/pr_getrctl.3proc (revision e00bdde3c6d406f40f53f3025defadc22f7ec31a)
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 November 27, 2023
15.Dt PR_GETRCTL 3PROC
16.Os
17.Sh NAME
18.Nm pr_getrctl
19.Nd inject getrctl system call into victim process
20.Sh LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft int
25.Fo pr_getrctl
26.Fa "struct ps_prochandle *P"
27.Fa "const char *rname"
28.Fa "rctlblk_t *old_blk"
29.Fa "rctlblk_t *new_blk"
30.Fa "int rflag"
31.Fc
32.Sh DESCRIPTION
33The
34.Fn pr_getrctl
35function injects the
36.Xr getrctl 2
37system call into the target process
38.Fa P
39by means of the agent LWP.
40If the process handle
41.Fa P
42is
43.Dv NULL
44then this is equivalent to calling
45.Xr getrctl 2
46on the currently running process.
47.Pp
48The arguments
49.Fa rname ,
50.Fa old_blk ,
51.Fa new_blk ,
52and
53.Fa rflag
54have the same meaning as in
55.Xr getrctl 2 .
56See
57.Xr getrctl 2
58for the full description and purpose of the
59.Sy getrctl
60system call and its arguments.
61.Pp
62The
63.Fn pr_getrctl
64function only works on active processes.
65Process handles that correspond to core files, zombie processes, or ELF objects
66do not support system call injection.
67.Sh RETURN VALUES
68Upon successful completion, the
69.Fn pr_getrctl
70function's return value is that described in
71.Xr getrctl 2 .
72Otherwise,
73.Sy -1
74is returned and
75.Sy errno
76is set to
77.Er ENOSYS
78to indicate that the system call could not be injected.
79.Sh ERRORS
80For the full list of errors see the
81.Sy ERRORS
82section in
83.Xr getrctl 2 .
84.Pp
85The
86.Fn pr_getrctl
87function will fail if:
88.Bl -tag -width Er
89.It Er ENOSYS
90An error occurred while trying to invoke the agent LWP and inject a
91system call in the process handle
92.Fa P
93or the process handle
94.Fa P
95does not support system call injection.
96.El
97.Sh INTERFACE STABILITY
98.Sy Uncommitted
99.Sh MT-LEVEL
100See
101.Sy LOCKING
102in
103.Xr libproc 3LIB .
104.Sh SEE ALSO
105.Xr getrctl 2 ,
106.Xr libproc 3LIB ,
107.Xr proc 5
108