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