xref: /illumos-gate/usr/src/man/man3proc/proc_fltname.3proc (revision 43051d2742bbe5911de73322064cb573b6aff975)
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 PROC_FLTNAME 3PROC
16.Os
17.Sh NAME
18.Nm proc_fltname ,
19.Nm proc_signame ,
20.Nm proc_sysname
21.Nd convert a fault, signal, and system call to a name
22.Sh SYNOPSIS
23.Lb libproc
24.In libproc.h
25.Ft "char *"
26.Fo proc_fltname
27.Fa "int flt"
28.Fa "char *buf"
29.Fa "size_t bufsz"
30.Fc
31.Ft "char *"
32.Fo proc_signame
33.Fa "int sig"
34.Fa "char *buf"
35.Fa "size_t bufsz"
36.Fc
37.Ft "char *"
38.Fo proc_sysname
39.Fa "int sys"
40.Fa "char *buf"
41.Fa "size_t bufsz"
42.Fc
43.Sh DESCRIPTION
44The
45.Fn proc_fltname ,
46.Fn proc_signame ,
47and
48.Fn proc_sysname
49functions respectively convert the fault, signal, and system call in
50.Fa flt ,
51.Fa sig ,
52and
53.Fa sys
54to a human-readable name and place the corresponding string in
55.Fa buf .
56Up to
57.Fa bufsz
58characters, including the null terminator, will be written into
59.Fa buf .
60.Sh RETURN VALUES
61Upon successful completion, the
62.Fn proc_fltname ,
63.Fn proc_signame ,
64and
65.Fn proc_sysname
66functions return a pointer to
67.Fa buf .
68The contents of
69.Fa buf
70are always null terminated.
71Otherwise,
72.Dv NULL
73is returned.
74.Sh INTERFACE STABILITY
75.Sy Uncommitted
76.Sh MT-LEVEL
77.Sy MT-Safe
78.Sh SEE ALSO
79.Xr libproc 3LIB ,
80.Xr proc_fltset2str 3PROC ,
81.Xr proc_sigset2str 3PROC ,
82.Xr proc_str2flt 3PROC ,
83.Xr proc_str2fltset 3PROC ,
84.Xr proc_str2sig 3PROC ,
85.Xr proc_str2sigset 3PROC ,
86.Xr proc_str2sys 3PROC ,
87.Xr proc_str2sysset 3PROC ,
88.Xr proc_sysset2str 3PROC ,
89.Xr proc 4
90