xref: /illumos-gate/usr/src/man/man3proc/proc_str2fltset.3proc (revision a7d7cafedfa26f9e421bbcaf42b7387ef67c0a31)
143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
14*a7d7cafeSRobert Mustacchi.Dd November 27, 2023
1543051d27SRobert Mustacchi.Dt PROC_STR2FLTSET 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm proc_str2fltset ,
1943051d27SRobert Mustacchi.Nm proc_str2sigset ,
2043051d27SRobert Mustacchi.Nm proc_str2sysset
2143051d27SRobert Mustacchi.Nd convert a string to a fault, signal, or system call set
22*a7d7cafeSRobert Mustacchi.Sh LIBRARY
2343051d27SRobert Mustacchi.Lb libproc
24*a7d7cafeSRobert Mustacchi.Sh SYNOPSIS
2543051d27SRobert Mustacchi.In libproc.h
2643051d27SRobert Mustacchi.Ft char *
2743051d27SRobert Mustacchi.Fo proc_str2fltset
2843051d27SRobert Mustacchi.Fa "const char *str"
2943051d27SRobert Mustacchi.Fa "const char *delim"
3043051d27SRobert Mustacchi.Fa "int members"
3143051d27SRobert Mustacchi.Fa "fltset_t *set"
3243051d27SRobert Mustacchi.Fc
3343051d27SRobert Mustacchi.Ft char *
3443051d27SRobert Mustacchi.Fo proc_str2sigset
3543051d27SRobert Mustacchi.Fa "const char *str"
3643051d27SRobert Mustacchi.Fa "const char *delim"
3743051d27SRobert Mustacchi.Fa "int members"
3843051d27SRobert Mustacchi.Fa "sigset_t *set"
3943051d27SRobert Mustacchi.Fc
4043051d27SRobert Mustacchi.Ft char *
4143051d27SRobert Mustacchi.Fo proc_str2sysset
4243051d27SRobert Mustacchi.Fa "const char *str"
4343051d27SRobert Mustacchi.Fa "const char *delim"
4443051d27SRobert Mustacchi.Fa "int members"
4543051d27SRobert Mustacchi.Fa "sysset_t *set"
4643051d27SRobert Mustacchi.Fc
4743051d27SRobert Mustacchi.Sh DESCRIPTION
4843051d27SRobert MustacchiThe
4943051d27SRobert Mustacchi.Fn proc_str2fltset ,
5043051d27SRobert Mustacchi.Fn proc_str2sigset ,
5143051d27SRobert Mustacchiand
5243051d27SRobert Mustacchi.Fn proc_str2sysset
5343051d27SRobert Mustacchifunctions translate a character string,
5443051d27SRobert Mustacchi.Fa str ,
5543051d27SRobert Mustacchiinto the corresponding fault set, signal set, and system call set
5643051d27SRobert Mustacchirespectively.
5743051d27SRobert Mustacchi.Pp
5843051d27SRobert MustacchiThe character string
5943051d27SRobert Mustacchi.Fa delim
6043051d27SRobert Mustacchiwill be used as a delimiter between subsequent entries in the string
6143051d27SRobert Mustacchi.Fa set .
6243051d27SRobert MustacchiThe value of
6343051d27SRobert Mustacchi.Fa members
6443051d27SRobert Mustacchidetermines whether the entries in
6543051d27SRobert Mustacchi.Fa str
6643051d27SRobert Mustacchienable or disable entries in
6743051d27SRobert Mustacchi.Fa set .
6843051d27SRobert MustacchiIf
6943051d27SRobert Mustacchi.Fa members
7043051d27SRobert Mustacchiis zero, then
7143051d27SRobert Mustacchi.Fa set
7243051d27SRobert Mustacchiis filled in entirely and then each entry in
7343051d27SRobert Mustacchi.Fa str
7443051d27SRobert Mustacchicauses the corresponding entry to be disabled in
7543051d27SRobert Mustacchi.Fa set.
7643051d27SRobert MustacchiIf
7743051d27SRobert Mustacchi.Fa members
7843051d27SRobert Mustacchiis non-zero, then
7943051d27SRobert Mustacchi.Fa set
8043051d27SRobert Mustacchiis empty initially and for each entry in
8143051d27SRobert Mustacchi.Fa str
8243051d27SRobert Mustacchithe corresponding entry in
8343051d27SRobert Mustacchi.Fa set
8443051d27SRobert Mustacchiwill be enabled.
8543051d27SRobert Mustacchi.Pp
8643051d27SRobert MustacchiIf an unknown entry is encountered in
8743051d27SRobert Mustacchi.Fa str
8843051d27SRobert Mustacchithen the conversion will fail and a pointer to the first unknown
8943051d27SRobert Mustacchicharacter will be returned.
9043051d27SRobert Mustacchi.Sh RETURN VALUES
9143051d27SRobert MustacchiUpon successful completion,
9243051d27SRobert Mustacchi.Dv NULL
9343051d27SRobert Mustacchiis returned and
9443051d27SRobert Mustacchi.Fa set
9572d3dbb9SYuri Pankovis filled in.
9672d3dbb9SYuri PankovOtherwise, a pointer to the first unknown character is returned and
9743051d27SRobert Mustacchi.Sy errno
9843051d27SRobert Mustacchiis set to indicate the error.
9943051d27SRobert Mustacchi.Sh ERRORS
10043051d27SRobert MustacchiThe
10143051d27SRobert Mustacchi.Fn proc_str2fltset ,
10243051d27SRobert Mustacchi.Fn proc_str2sigset ,
10343051d27SRobert Mustacchiand
10443051d27SRobert Mustacchi.Fn proc_str2sigset
10543051d27SRobert Mustacchifunctions will fail if:
10643051d27SRobert Mustacchi.Bl -tag -width Er
10743051d27SRobert Mustacchi.It Er EINVAL
10843051d27SRobert Mustacchi.Fa str
10943051d27SRobert Mustacchicontains an unrecognized set name.
11043051d27SRobert Mustacchi.El
11143051d27SRobert Mustacchi.Sh INTERFACE STABILITY
11243051d27SRobert Mustacchi.Sy Uncommitted
11343051d27SRobert Mustacchi.Sh MT-LEVEL
11443051d27SRobert Mustacchi.Sy MT-Safe
11543051d27SRobert Mustacchi.Sh SEE ALSO
11643051d27SRobert Mustacchi.Xr libproc 3LIB ,
11743051d27SRobert Mustacchi.Xr proc_fltname 3PROC ,
11843051d27SRobert Mustacchi.Xr proc_fltset2str 3PROC ,
11943051d27SRobert Mustacchi.Xr proc_signame 3PROC ,
12043051d27SRobert Mustacchi.Xr proc_sigset2str 3PROC ,
12143051d27SRobert Mustacchi.Xr proc_str2flt 3PROC ,
12243051d27SRobert Mustacchi.Xr proc_str2sig 3PROC ,
12343051d27SRobert Mustacchi.Xr proc_str2sys 3PROC ,
12443051d27SRobert Mustacchi.Xr proc_sysname 3PROC ,
12543051d27SRobert Mustacchi.Xr proc_sysset2str 3PROC ,
126bbf21555SRichard Lowe.Xr proc 5
127