lib/libc/sys/uuidgen.2

   1 .\" Copyright (c) 2002 Marcel Moolenaar
   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 .\"
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/sys/uuidgen.2,v 1.8 2005/07/31 03:30:44 keramida Exp $
  26 .\" $DragonFly: src/lib/libc/sys/uuidgen.2,v 1.1 2007/06/16 19:57:13 dillon Exp $
  27 .\"
  28 .Dd May 26, 2002
  29 .Dt UUIDGEN 2
  30 .Os
  31 .Sh NAME
  32 .Nm uuidgen
  33 .Nd generate universally unique identifiers
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/uuid.h
  38 .Ft int
  39 .Fn uuidgen "struct uuid *store" "int count"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn uuidgen
  43 system call generates
  44 .Fa count
  45 universally unique identifiers (UUIDs) and writes them to the buffer
  46 pointed to by
  47 .Fa store .
  48 The identifiers are generated according to the syntax and semantics of the
  49 DCE version 1 variant of universally unique identifiers.
  50 See below for a more in-depth description of the identifiers.
  51 When no IEEE 802
  52 address is available for the node field, a random multicast address is
  53 generated for each invocation of the system call.
  54 According to the algorithm of generating time-based UUIDs, this will also
  55 force a new random clock sequence, thereby increasing the likelihood for
  56 the identifier to be unique.
  57 .Pp
  58 When multiple identifiers are to be generated, the
  59 .Fn uuidgen
  60 system call will generate a set of identifiers that is dense in such a way
  61 that there is no identifier that is larger than the smallest identifier in the
  62 set and smaller than the largest identifier in the set and that is not already
  63 in the set.
  64 .Pp
  65 Universally unique identifiers, also known as globally unique identifiers
  66 (GUIDs), have a binary representation of 128-bits.
  67 The grouping and meaning of these bits is described by the following
  68 structure and its description of the fields that follow it:
  69 .Bd -literal
  70 struct uuid {
  71         uint32_t        time_low;
  72         uint16_t        time_mid;
  73         uint16_t        time_hi_and_version;
  74         uint8_t         clock_seq_hi_and_reserved;
  75         uint8_t         clock_seq_low;
  76         uint8_t         node[_UUID_NODE_LEN];
  77 };
  78 .Ed
  79 .Bl -tag -width ".Va clock_seq_hi_and_reserved"
  80 .It Va time_low
  81 The least significant 32 bits of a 60-bit timestamp.
  82 This field is stored in the native byte-order.
  83 .It Va time_mid
  84 The least significant 16 bits of the most significant 28 bits of the 60-bit
  85 timestamp.
  86 This field is stored in the native byte-order.
  87 .It Va time_hi_and_version
  88 The most significant 12 bits of the 60-bit timestamp multiplexed with a 4-bit
  89 version number.
  90 The version number is stored in the most significant 4 bits of the 16-bit
  91 field.
  92 This field is stored in the native byte-order.
  93 .It Va clock_seq_hi_and_reserved
  94 The most significant 6 bits of a 14-bit sequence number multiplexed with a
  95 2-bit variant value.
  96 Note that the width of the variant value is determined by the variant itself.
  97 Identifiers generated by the
  98 .Fn uuidgen
  99 system call have variant value 10b.
 100 the variant value is stored in the most significant bits of the field.
 101 .It Va clock_seq_low
 102 The least significant 8 bits of a 14-bit sequence number.
 103 .It Va node
 104 The 6-byte IEEE 802 (MAC) address of one of the interfaces of the node.
 105 If no such interface exists, a random multi-cast address is used instead.
 106 .El
 107 .Pp
 108 The binary representation is sensitive to byte ordering.
 109 Any multi-byte field is to be stored in the local or native byte-order and
 110 identifiers must be converted when transmitted to hosts that do not agree
 111 on the byte-order.
 112 The specification does not however document what this means in concrete
 113 terms and is otherwise beyond the scope of this system call.
 114 .Sh RETURN VALUES
 115 .Rv -std
 116 .Sh ERRORS
 117 The
 118 .Fn uuidgen
 119 system call can fail with:
 120 .Bl -tag -width Er
 121 .It Bq Er EFAULT
 122 The buffer pointed to by
 123 .Fa store
 124 could not be written to for any or all identifiers.
 125 .It Bq Er EINVAL
 126 The
 127 .Fa count
 128 argument is less than 1 or larger than the hard upper limit of 2048.
 129 .El
 130 .Sh SEE ALSO
 131 .Xr uuidgen 1 ,
 132 .Xr uuid 3
 133 .Sh STANDARDS
 134 The identifiers are represented and generated in conformance with the DCE 1.1
 135 RPC specification.
 136 The
 137 .Fn uuidgen
 138 system call is itself not part of the specification.
 139 .Sh HISTORY
 140 The
 141 .Fn uuidgen
 142 system call first appeared in
 143 .Fx 5.0 .