share/man/man3proc/Lctlfd.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 LCTLFD 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Lctlfd
  19 .Nd obtain the thread control file descriptor
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft int
  24 .Fo Lctlfd
  25 .Fa "struct ps_lwphandle *L"
  26 .Fc
  27 .Sh DESCRIPTION
  28 The
  29 .Fn Lctlfd
  30 function returns a file descriptor to the underlying /proc file system
  31 .Sy ctl
  32 file for the thread identified by the handle
  33 .Fa L .
  34 This may be used for injecting control operations manually; however,
  35 many interfaces for using it are provided by
  36 .Xr libproc 3LIB
  37 itself.
  38 .Pp
  39 The file descriptor is invalidated when the thread handle is released
  40 through
  41 .Xr Lfree 3PROC .
  42 The caller
  43 .Em must not
  44 call
  45 .Xr close 2
  46 on the returned file descriptor.
  47 .Sh INTERFACE STABILITY
  48 .Sy Uncommitted
  49 .Sh MT-LEVEL
  50 See
  51 .Sy LOCKING
  52 in
  53 .Xr libproc 3LIB .
  54 .Sh SEE ALSO
  55 .Xr libproc 3LIB ,
  56 .Xr Lfree 3PROC ,
  57 .Xr Lgrab 3PROC ,
  58 .Xr proc 4