d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1732afaa0d
freebsd-skq/lib/libc/uuid/uuid.3

137 lines
4.4 KiB
Groff
Raw Normal View History

Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.\" Copyright (c) 2002 Marcel Moolenaar
.\" Copyright (c) 2002 Hiten Mahesh Pandya
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Note that memory should be freed after uuid_to_string(3) call. MFC after: 1 week
2012-03-01 14:39:01 +00:00
.Dd March 1, 2012
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Dt UUID 3
.Os
.Sh NAME
.Nm uuid_compare , uuid_create , uuid_create_nil , uuid_equal ,
.Nm uuid_from_string , uuid_hash , uuid_is_nil , uuid_to_string
.Nd DCE 1.1 compliant UUID functions
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In uuid.h
.Ft int32_t
Keep up with const poisoning in uuid.h,v 1.3.
2005-11-24 07:04:20 +00:00
.Fn uuid_compare "const uuid_t *uuid1" "const uuid_t *uuid2" "uint32_t *status"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Ft void
.Fn uuid_create "uuid_t *uuid" "uint32_t *status"
.Ft void
.Fn uuid_create_nil "uuid_t *uuid" "uint32_t *status"
.Ft int32_t
Keep up with const poisoning in uuid.h,v 1.3.
2005-11-24 07:04:20 +00:00
.Fn uuid_equal "const uuid_t *uuid1" "const uuid_t *uuid2" "uint32_t *status"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Ft void
.Fn uuid_from_string "const char *str" "uuid_t *uuid" "uint32_t *status"
.Ft uint16_t
Keep up with const poisoning in uuid.h,v 1.3.
2005-11-24 07:04:20 +00:00
.Fn uuid_hash "const uuid_t *uuid" "uint32_t *status"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Ft int32_t
Keep up with const poisoning in uuid.h,v 1.3.
2005-11-24 07:04:20 +00:00
.Fn uuid_is_nil "const uuid_t *uuid" "uint32_t *status"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Ft void
Keep up with const poisoning in uuid.h,v 1.3.
2005-11-24 07:04:20 +00:00
.Fn uuid_to_string "const uuid_t *uuid" "char **str" "uint32_t *status"
Import the uuid_enc_le(), uuid_dec_le(), uuid_enc_be() and uuid_dec_be() functions. These routines are not part of the DCE RPC API. They are provided for convenience. Reviewed by: marcel Obtained from: NetBSD MFC after: 1 week
2008-08-14 22:23:16 +00:00
.Ft void
.Fn uuid_enc_le "void *buf" "const uuid_t *uuid"
.Ft void
.Fn uuid_dec_le "const void *buf" "uuid_t *"
.Ft void
.Fn uuid_enc_be "void *buf" "const uuid_t *uuid"
.Ft void
.Fn uuid_dec_be "const void *buf" "uuid_t *"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Sh DESCRIPTION
The family of DCE 1.1 compliant UUID functions allow applications to operate
on universally unique identifiers, or UUIDs.
The
.Fn uuid_create
and
.Fn uuid_create_nil
functions create UUIDs.
The
Fix markup for uuid_equal()
2003-08-08 19:12:28 +00:00
.Fn uuid_compare ,
.Fn uuid_equal
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
and
.Fn uuid_is_nil
functions can be used to test UUIDs.
To convert from the binary representation to the string representation or
vice versa, use
.Fn uuid_to_string
or
.Fn uuid_from_string
respectively.
A 16-bit hash value can be obtained by calling
.Fn uuid_hash .
Import the uuid_enc_le(), uuid_dec_le(), uuid_enc_be() and uuid_dec_be() functions. These routines are not part of the DCE RPC API. They are provided for convenience. Reviewed by: marcel Obtained from: NetBSD MFC after: 1 week
2008-08-14 22:23:16 +00:00
.Pp
The
Note that memory should be freed after uuid_to_string(3) call. MFC after: 1 week
2012-03-01 14:39:01 +00:00
.Fn uuid_to_string
function set
.Fa *str
to be a pointer to a buffer sufficiently large to hold the string.
This pointer should be passed to
.Xr free 3
to release the allocated storage when it is no longer needed.
.Pp
The
Import the uuid_enc_le(), uuid_dec_le(), uuid_enc_be() and uuid_dec_be() functions. These routines are not part of the DCE RPC API. They are provided for convenience. Reviewed by: marcel Obtained from: NetBSD MFC after: 1 week
2008-08-14 22:23:16 +00:00
.Fn uuid_enc_le
and
.Fn uuid_enc_be
functions encode a binary representation of a UUID into an octet stream
in little-endian and big-endian byte-order, respectively.
The destination buffer must be pre-allocated by the caller, and must be
large enough to hold the 16-octet binary UUID.
These routines are not part of the DCE RPC API.
They are provided for convenience.
.Pp
The
.Fn uuid_dec_le
and
.Fn uuid_dec_be
functions decode a UUID from an octet stream in little-endian and
big-endian byte-order, respectively.
These routines are not part of the DCE RPC API.
They are provided for convenience.
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.Sh RETURN VALUES
The successful or unsuccessful completion of the function is returned in
the
.Fa status
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
argument.
mdoc(7) police: nits. Approved by: re
2002-12-09 12:47:18 +00:00
Possible values are:
.Bl -tag -width ".Dv uuid_s_invalid_string_uuid"
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.It Dv uuid_s_ok
The function completed successfully.
.It Dv uuid_s_bad_version
The UUID does not have a known version.
.It Dv uuid_s_invalid_string_uuid
The string representation of an UUID is not valid.
.It Dv uuid_s_no_memory
Note that memory should be freed after uuid_to_string(3) call. MFC after: 1 week
2012-03-01 14:39:01 +00:00
The function can not allocate memory to store an UUID representation.
Implement DCE 1.1 compliant UUID functions. Immediate use of these functions is expected for uuidgen(1), mca(8) and gpt(8). Given the generic use of UUIDs beyond the scope of the DCE 1.1 specification, visibility of the data structure at all levels of the machine, including firmware and the wish to not create a permanent build- time FreeBSD-ism for DCE compliant applications by creating a new library, it was decided that libc would be the least inappropriate place. Also, because the UUID functions live in libc under IRIX as well, we have maximized our portability and left as many options open as possible. This implementation introduces an extension not found in the specification: the status parameter is allowed to be a NULL- pointer. The reason for introducing the extension is because the status is almost never of any use. The manpage that's part of this commit is a minimal place-holder and is further fleshed-out in the near future. Approved by: re@ Contributed by: Hiten Mahesh Pandya <hiten@unixdaemons.com> Sponsored by: marcel :-) Tested on: alpha, i386, ia64
2002-10-30 03:51:00 +00:00
.El
.Sh SEE ALSO
.Xr uuidgen 1 ,
.Xr uuidgen 2
.Sh STANDARDS
The UUID functions conform to the DCE 1.1 RPC specification.
Sort sections.
2005-01-20 09:17:07 +00:00
.Sh BUGS
This manpage can be improved.
Reference in New Issue Copy Permalink