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