lib/libc/i386/sys/i386_get_ldt.2

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)fork.2        6.5 (Berkeley) 3/10/91
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 14, 2006
  32 .Dt I386_GET_LDT 2
  33 .Os
  34 .Sh NAME
  35 .Nm i386_get_ldt ,
  36 .Nm i386_set_ldt
  37 .Nd manage i386 per-process Local Descriptor Table entries
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In machine/segments.h
  42 .In machine/sysarch.h
  43 .Ft int
  44 .Fn i386_get_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  45 .Ft int
  46 .Fn i386_set_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn i386_get_ldt
  50 system call
  51 returns a list of the i386 descriptors in the current process'
  52 LDT.
  53 The
  54 .Fn i386_set_ldt
  55 system call
  56 sets a list of i386 descriptors in the current process'
  57 LDT.
  58 For both routines,
  59 .Fa start_sel
  60 specifies the index of the selector in the LDT at which to begin and
  61 .Fa descs
  62 points to an array of
  63 .Fa num_sels
  64 descriptors to be set or returned.
  65 .Pp
  66 Each entry in the
  67 .Fa descs
  68 array can be either a segment_descriptor or gate_descriptor and are defined in
  69 .In i386/segments.h .
  70 These structures are defined by the architecture
  71 as disjoint bit-fields, so care must be taken in constructing them.
  72 .Pp
  73 If
  74 .Fa start_sel
  75 is
  76 .Em LDT_AUTO_ALLOC ,
  77 .Fa num_sels
  78 is 1 and the descriptor pointed to by
  79 .Fa descs
  80 is legal, then
  81 .Fn i386_set_ldt
  82 will allocate a descriptor and return its
  83 selector number.
  84 .Pp
  85 If
  86 .Fa num_descs
  87 is 1,
  88 .Fa start_sels
  89 is valid, and
  90 .Fa descs
  91 is NULL, then
  92 .Fn i386_set_ldt
  93 will free that descriptor
  94 (making it available to be reallocated again later).
  95 .Pp
  96 If
  97 .Fa num_descs
  98 is 0,
  99 .Fa start_sels
 100 is 0 and
 101 .Fa descs
 102 is NULL then, as a special case,
 103 .Fn i386_set_ldt
 104 will free all descriptors.
 105 .Sh RETURN VALUES
 106 Upon successful completion,
 107 .Fn i386_get_ldt
 108 returns the number of descriptors currently in the LDT.
 109 The
 110 .Fn i386_set_ldt
 111 system call
 112 returns the first selector set on success.
 113 If the kernel allocated a descriptor in the LDT,
 114 the allocated index is returned.
 115 Otherwise, a value of -1 is returned and the global
 116 variable
 117 .Va errno
 118 is set to indicate the error.
 119 .Sh ERRORS
 120 The
 121 .Fn i386_get_ldt
 122 and
 123 .Fn i386_set_ldt
 124 system calls
 125 will fail if:
 126 .Bl -tag -width Er
 127 .It Bq Er EINVAL
 128 An inappropriate value was used for
 129 .Fa start_sel
 130 or
 131 .Fa num_sels .
 132 .It Bq Er EACCES
 133 The caller attempted to use a descriptor that would
 134 circumvent protection or cause a failure.
 135 .El
 136 .Sh SEE ALSO
 137 i386 Microprocessor Programmer's Reference Manual, Intel
 138 .Sh WARNING
 139 You can really hose your process using this.