xref: /illumos-gate/usr/src/man/man3proc/proc_fltset2str.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.\"
14.Dd November 27, 2023
15.Dt PROC_FLTSET2STR 3PROC
16.Os
17.Sh NAME
18.Nm proc_fltset2str ,
19.Nm proc_sigset2str ,
20.Nm proc_sysset2str
21.Nd convert a fault, signal, or system call set to a string
22.Sh LIBRARY
23.Lb libproc
24.Sh SYNOPSIS
25.In libproc.h
26.Ft "char *"
27.Fo proc_fltset2str
28.Fa "const fltset_t *set"
29.Fa "const char *delim"
30.Fa "int members"
31.Fa "char *buf"
32.Fa "size_t buflen"
33.Fc
34.Ft "char *"
35.Fo proc_sigset2str
36.Fa "const sigset_t *set"
37.Fa "const char *delim"
38.Fa "int members"
39.Fa "char *buf"
40.Fa "size_t buflen"
41.Fc
42.Ft "char *"
43.Fo proc_sysset2str
44.Fa "const sysset_t *set"
45.Fa "const char *delim"
46.Fa "int members"
47.Fa "char *buf"
48.Fa "size_t buflen"
49.Fc
50.Sh DESCRIPTION
51The
52.Fn proc_fltset2str ,
53.Fn proc_sigset2str ,
54and
55.Fn proc_sysset2str
56functions respectively convert the fault, signal, and system call sets in
57.Fa fltset ,
58.Fa sigset ,
59and
60.Fa sysset
61to a human-readable name and place the corresponding string in
62.Fa buf .
63.Pp
64Up to
65.Fa buflen
66characters will be placed in
67.Fa buf ,
68including the null terminator.
69If
70.Fa buf
71is not large enough to hold the entire string, then an error
72will be returned.
73.Pp
74The
75.Fa members
76argument controls which members of the set are written out.
77If
78.Fa members
79is
80.Sy 1 ,
81then the sets member are placed in
82.Fa buf .
83If
84.Fa members
85is
86.Sy 0 ,
87then the members which are not in the set are placed in
88.Fa buf .
89.Pp
90The string
91.Fa delim
92will be placed in-between every member of the set.
93It will not come after the last entry in the set.
94.Sh RETURN VALUES
95Upon successful completion, the
96.Fn proc_fltset2str ,
97.Fn proc_sigset2str ,
98and
99.Fn proc_sysset2str
100functions return
101.Fa buf .
102Otherwise,
103.Dv NULL
104is returned.
105.Sh INTERFACE STABILITY
106.Sy Uncommitted
107.Sh MT-LEVEL
108.Sy MT-Safe
109.Sh SEE ALSO
110.Xr libproc 3LIB ,
111.Xr proc_fltname 3PROC ,
112.Xr proc_signame 3PROC ,
113.Xr proc_str2flt 3PROC ,
114.Xr proc_str2fltset 3PROC ,
115.Xr proc_str2sig 3PROC ,
116.Xr proc_str2sigset 3PROC ,
117.Xr proc_str2sys 3PROC ,
118.Xr proc_str2sysset 3PROC ,
119.Xr proc_sysname 3PROC ,
120.Xr proc 5
121