xref: /illumos-gate/usr/src/man/man3proc/proc_fltname.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.
13542a7b7fSCarlos Neira.\" Copyright (c) 2019 Carlos Neira <cneirabustos@gmail.com>
14542a7b7fSCarlos Neira.\" Copyright 2019 OmniOS Community Edition (OmniOSce) Association.
1543051d27SRobert Mustacchi.\"
16*a7d7cafeSRobert Mustacchi.Dd November 27, 2023
1743051d27SRobert Mustacchi.Dt PROC_FLTNAME 3PROC
1843051d27SRobert Mustacchi.Os
1943051d27SRobert Mustacchi.Sh NAME
2043051d27SRobert Mustacchi.Nm proc_fltname ,
2143051d27SRobert Mustacchi.Nm proc_signame ,
22542a7b7fSCarlos Neira.Nm proc_sysname ,
23542a7b7fSCarlos Neira.Nm proc_dmodelname
24542a7b7fSCarlos Neira.Nd convert a fault, signal, system call and data model to a name
25*a7d7cafeSRobert Mustacchi.Sh LIBRARY
2643051d27SRobert Mustacchi.Lb libproc
27*a7d7cafeSRobert Mustacchi.Sh SYNOPSIS
2843051d27SRobert Mustacchi.In libproc.h
2943051d27SRobert Mustacchi.Ft "char *"
3043051d27SRobert Mustacchi.Fo proc_fltname
3143051d27SRobert Mustacchi.Fa "int flt"
3243051d27SRobert Mustacchi.Fa "char *buf"
3343051d27SRobert Mustacchi.Fa "size_t bufsz"
3443051d27SRobert Mustacchi.Fc
3543051d27SRobert Mustacchi.Ft "char *"
3643051d27SRobert Mustacchi.Fo proc_signame
3743051d27SRobert Mustacchi.Fa "int sig"
3843051d27SRobert Mustacchi.Fa "char *buf"
3943051d27SRobert Mustacchi.Fa "size_t bufsz"
4043051d27SRobert Mustacchi.Fc
4143051d27SRobert Mustacchi.Ft "char *"
4243051d27SRobert Mustacchi.Fo proc_sysname
4343051d27SRobert Mustacchi.Fa "int sys"
4443051d27SRobert Mustacchi.Fa "char *buf"
4543051d27SRobert Mustacchi.Fa "size_t bufsz"
4643051d27SRobert Mustacchi.Fc
47542a7b7fSCarlos Neira.Ft "char *"
48542a7b7fSCarlos Neira.Fo proc_dmodelname
49542a7b7fSCarlos Neira.Fa "int dmodel"
50542a7b7fSCarlos Neira.Fa "char *buf"
51542a7b7fSCarlos Neira.Fa "size_t bufsz"
52542a7b7fSCarlos Neira.Fc
5343051d27SRobert Mustacchi.Sh DESCRIPTION
5443051d27SRobert MustacchiThe
5543051d27SRobert Mustacchi.Fn proc_fltname ,
5643051d27SRobert Mustacchi.Fn proc_signame ,
5743051d27SRobert Mustacchi.Fn proc_sysname
58542a7b7fSCarlos Neiraand
59542a7b7fSCarlos Neira.Fn proc_dmodelname
60542a7b7fSCarlos Neirafunctions respectively convert the fault, signal, system call and data model in
6143051d27SRobert Mustacchi.Fa flt ,
6243051d27SRobert Mustacchi.Fa sig ,
6343051d27SRobert Mustacchi.Fa sys
64542a7b7fSCarlos Neiraand
65542a7b7fSCarlos Neira.Fa dmodel
6643051d27SRobert Mustacchito a human-readable name and place the corresponding string in
6743051d27SRobert Mustacchi.Fa buf .
6843051d27SRobert MustacchiUp to
6943051d27SRobert Mustacchi.Fa bufsz
7043051d27SRobert Mustacchicharacters, including the null terminator, will be written into
7143051d27SRobert Mustacchi.Fa buf .
7243051d27SRobert Mustacchi.Sh RETURN VALUES
7343051d27SRobert MustacchiUpon successful completion, the
7443051d27SRobert Mustacchi.Fn proc_fltname ,
7543051d27SRobert Mustacchi.Fn proc_signame ,
7643051d27SRobert Mustacchi.Fn proc_sysname
77542a7b7fSCarlos Neiraand
78542a7b7fSCarlos Neira.Fn proc_dmodelname
7943051d27SRobert Mustacchifunctions return a pointer to
8043051d27SRobert Mustacchi.Fa buf .
8143051d27SRobert MustacchiThe contents of
8243051d27SRobert Mustacchi.Fa buf
8343051d27SRobert Mustacchiare always null terminated.
8443051d27SRobert MustacchiOtherwise,
8543051d27SRobert Mustacchi.Dv NULL
8643051d27SRobert Mustacchiis returned.
8743051d27SRobert Mustacchi.Sh INTERFACE STABILITY
8843051d27SRobert Mustacchi.Sy Uncommitted
8943051d27SRobert Mustacchi.Sh MT-LEVEL
9043051d27SRobert Mustacchi.Sy MT-Safe
9143051d27SRobert Mustacchi.Sh SEE ALSO
9243051d27SRobert Mustacchi.Xr libproc 3LIB ,
9343051d27SRobert Mustacchi.Xr proc_fltset2str 3PROC ,
9443051d27SRobert Mustacchi.Xr proc_sigset2str 3PROC ,
9543051d27SRobert Mustacchi.Xr proc_str2flt 3PROC ,
9643051d27SRobert Mustacchi.Xr proc_str2fltset 3PROC ,
9743051d27SRobert Mustacchi.Xr proc_str2sig 3PROC ,
9843051d27SRobert Mustacchi.Xr proc_str2sigset 3PROC ,
9943051d27SRobert Mustacchi.Xr proc_str2sys 3PROC ,
10043051d27SRobert Mustacchi.Xr proc_str2sysset 3PROC ,
10143051d27SRobert Mustacchi.Xr proc_sysset2str 3PROC ,
102bbf21555SRichard Lowe.Xr proc 5
103