share/man/man9/alloc_unr.9

   1 .\" Copyright (c) 2005 Gleb Smirnoff <glebius@FreeBSD.org>
   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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 7, 2010
  28 .Dt ALLOC_UNR 9
  29 .Os
  30 .Sh NAME
  31 .Nm new_unrhdr ,
  32 .Nm delete_unrhdr ,
  33 .Nm alloc_unr ,
  34 .Nm free_unr
  35 .Nd "kernel unit number allocator"
  36 .Sh SYNOPSIS
  37 .In sys/systm.h
  38 .Ft "struct unrhdr *"
  39 .Fn new_unrhdr "int low" "int high" "struct mtx *mutex"
  40 .Ft void
  41 .Fn delete_unrhdr "struct unrhdr *uh"
  42 .Ft int
  43 .Fn alloc_unr "struct unrhdr *uh"
  44 .Ft int
  45 .Fn alloc_unrl "struct unrhdr *uh"
  46 .Ft void
  47 .Fn free_unr "struct unrhdr *uh" "u_int item"
  48 .Sh DESCRIPTION
  49 The kernel unit number allocator is a generic facility, which allows to allocate
  50 unit numbers within a specified range.
  51 .Bl -tag -width indent
  52 .It Fn new_unrhdr low high mutex
  53 Initialize a new unit number allocator entity.
  54 The
  55 .Fa low
  56 and
  57 .Fa high
  58 arguments
  59 specify minimum and maximum number of unit numbers.
  60 There is no cost associated with the range of unit numbers, so unless the resource
  61 really is finite,
  62 .Dv INT_MAX
  63 can be used.
  64 If
  65 .Fa mutex
  66 is not
  67 .Dv NULL ,
  68 it is used for locking when allocating and freeing units.
  69 Otherwise, internal mutex is used.
  70 .It Fn delete_unrhdr uh
  71 Destroy specified unit number allocator entity.
  72 .It Fn alloc_unr uh
  73 Return a new unit number.
  74 The lowest free number is always allocated.
  75 This function does not allocate memory and never sleeps, however it may
  76 block on a mutex.
  77 If no free unit numbers are left,
  78 .Li \-1
  79 is returned.
  80 .It Fn alloc_unrl uh
  81 Same as
  82 .Fn alloc_unr
  83 except that mutex is assumed to be already locked and thus is not used.
  84 .It Fn free_unr uh item
  85 Free a previously allocated unit number.
  86 This function may require allocating memory, and thus it can sleep.
  87 There is no pre-locked variant.
  88 .El
  89 .Sh CODE REFERENCES
  90 The above functions are implemented in
  91 .Pa sys/kern/subr_unit.c .
  92 .Sh HISTORY
  93 Kernel unit number allocator first appeared in
  94 .Fx 6.0 .
  95 .Sh AUTHORS
  96 .An -nosplit
  97 Kernel unit number allocator was written by
  98 .An Poul-Henning Kamp .
  99 This manpage was written by
 100 .An Gleb Smirnoff .