summaryrefslogtreecommitdiff
path: root/usr/src/man/man3proc/pr_close.3proc
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man3proc/pr_close.3proc')
-rw-r--r--usr/src/man/man3proc/pr_close.3proc99
1 files changed, 99 insertions, 0 deletions
diff --git a/usr/src/man/man3proc/pr_close.3proc b/usr/src/man/man3proc/pr_close.3proc
new file mode 100644
index 0000000000..af4185fb8d
--- /dev/null
+++ b/usr/src/man/man3proc/pr_close.3proc
@@ -0,0 +1,99 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Joyent, Inc.
+.\"
+.Dd May 11, 2016
+.Dt PR_CLOSE 3PROC
+.Os
+.Sh NAME
+.Nm pr_close
+.Nd inject close system call into victim process
+.Sh SYNOPSIS
+.Lb libproc
+.In libproc.h
+.Ft int
+.Fo pr_close
+.Fa "struct ps_prochandle *P"
+.Fa "int fd"
+.Fc
+.Sh DESCRIPTION
+The
+.Fn pr_close
+function injects the
+.Xr close 2
+system call into the target process
+.Fa P
+by means of the agent LWP.
+If the process handle
+.Fa P
+is
+.Dv NULL
+then this is equivalent to calling
+.Xr close 2
+on the currently running process.
+.Pp
+The argument
+.Fa fd
+has the same meaning as in
+.Xr close 2 .
+See
+.Xr close 2
+for the full description and purpose of the
+.Sy close
+system call and its arguments.
+.Pp
+The
+.Fn pr_close
+function only works on active processes. Process handles that correspond
+to core files, zombie processes, or ELF objects do not support system
+call injection.
+.Sh RETURN VALUES
+Upon successful completion, the
+.Fn pr_close
+function's return value is that described in
+.Xr close 2 .
+Otherwise,
+.Sy -1
+is returned and
+.Sy errno
+is set to
+.Er ENOSYS
+to indicate that the system call could not be injected.
+.Sh ERRORS
+For the full list of errors see the
+.Sy ERRORS
+section in
+.Xr close 2 .
+.Pp
+The
+.Fn pr_close
+function will fail if:
+.Bl -tag -width Er
+.It Er ENOSYS
+An error occurred while trying to invoke the agent LWP and inject a
+system call in the process handle
+.Fa P
+or the process handle
+.Fa P
+does not support system call injection.
+.El
+.Sh INTERFACE STABILITY
+.Sy Uncommitted
+.Sh MT-LEVEL
+See
+.Sy LOCKING
+in
+.Xr libproc 3LIB .
+.Sh SEE ALSO
+.Xr close 2 ,
+.Xr libproc 3LIB ,
+.Xr proc 4