tripathysagar/man_text huggingface dataset:
# sd_booted

## NAME



           sd_booted - Test whether the system is running the systemd init
           system
    


## SYNOPSIS



           **#include <systemd/sd-daemon.h>**
    
           **int sd_booted(void);**
    


## DESCRIPTION



           **sd_booted()** checks whether the system was booted up using the
           systemd init system.
    


## RETURN VALUE



           On failure, this call returns a negative errno-style error code.
           If the system was booted up with systemd as init system, this call
           returns a positive return value, zero otherwise.
    


## NOTES



           Functions described here are available as a shared library, which
           can be compiled against and linked to with the
           **libsystemd pkg-config**(1) file.
    
           Internally, this function checks whether the directory
           /run/systemd/system/ exists. A simple check like this can also be
           implemented trivially in shell or any other language.
    


* * *
# isnan

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           isnan — test for a NaN
    


## SYNOPSIS



           #include <math.h>
    
           int isnan(real-floating _x_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           The _isnan_() macro shall determine whether its argument value is a
           NaN. First, an argument represented in a format wider than its
           semantic type is converted to its semantic type. Then
           determination is based on the type of the argument.
    


## RETURN VALUE



           The _isnan_() macro shall return a non-zero value if and only if its
           argument has a NaN value.
    


## ERRORS



           No errors are defined.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# libpfm_intel_hswep_unc_ha

## NAME



           libpfm_intel_hswep_unc_ha - support for Intel Haswell-EP Home
           Agent (HA) uncore PMU
    


## SYNOPSIS



           **#include <perfmon/pfmlib.h>**
    
           **PMU name: hswep_unc_ha0, hswep_unc_ha1**
           **PMU desc: Intel Haswell-EP HA uncore PMU**
    


## DESCRIPTION



           The library supports the Intel Haswell Home Agent (HA) uncore PMU.
           This PMU model only exists on Haswell model 63.
    


## MODIFIERS



           The following modifiers are supported on Intel Haswell HA uncore
           PMU:
    
           **e** Enable edge detection, i.e., count only when there is a
                  state transition from no occurrence of the event to at
                  least one occurrence. This modifier must be combined with a
                  threshold modifier (t) with a value greater or equal to
                  one.  This is a boolean modifier.
    
           **t** Set the threshold value. When set to a non-zero value, the
                  counter counts the number of HA cycles in which the number
                  of occurrences of the event is greater or equal to the
                  threshold.  This is an integer modifier with values in the
                  range [0:255].
    
           **i** Invert the meaning of the threshold or edge filter. If set,
                  the event counts when strictly less than N occurrences
                  occur per cycle if threshold is set to N. When invert is
                  set, then threshold must be set to non-zero value. If set,
                  the event counts when the event transitions from occurring
                  to not occurring (falling edge) when edge detection is set.
                  This is a boolean modifier
    


* * *
# sd_bus_add_object_manager

## NAME



           sd_bus_add_object_manager - Add a D-Bus object manager for a D-Bus
           object sub-tree
    


## SYNOPSIS



           **#include <systemd/sd-bus.h>**
    
           **int sd_bus_add_object_manager(sd_bus ***_bus_**, sd_bus_slot ****_slot_**,**
                                         **const char ***_path_**);**
    


## DESCRIPTION



           **sd_bus_add_object_manager()** installs a handler for the given path
           that implements the **GetManagedObjects()** method of the
           **org.freedesktop.DBus.ObjectManager** interface. See
           **org.freedesktop.DBus.ObjectManager******[1] for more information.
    
           To implement the**InterfacesAdded** and **InterfacesRemoved** signals of
           the **org.freedesktop.DBus.ObjectManager** interface, call
           sd_bus_emit_interfaces_added(3) and
           sd_bus_emit_interfaces_removed(3) whenever interfaces are added or
           removed from the sub-tree, respectively.
    
           When **sd_bus_add_object_manager()** succeeds, a slot is created
           internally. If the output parameter _slot_ is **NULL** , a "floating"
           slot object is created, see sd_bus_slot_set_floating(3).
           Otherwise, a pointer to the slot object is returned. In that case,
           the reference to the slot object should be dropped when the object
           manager is not needed anymore, see sd_bus_slot_unref(3).
    


## RETURN VALUE



           On success, **sd_bus_add_object_manager()** returns a non-negative
           integer. On failure, it returns a negative errno-style error code.
    
       **Errors**
           Returned errors may indicate the following problems:
    
           **-EINVAL**
               One of the required parameters is **NULL** or _path_ is not a valid
               object path.
    
           **-ENOPKG**
               The bus cannot be resolved.
    
           **-ECHILD**
               The bus was created in a different process, library or module
               instance.
    
           **-ENOMEM**
               Memory allocation failed.
    


## NOTES



           Functions described here are available as a shared library, which
           can be compiled against and linked to with the
           **libsystemd pkg-config**(1) file.
    
           The code described here uses getenv(3), which is declared to be
           not multi-thread-safe. This means that the code calling the
           functions described here must not call setenv(3) from a parallel
           thread. It is recommended to only do calls to **setenv()** from an
           early phase of the program when no other threads have been
           started.
    


## NOTES



            1. org.freedesktop.DBus.ObjectManager
               https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager
    


* * *
# mlx5dv_is_supported

## NAME



           mlx5dv_is_supported - Check whether an RDMA device implemented by
           the mlx5 provider
    


## SYNOPSIS



                  #include <infiniband/mlx5dv.h>
    
                  bool mlx5dv_is_supported(struct ibv_device *device);
    


## DESCRIPTION



           mlx5dv functions may be called only if this function returns true
           for the RDMA device.
    


## ARGUMENTS



           _device_ RDMA device to check.
    


## RETURN VALUE



           Returns true if device is implemented by mlx5 provider.
    


* * *
# gnutls_srtp_get_profile_id

## NAME



           gnutls_srtp_get_profile_id - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **int gnutls_srtp_get_profile_id(const char ***_name_**,**
           **gnutls_srtp_profile_t ***_profile_**);**
    


## ARGUMENTS



           const char * name
                       The name of the profile to look up
    
           gnutls_srtp_profile_t * profile
                       Will hold the profile id
    


## DESCRIPTION



           This function allows you to look up a profile based on a string.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error code is returned.
    
           Since 3.1.4
    


* * *
# pmctime

## NAME



           **pmCtime** - format the date and time for a reporting timezone
    


## C SYNOPSIS



           **#include <time.h>**
           **#include <pcp/pmapi.h>**
    
           **char *pmCtime(const time_t ***_clock_**, char ***_buf_**);**
    
           **cc ... -lpcp**
    


## DESCRIPTION



           **pmCtime** is  very similar to ctime(3), except the timezone used is
           the current ``reporting timezone'' (rather than the default **TZ** en‐
           vironment variable scheme), and the  result  is  returned  into  a
           caller-declared buffer (rather than a private buffer).
    
           Like  ctime(3)  the  time to be converted is passed via _clock_ , and
           the result in _buf_ is fixed width fields in the format:
    
                     Fri Sep 13 00:00:00 1986\n\0
    
           The result buffer _buf_ must be at least 26 bytes long, and  no  at‐
           tempt  is made to check this.  **pmCtime** returns _buf_ as the value of
           the function.
    
           The default current reporting timezone is as defined by the **TZ** en‐
           vironment variable, so **pmCtime** and ctime(3) will initially produce
           similar encoding of the date and time.
    
           Use pmNewZone(3), pmNewContextZone(3) or pmUseZone(3) to establish
           a new current reporting timezone that will effect **pmCtime** but  not
           ctime(3).
    


* * *
# probe::signal.force_segv

## NAME



           probe::signal.force_segv - Forcing send of SIGSEGV
    


## SYNOPSIS



           signal.force_segv
    


## VALUES



           _pid_name_
               Name of the process receiving the signal
    
           _sig_pid_
               The PID of the process receiving the signal
    
           _sig_name_
               A string representation of the signal
    
           _name_
               Name of the probe point
    
           _sig_
               The number of the signal
    


* * *
# mlx5dv_devx_get_event

## NAME



           mlx5dv_devx_get_event - Get an asynchronous event.
    


## SYNOPSIS



                  #include <infiniband/mlx5dv.h>
    
                  struct mlx5dv_devx_async_event_hdr {
                      uint64_t    cookie;
                      uint8_t     out_data[];
                  };
    
                  ssize_t mlx5dv_devx_get_event(struct mlx5dv_devx_event_channel *event_channel,
                                                struct mlx5dv_devx_async_event_hdr *event_data,
                                                size_t event_resp_len)
    


## DESCRIPTION



           Get a device event on the given _event_channel_.  Post a successful
           subscription over the event channel by calling to
           mlx5dv_devx_subscribe_devx_event() the application should use this
           API to get the response once an event has occurred.
    
           Upon response the _cookie_ that was supplied upon the subscription
           is returned and the _out_data_ includes the data itself.  The
           _out_data_ may be omitted in case the channel was created with the
           omit data flag.
    
           The application must supply a large enough buffer to hold the
           event according to the device specification, the buffer size is
           given by the input _event_resp_len_ parameter.
    


## ARGUMENTS



           _event_channel_
    
                  The channel to get the event over.
    
           _event_data_
                  The output data from the asynchronous event.
    
           _event_resp_len_
                  The output buffer size to hold the response.
    


## RETURN VALUE



           Upon success _mlx5dv_devx_get_event_ will return the number of bytes
           read, otherwise -1 will be returned and errno was set.
    


## NOTES



           In case the _event_channel_ was created with the omit data flag,
           events having the same type may be combined per subscription and
           be reported once with the matching _cookie_.  In that mode of work,
           ordering is not preserved between those events to other on this
           channel.
    
           On the other hand, when each event should hold the device data
           ordering is preserved, however, events might be loose as of lack
           of kernel memory, in that case EOVERFLOW will be reported.
    


* * *
# gnutls_x509_spki_init

## NAME



           gnutls_x509_spki_init - API function
    


## SYNOPSIS



           **#include <gnutls/x509.h>**
    
           **int gnutls_x509_spki_init(gnutls_x509_spki_t ***_spki_**);**
    


## ARGUMENTS



           gnutls_x509_spki_t * spki
                       A pointer to the type to be initialized
    


## DESCRIPTION



           This function will initialize a SubjectPublicKeyInfo structure
           used in PKIX. The structure is used to set additional parameters
           in the public key information field of a certificate.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


## SINCE



           3.6.0
    


* * *
# gnutls_dh_params_import_pkcs3

## NAME



           gnutls_dh_params_import_pkcs3 - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **int gnutls_dh_params_import_pkcs3(gnutls_dh_params_t** _params_**, const**
           **gnutls_datum_t ***_pkcs3_params_**, gnutls_x509_crt_fmt_t** _format_**);**
    


## ARGUMENTS



           gnutls_dh_params_t params
                       The parameters
    
           const gnutls_datum_t * pkcs3_params
                       should contain a PKCS3 DHParams structure PEM or DER
                       encoded
    
           gnutls_x509_crt_fmt_t format
                       the format of params. PEM or DER.
    


## DESCRIPTION



           This function will extract the DHParams found in a PKCS3 formatted
           structure. This is the format generated by "openssl dhparam" tool.
    
           If the structure is PEM encoded, it should have a header of "BEGIN
           DH PARAMETERS".
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error code is returned.
    


* * *
# tapset::irq

## NAME



           tapset::irq - systemtap irq tapset
    


## DESCRIPTION



           **workqueue.create**
                  Creating a new workqueue
    
                   See probe::workqueue.create(3stap)
                   for details.
    
           **workqueue.insert**
                  Queuing work on a workqueue
    
                   See probe::workqueue.insert(3stap)
                   for details.
    
           **workqueue.execute**
                  Executing deferred work
    
                   See probe::workqueue.execute(3stap)
                   for details.
    
           **workqueue.destroy**
                  Destroying workqueue
    
                   See probe::workqueue.destroy(3stap)
                   for details.
    
           **irq_handler.entry**
                  Execution of interrupt handler starting
    
                   See probe::irq_handler.entry(3stap)
                   for details.
    
           **irq_handler.exit**
                  Execution of interrupt handler completed
    
                   See probe::irq_handler.exit(3stap)
                   for details.
    
           **softirq.entry**
                  Execution of handler for a pending softirq starting
    
                   See probe::softirq.entry(3stap)
                   for details.
    
           **softirq.exit**
                  Execution of handler for a pending softirq completed
    
                   See probe::softirq.exit(3stap)
                   for details.
    


* * *
# gnutls_ocsp_resp_import2

## NAME



           gnutls_ocsp_resp_import2 - API function
    


## SYNOPSIS



           **#include <gnutls/ocsp.h>**
    
           **int gnutls_ocsp_resp_import2(gnutls_ocsp_resp_t** _resp_**, const**
           **gnutls_datum_t ***_data_**, gnutls_x509_crt_fmt_t** _fmt_**);**
    


## ARGUMENTS



           gnutls_ocsp_resp_t resp
                       The data to store the parsed response.
    
           const gnutls_datum_t * data
                       DER or PEM encoded OCSP response.
    
           gnutls_x509_crt_fmt_t fmt
                       DER or PEM
    


## DESCRIPTION



           This function will convert the given OCSP response to the native
           **gnutls_ocsp_resp_t** format.  It also decodes the Basic OCSP
           Response part, if any.  The output will be stored in  _resp_ .
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


## SINCE



           3.6.3
    


* * *
# probe::tcpmib.CurrEstab

## NAME



           probe::tcpmib.CurrEstab - Update the count of open sockets
    


## SYNOPSIS



           tcpmib.CurrEstab
    


## VALUES



           _sk_
               pointer to the struct sock being acted on
    
           _op_
               value to be added to the counter (default value of 1)
    


## DESCRIPTION



           The packet pointed to by _skb_ is filtered by the function
           **tcpmib_filter_key**. If the packet passes the filter is is counted
           in the global _CurrEstab_ (equivalent to SNMP's MIB
           TCP_MIB_CURRESTAB)
    


* * *
# gnutls_pkcs11_reinit

## NAME



           gnutls_pkcs11_reinit - API function
    


## SYNOPSIS



           **#include <gnutls/pkcs11.h>**
    
           **int gnutls_pkcs11_reinit(**_void_**);**
    


## ARGUMENTS



            void
    


## DESCRIPTION



           This function will reinitialize the PKCS 11 subsystem in gnutls.
           This is required by PKCS 11 when an application uses **fork()**. The
           reinitialization function must be called on the child.
    
           Note that since GnuTLS 3.3.0, the reinitialization of the PKCS **11**
           subsystem occurs automatically after fork.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


## SINCE



           3.0
    


* * *
# function::ipmib_tcp_remote_port

## NAME



           function::ipmib_tcp_remote_port - Get the remote tcp port
    


## SYNOPSIS



               ipmib_tcp_remote_port:long(skb:long,SourceIsLocal:long)
    


## ARGUMENTS



           _skb_
               pointer to a struct sk_buff
    
           _SourceIsLocal_
               flag to indicate whether local operation
    


## DESCRIPTION



           Returns the remote tcp port from _skb_.
    


* * *
# gnutls_server_name_set

## NAME



           gnutls_server_name_set - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **int gnutls_server_name_set(gnutls_session_t** _session_**,**
           **gnutls_server_name_type_t** _type_**, const void ***_name_**, size_t**
           _name_length_**);**
    


## ARGUMENTS



           gnutls_session_t session
                       is a **gnutls_session_t** type.
    
           gnutls_server_name_type_t type
                       specifies the indicator type
    
           const void * name
                       is a string that contains the server name.
    
           size_t name_length
                       holds the length of name excluding the terminating
                       null byte
    


## DESCRIPTION



           This function is to be used by clients that want to inform (via a
           TLS extension mechanism) the server of the name they connected to.
           This should be used by clients that connect to servers that do
           virtual hosting.
    
           The value of  _name_ depends on the  _type_ type.  In case of
           **GNUTLS_NAME_DNS** , a UTF-8 null-terminated domain name string,
           without the trailing dot, is expected.
    
           IPv4 or IPv6 addresses are not permitted to be set by this
           function.  If the function is called with a name of  _name_length_
           zero it will clear all server names set.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error code is returned.
    


* * *
# gnutls_cipher_encrypt

## NAME



           gnutls_cipher_encrypt - API function
    


## SYNOPSIS



           **#include <gnutls/crypto.h>**
    
           **int gnutls_cipher_encrypt(gnutls_cipher_hd_t** _handle_**, void ***_ptext_**,**
           **size_t** _ptext_len_**);**
    


## ARGUMENTS



           gnutls_cipher_hd_t handle
                       is a **gnutls_cipher_hd_t** type
    
           void * ptext
                       the data to encrypt
    
           size_t ptext_len
                       the length of data to encrypt
    


## DESCRIPTION



           This function will encrypt the given data using the algorithm
           specified by the context.
    


## RETURNS



           Zero or a negative error code on error.
    


## SINCE



           2.10.0
    


* * *
# gnutls_pkcs12_bag_encrypt

## NAME



           gnutls_pkcs12_bag_encrypt - API function
    


## SYNOPSIS



           **#include <gnutls/pkcs12.h>**
    
           **int gnutls_pkcs12_bag_encrypt(gnutls_pkcs12_bag_t** _bag_**, const char**
           *****_pass_**, unsigned int** _flags_**);**
    


## ARGUMENTS



           gnutls_pkcs12_bag_t bag
                       The bag
    
           const char * pass
                       The password used for encryption, must be ASCII
    
           unsigned int flags
                       should be one of **gnutls_pkcs_encrypt_flags_t** elements
                       bitwise or'd
    


## DESCRIPTION



           This function will encrypt the given bag.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error code is returned.
    


* * *
# audit_request_signal_info

## NAME



           audit_request_signal_info - Request signal info for the audit
           system
    


## SYNOPSIS



           **#include <libaudit.h>**
    
           **int audit_request_signal_info(int** _fd);"_
    


## DESCRIPTION



           audit_request_signal_info requests that the kernel send
           information about the sender of a signal to the audit daemon. The
           signal info structure is as follows:
    
           struct audit_sig_info {
                   uid_t           uid;
                   pid_t           pid;
                   char            ctx[0];
           };
    
           This function is likely to be used only by audit daemons and
           shouldn't be called by any other kind of program.
    


## RETURN VALUE



           The return value is <= 0 on error, otherwise it is the netlink
           sequence id number. This function can have any error that sendto
           would encounter.
    


* * *
# mitem_current

## NAME



           **mitem_current** - set and get current_menu_item
    


## SYNOPSIS



           **#include <menu.h>**
    
           **int set_current_item(MENU ***_menu_**, ITEM ***_item_**);**
           **ITEM *current_item(const MENU ***_menu_**);**
    
           **int set_top_row(MENU ***_menu_**, int** _row_**);**
           **int top_row(const MENU ***_menu_**);**
    
           **int item_index(const ITEM ***_item_**);**
    


## DESCRIPTION



           The function **set_current_item** sets the current item (the item on
           which the menu cursor is positioned).  **current_item** returns a
           pointer to the current item in the given menu.
    
           The function **set_top_row** sets the top row of the menu to show the
           given row (the top row is initially 0, and is reset to this value
           whenever the **O_ROWMAJOR** option is toggled).  The item leftmost on
           the given row becomes current.  The function **top_row** returns the
           number of the top menu row being displayed.
    
           The function **item_index** returns the (zero-origin) index of _item_ in
           the menu's item pointer list.
    


## RETURN VALUE



           **current_item** returns a pointer (which may be **NULL**).  It does not
           set **errno**.
    
           **top_row** and **item_index** return **ERR**(the general **curses** error value)
           if their _menu_ parameter is **NULL**.
    
           **set_current_item** and **set_top_row** return one of the following:
    
           **E_OK** The routine succeeded.
    
           **E_BAD_ARGUMENT**
                Routine detected an incorrect or out-of-range argument.
    
           **E_BAD_STATE**
                Routine was called from an initialization or termination
                function.
    
           **E_NOT_CONNECTED**
                No items are connected to the menu.
    
           **E_SYSTEM_ERROR**
                System error occurred (see errno(3)).
    


## NOTES



           The header file **< menu.h> **automatically includes the header file
           **< curses.h>**.
    


## PORTABILITY



           These routines emulate the System V menu library.  They were not
           supported on Version 7 or BSD versions.
    
           The SVr4 menu library documentation specifies the **top_row** and
           **index_item** error value as -1 (which is the value of **ERR**).
    


* * *
# find_key_by_type_and_name

## NAME



           find_key_by_type_and_name - find a key by type and name
    


## SYNOPSIS



           **#include <keyutils.h>**
    
           **key_serial_t find_key_by_type_and_name(const char ***_type_**,**
               **const char ***_description_**, key_serial_t** _destringid_**);**
    


## DESCRIPTION



           **find_key_by_type_and_name**() searches for a key with the given _type_
           and exact _description_ , firstly in the thread, process and session
           keyrings to which a process is subscribed and secondly in
           _/proc/keys_.
    
           If a key is found, and _destringid_ is not 0 and specifies a
           keyring, then the found key will be linked into it.
    


## RETURN VALUE



           The function returns the ID of the key if a key was found or -1
           otherwise.
    


## ERRORS



           **ENOKEY** No key was found or the keyring specified is invalid.
    
           **EKEYEXPIRED**
                  The key or keyring have expired.
    
           **EKEYREVOKED**
                  The key or keyring have been revoked.
    
           **EACCES** The key is not accessible or keyring exists, but is not
                  **writable** by the calling process.
    


## LINKING



           When linking, **-lkeyutils** should be specified to the linker.
    


* * *
# size_t

## NAME



           size_t, ssize_t - count of bytes
    


## LIBRARY



           Standard C library (_libc_)
    


## SYNOPSIS



           **#include <stddef.h>**
    
           **typedef** /* ... */  **size_t;**
    
           **#include <sys/types.h>**
    
           **typedef** /* ... */  **ssize_t;**
    


## DESCRIPTION



           _size_t_ Used for a count of bytes.  It is the result of the
                  _sizeof_() operator.  It is an unsigned integer type capable
                  of storing values in the range [**0** , **SIZE_MAX**].
    
           _ssize_t_
                  Used for a count of bytes or an error indication.  It is a
                  signed integer type capable of storing values at least in
                  the range [**-1** , **SSIZE_MAX**].
    
       **Use with printf(3) and scanf(3)**
           _size_t_ The length modifier for _size_t_ for the printf(3) and the
                  scanf(3) families of functions is **z** , resulting commonly in
                  **%zu** or **%zx** for printing _size_t_ values.
    
           _ssize_t_
                  glibc and most other implementations provide a length
                  modifier for _ssize_t_ for the printf(3) and the scanf(3)
                  families of functions, which is **z** ; resulting commonly in
                  **%zd** or **%zi** for printing _ssize_t_ values.  Although **z** works
                  for _ssize_t_ on most implementations, portable POSIX
                  programs should avoid using it—for example, by converting
                  the value to _intmax_t_ and using its length modifier (**j**).
    


## STANDARDS



           _size_t_ C11, POSIX.1-2008.
    
           _ssize_t_
                  POSIX.1-2008.
    


## NOTES



           _size_t_ The following headers also provide _size_t_ : _< aio.h>_,
                  _< glob.h>_, _< grp.h>_, _< iconv.h>_, _< monetary.h>_, _< mqueue.h>_,
                  _< ndbm.h>_, _< pwd.h>_, _< regex.h>_, _< search.h>_, _< signal.h>_,
                  _< stdio.h>_, _< stdlib.h>_, _< string.h>_, _< strings.h>_,
                  _< sys/mman.h>_, _< sys/msg.h>_, _< sys/sem.h>_, _< sys/shm.h>_,
                  _< sys/socket.h>_, _< sys/types.h>_, _< sys/uio.h>_, _< time.h>_,
                  _< unistd.h>_, _< wchar.h>_, and _< wordexp.h>_.
    
           _ssize_t_
                  The following headers also provide _ssize_t_ : _< aio.h>_,
                  _< monetary.h>_, _< mqueue.h>_, _< stdio.h>_, _< sys/msg.h>_,
                  _< sys/socket.h>_, _< sys/uio.h>_, and _< unistd.h>_.
    


* * *
# pmprintdesc

## NAME



           **pmPrintDesc** - print a metric descriptor
    


## C SYNOPSIS



           **#include <pcp/pmapi.h>**
    
           **void pmPrintDesc(FILE ***_f_**, const pmDesc ***_desc_**);**
    
           **cc ... -lpcp**
    


## DESCRIPTION



           Display all the fields of the Performance Metrics Descriptor _desc_
           on the output stream _f_.
    


* * *
# tapset::ioscheduler

## NAME



           tapset::ioscheduler - systemtap ioscheduler tapset
    


## DESCRIPTION



            This family of probe points is used to probe IO scheduler
           activities.
    
           **ioscheduler.elv_next_request**
                  Fires when a request is retrieved from the request queue
    
                   See probe::ioscheduler.elv_next_request(3stap)
                   for details.
    
           **ioscheduler.elv_next_request.return**
                  Fires when a request retrieval issues a return signal
    
                   See probe::ioscheduler.elv_next_request.return(3stap)
                   for details.
    
           **ioscheduler.elv_completed_request**
                  Fires when a request is completed
    
                   See probe::ioscheduler.elv_completed_request(3stap)
                   for details.
    
           **ioscheduler.elv_add_request.kp**
                  kprobe based probe to indicate that a request was added to
                  the request queue
    
                   See probe::ioscheduler.elv_add_request.kp(3stap)
                   for details.
    
           **ioscheduler.elv_add_request.tp**
                  tracepoint based probe to indicate a request is added to
                  the request queue.
    
                   See probe::ioscheduler.elv_add_request.tp(3stap)
                   for details.
    
           **ioscheduler.elv_add_request**
                  probe to indicate request is added to the request queue.
    
                   See probe::ioscheduler.elv_add_request(3stap)
                   for details.
    
           **ioscheduler_trace.elv_completed_request**
                  Fires when a request is
    
                   See probe::ioscheduler_trace.elv_completed_request(3stap)
                   for details.
    
           **ioscheduler_trace.elv_issue_request**
                  Fires when a request is
    
                   See probe::ioscheduler_trace.elv_issue_request(3stap)
                   for details.
    
           **ioscheduler_trace.elv_requeue_request**
                  Fires when a request is
    
                   See probe::ioscheduler_trace.elv_requeue_request(3stap)
                   for details.
    
           **ioscheduler_trace.elv_abort_request**
                  Fires when a request is aborted.
    
                   See probe::ioscheduler_trace.elv_abort_request(3stap)
                   for details.
    
           **ioscheduler_trace.plug**
                  Fires when a request queue is plugged;
    
                   See probe::ioscheduler_trace.plug(3stap)
                   for details.
    
           **ioscheduler_trace.unplug_io**
                  Fires when a request queue is unplugged;
    
                   See probe::ioscheduler_trace.unplug_io(3stap)
                   for details.
    
           **ioscheduler_trace.unplug_timer**
                  Fires when unplug timer associated
    
                   See probe::ioscheduler_trace.unplug_timer(3stap)
                   for details.
    


* * *
# pcre2_substring_list_free

## NAME



           PCRE2 - Perl-compatible regular expressions (revised API)
    


## SYNOPSIS



    
           **#include <pcre2.h>**
    
           **void pcre2_substring_list_free(PCRE2_UCHAR ****_list_**);**
    


## DESCRIPTION



    
           This is a convenience function for freeing the store obtained by a
           previous call to **pcre2substring_list_get()**. Its only argument is a
           pointer to the list of string pointers. If the argument is NULL,
           the function returns immediately, without doing anything.
    
           There is a complete description of the PCRE2 native API in the
           **pcre2api** page and a description of the POSIX API in the **pcre2posix**
           page.
    


* * *
# offsetof

## NAME



           offsetof - offset of a structure member
    


## LIBRARY



           Standard C library (_libc_ , _-lc_)
    


## SYNOPSIS



           **#include <stddef.h>**
    
           **size_t offsetof(**_type_**,**_member_**);**
    


## DESCRIPTION



           The macro **offsetof**() returns the offset of the field _member_ from
           the start of the structure _type_.
    
           This macro is useful because the sizes of the fields that compose
           a structure can vary across implementations, and compilers may
           insert different numbers of padding bytes between fields.
           Consequently, an element's offset is not necessarily given by the
           sum of the sizes of the previous elements.
    
           A compiler error will result if _member_ is not aligned to a byte
           boundary (i.e., it is a bit field).
    


## RETURN VALUE



           **offsetof**() returns the offset of the given _member_ within the given
           _type_ , in units of bytes.
    


## STANDARDS



           C11, POSIX.1-2008.
    


## EXAMPLES



           On a Linux/i386 system, when compiled using the default gcc(1)
           options, the program below produces the following output:
    
               $ **./a.out**
               offsets: i=0; c=4; d=8 a=16
               sizeof(struct s)=16
    
       **Program source**
    
           #include <stddef.h>
           #include <stdio.h>
           #include <stdlib.h>
    
           int
           main(void)
           {
               struct s {
                   int i;
                   char c;
                   double d;
                   char a[];
               };
    
               /* Output is compiler dependent */
    
               printf("offsets: i=%zu; c=%zu; d=%zu a=%zu\n",
                      offsetof(struct s, i), offsetof(struct s, c),
                      offsetof(struct s, d), offsetof(struct s, a));
               printf("sizeof(struct s)=%zu\n", sizeof(struct s));
    
               exit(EXIT_SUCCESS);
           }
    


* * *
# gnutls_x509_crt_get_issuer_unique_id

## NAME



           gnutls_x509_crt_get_issuer_unique_id - API function
    


## SYNOPSIS



           **#include <gnutls/x509.h>**
    
           **int gnutls_x509_crt_get_issuer_unique_id(gnutls_x509_crt_t** _crt_**,**
           **char ***_buf_**, size_t ***_buf_size_**);**
    


## ARGUMENTS



           gnutls_x509_crt_t crt
                       Holds the certificate
    
           char * buf  user allocated memory buffer, will hold the unique id
    
           size_t * buf_size
                       size of user allocated memory buffer (on input), will
                       hold actual size of the unique ID on return.
    


## DESCRIPTION



           This function will extract the issuerUniqueID value (if present)
           for the given certificate.
    
           If the user allocated memory buffer is not large enough to hold
           the full subjectUniqueID, then a GNUTLS_E_SHORT_MEMORY_BUFFER
           error will be returned, and buf_size will be set to the actual
           length.
    
           This function had a bug prior to 3.4.8 that prevented the setting
           of **NULL** _buf_ to discover the  _buf_size_ . To use this function
           safely with the older versions the  _buf_ must be a valid buffer
           that can hold at least a single byte if  _buf_size_ is zero.
    


## RETURNS



           **GNUTLS_E_SUCCESS** on success, otherwise a negative error code.
    


## SINCE



           2.12.0
    


* * *
# dane_query_tlsa

## NAME



           dane_query_tlsa - API function
    


## SYNOPSIS



           **#include <gnutls/dane.h>**
    
           **int dane_query_tlsa(dane_state_t** _s_**, dane_query_t ***_r_**, const char ***
           _host_**, const char ***_proto_**, unsigned int** _port_**);**
    


## ARGUMENTS



           dane_state_t s
                       The DANE state structure
    
           dane_query_t * r
                       A structure to place the result
    
           const char * host
                       The host name to resolve.
    
           const char * proto
                       The protocol type (tcp, udp, etc.)
    
           unsigned int port
                       The service port number (eg. 443).
    


## DESCRIPTION



           This function will query the DNS server for the TLSA (DANE) data
           for the given host.
    


## RETURNS



           On success, **DANE_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


* * *
# probe::vm.kmem_cache_free

## NAME



           probe::vm.kmem_cache_free - Fires when kmem_cache_free is
           requested
    


## SYNOPSIS



           vm.kmem_cache_free
    


## VALUES



           _caller_function_
               Name of the caller function.
    
           _call_site_
               Address of the function calling this kmemory function
    
           _ptr_
               Pointer to the kmemory allocated which is returned by
               kmem_cache
    
           _name_
               Name of the probe point
    


* * *
# function::delete_stopwatch

## NAME



           function::delete_stopwatch - Remove an existing stopwatch
    


## SYNOPSIS



               delete_stopwatch(name:string)
    


## ARGUMENTS



           _name_
               the stopwatch name
    


## DESCRIPTION



           Remove stopwatch _name_.
    


* * *
# sd_bus_message_read_array

## NAME



           sd_bus_message_read_array - Access an array of elements in a
           message
    


## SYNOPSIS



           **#include <systemd/sd-bus.h>**
    
           **int sd_bus_message_read_array(sd_bus_message ***_m_**, char** _type_**,**
                                         **const void ****_ptr_**, size_t ***_size_**);**
    


## DESCRIPTION



           **sd_bus_message_read_array()** provides access to an array elements
           in the bus message _m_. The "read pointer" in the message must be
           right before an array of type _type_. As a special case, _type_ may be
           **NUL** , in which case any trivial type is acceptable. A pointer to
           the array data is returned in the parameter _ptr_ and the size of
           array data (in bytes) is returned in the parameter _size_. If the
           returned _size_ parameter is 0, a valid non-null pointer will be
           returned as _ptr_ , but it may not be dereferenced. The data is
           aligned as appropriate for the data type. The data is part of the
           message — it may not be modified and is valid only as long as the
           message is referenced. After this function returns, the "read
           pointer" points at the next element after the array.
    
           Note that this function only supports arrays of trivial types,
           i.e. arrays of booleans, the various integer types, as well as
           floating point numbers. In particular it may not be used for
           arrays of strings, structures or similar.
    


## RETURN VALUE



           On success and when an array was read, **sd_bus_message_read_array()**
           returns an integer greater than zero. If invoked while inside a
           container element (such as an array, e.g. when operating on an
           array of arrays) and the final element of the outer container has
           been read already and the read pointer is thus behind the last
           element of the outer container this call returns 0 (and the
           returned pointer will be **NULL** and the size will be 0). On failure,
           it returns a negative errno-style error code.
    
       **Errors**
           Returned errors may indicate the following problems:
    
           **-EINVAL**
               Specified type is invalid or not a trivial type (see above),
               or the message parameter or one of the output parameters are
               **NULL**.
    
           **-EOPNOTSUPP**
               The byte order in the message is different than native byte
               order.
    
           **-EPERM**
               The message is not sealed.
    
           **-EBADMSG**
               The message cannot be parsed.
    


* * *
# sched_getscheduler

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           sched_getscheduler — get scheduling policy (**REALTIME**)
    


## SYNOPSIS



           #include <sched.h>
    
           int sched_getscheduler(pid_t _pid_);
    


## DESCRIPTION



           The _sched_getscheduler_() function shall return the scheduling
           policy of the process specified by _pid_.  If the value of _pid_ is
           negative, the behavior of the _sched_getscheduler_() function is
           unspecified.
    
           The values that can be returned by _sched_getscheduler_() are
           defined in the _< sched.h>_ header.
    
           If a process specified by _pid_ exists, and if the calling process
           has permission, the scheduling policy shall be returned for the
           process whose process ID is equal to _pid_.
    
           If _pid_ is zero, the scheduling policy shall be returned for the
           calling process.
    


## RETURN VALUE



           Upon successful completion, the _sched_getscheduler_() function
           shall return the scheduling policy of the specified process.  If
           unsuccessful, the function shall return -1 and set _errno_ to
           indicate the error.
    


## ERRORS



           The _sched_getscheduler_() function shall fail if:
    
           **EPERM** The requesting process does not have permission to
                  determine the scheduling policy of the specified process.
    
           **ESRCH** No process can be found corresponding to that specified by
                  _pid_.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# mlx5dv_devx_free_uar

## NAME



           mlx5dv_devx_alloc_uar - Allocates a DEVX UAR
    
           mlx5dv_devx_free_uar - Frees a DEVX UAR
    


## SYNOPSIS



                  #include <infiniband/mlx5dv.h>
    
                  struct mlx5dv_devx_uar *mlx5dv_devx_alloc_uar(struct ibv_context *context,
                                                                uint32_t flags);
    
                  void mlx5dv_devx_free_uar(struct mlx5dv_devx_uar *devx_uar);
    


## DESCRIPTION



           Create / free a DEVX UAR which is needed for other device commands
           over the DEVX interface.
    
           The DEVX API enables direct access from the user space area to the
           mlx5 device driver, the UAR information is needed for few commands
           as of QP creation.
    


## ARGUMENTS



           _context_
                  RDMA device context to work on.
    
           _flags_  Allocation flags for the UAR.  MLX5DV_UAR_ALLOC_TYPE_BF:
                  Allocate UAR with Blueflame properties.
                  MLX5DV_UAR_ALLOC_TYPE_NC: Allocate UAR with non-cache
                  properties.  MLX5DV_UAR_ALLOC_TYPE_NC_DEDICATED: Allocate a
                  dedicated UAR with non-cache properties.
    
       **devx_uar**
                  struct mlx5dv_devx_uar {
                      void *reg_addr;
                      void *base_addr;
                      uint32_t page_id;
                      off_t mmap_off;
                      uint64_t comp_mask;
                  };
    
           _reg_addr_
                  The write address of DB/BF.
    
           _base_addr_
                  The base address of the UAR.
    
           _page_id_
                  The device page id to be used.
    
           _mmap_off_
                  The mmap offset parameter to be used for re-mapping, to be
                  used by a secondary process.
    


## RETURN VALUE



           Upon success _mlx5dv_devx_alloc_uar_ will return a new _struct_
           _mlx5dv_devx_uar_ , on error NULL will be returned and errno will be
           set.
    


* * *
# probe::stap.cache_get

## NAME



           probe::stap.cache_get - Found item in stap cache
    


## SYNOPSIS



           stap.cache_get
    


## VALUES



           _module_path_
               the path of the .ko kernel module file
    
           _source_path_
               the path of the .c source file
    


## DESCRIPTION



           Fires just before the return of get_from_cache, when the cache
           grab is successful.
    


* * *
# getgrent

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           getgrent — get the group database entry
    


## SYNOPSIS



           #include <grp.h>
    
           struct group *getgrent(void);
    


## DESCRIPTION



           Refer to endgrent(3p).
    


* * *