usr/src/man/man3proc/proc_get_priv.3proc

   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 May 11, 2016
  15 .Dt PROC_GET_PRIV 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm proc_get_priv ,
  19 .Nm proc_free_priv
  20 .Nd get process privileges
  21 .Sh SYNOPSIS
  22 .Lb libproc
  23 .In libproc.h
  24 .Ft "prpriv_t *"
  25 .Fo proc_get_priv
  26 .Fa "pid_t pid"
  27 .Fc
  28 .Ft void
  29 .Fo proc_free_priv
  30 .Fa "prpriv_t *prp"
  31 .Fc
  32 .Sh DESCRIPTION
  33 The
  34 .Fn proc_get_priv
  35 function is a convenient way to read the /proc privilege file for the
  36 process
  37 .Fa pid .
  38 The
  39 .Fn proc_get_priv
  40 function takes care of allocating memory for the privilege set and
  41 ensures that it is large enough to hold all of the privilege sets.
  42 The definition of the
  43 .Sy prpriv_t
  44 structure may be found in
  45 .Xr proc 4 .
  46 .Pp
  47 The
  48 .Fn proc_free_priv
  49 function releases the memory that was allocated by a call to
  50 .Fn proc_get_priv .
  51 It is safe to pass the
  52 .Dv NULL
  53 pointer in as
  54 .Fa prp ,
  55 the function will simply return without taking any action in that case.
  56 .Sh RETURN VALUES
  57 Upon successful completion, the
  58 .Fn proc_get_priv
  59 function returns a pointer to an allocated
  60 .Sy prpriv_t
  61 with the privileges of
  62 .Fa pid .
  63 Otherwise,
  64 .Dv NULL
  65 is returned to indicate an error occurred.
  66 .Sh INTERFACE STABILITY
  67 .Sy Uncommitted
  68 .Sh MT-LEVEL
  69 .Sy MT-Safe
  70 .Sh SEE ALSO
  71 .Xr libproc 3LIB ,
  72 .Xr proc 4