share/man/man9/LWP_CACHE_CREDS.9

   1 .\"     $NetBSD: LWP_CACHE_CREDS.9,v 1.1 2007/12/09 08:31:58 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2007 YAMAMOTO Takashi,
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd December 9, 2007
  29 .Dt LWP_CACHE_CREDS 9
  30 .Os
  31 .\" ------------------------------------------------------------
  32 .Sh NAME
  33 .Nm LWP_CACHE_CREDS
  34 .Nd synchronize LWP credential with process credential
  35 .\" ------------------------------------------------------------
  36 .Sh SYNOPSIS
  37 .In sys/lwp.h
  38 .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  39 .Ft void
  40 .Fn LWP_CACHE_CREDS \
  41 "lwp_t *l" "struct proc *p"
  42 .\" ------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 .Fn LWP_CACHE_CREDS
  45 updates the LWP's cached credential to match with the process' credential
  46 if the latter has been changed after the last synchronization.
  47 .Pp
  48 Each LWPs have its cached credential so that it can be used without
  49 worrying about potential of other LWP changing the process' credential.
  50 .Fn kauth_cred_get
  51 returns the cached credential.
  52 .Pp
  53 .Fn LWP_CACHE_CREDS
  54 is called by MD entry code for system call and various traps.
  55 LWPs which can live in kernel for long period should call
  56 .Fn LWP_CACHE_CREDS
  57 by itsself to refresh its credential.
  58 .Pp
  59 .Fn LWP_CACHE_CREDS
  60 takes the following arguments.
  61 .Bl -tag -width l
  62 .It Fa l
  63 The calling lwp.
  64 .It Fa p
  65 The process which the lwp
  66 .Fa l
  67 belongs to.
  68 .El
  69 .Pp
  70 .Fn LWP_CACHE_CREDS
  71 might be implemented as a macro.
  72 .\" ------------------------------------------------------------
  73 .Sh SEE ALSO
  74 .Xr intro 9 ,
  75 .Xr kauth 9