xref: /xnu-8796.121.2/bsd/uuid/uuid.h (revision c54f35ca767986246321eb901baf8f5ff7923f6a)
1*c54f35caSApple OSS Distributions /*
2*c54f35caSApple OSS Distributions  * Public include file for the UUID library
3*c54f35caSApple OSS Distributions  *
4*c54f35caSApple OSS Distributions  * Copyright (C) 1996, 1997, 1998 Theodore Ts'o.
5*c54f35caSApple OSS Distributions  *
6*c54f35caSApple OSS Distributions  * %Begin-Header%
7*c54f35caSApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
8*c54f35caSApple OSS Distributions  * modification, are permitted provided that the following conditions
9*c54f35caSApple OSS Distributions  * are met:
10*c54f35caSApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
11*c54f35caSApple OSS Distributions  *    notice, and the entire permission notice in its entirety,
12*c54f35caSApple OSS Distributions  *    including the disclaimer of warranties.
13*c54f35caSApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
14*c54f35caSApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
15*c54f35caSApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
16*c54f35caSApple OSS Distributions  * 3. The name of the author may not be used to endorse or promote
17*c54f35caSApple OSS Distributions  *    products derived from this software without specific prior
18*c54f35caSApple OSS Distributions  *    written permission.
19*c54f35caSApple OSS Distributions  *
20*c54f35caSApple OSS Distributions  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
21*c54f35caSApple OSS Distributions  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22*c54f35caSApple OSS Distributions  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
23*c54f35caSApple OSS Distributions  * WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
24*c54f35caSApple OSS Distributions  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25*c54f35caSApple OSS Distributions  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*c54f35caSApple OSS Distributions  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
27*c54f35caSApple OSS Distributions  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28*c54f35caSApple OSS Distributions  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29*c54f35caSApple OSS Distributions  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
30*c54f35caSApple OSS Distributions  * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
31*c54f35caSApple OSS Distributions  * DAMAGE.
32*c54f35caSApple OSS Distributions  * %End-Header%
33*c54f35caSApple OSS Distributions  */
34*c54f35caSApple OSS Distributions 
35*c54f35caSApple OSS Distributions #ifndef _UUID_UUID_H
36*c54f35caSApple OSS Distributions #define _UUID_UUID_H
37*c54f35caSApple OSS Distributions 
38*c54f35caSApple OSS Distributions #include <sys/_types.h>
39*c54f35caSApple OSS Distributions #include <sys/_types/_uuid_t.h>
40*c54f35caSApple OSS Distributions 
41*c54f35caSApple OSS Distributions #ifndef _UUID_STRING_T
42*c54f35caSApple OSS Distributions #define _UUID_STRING_T
43*c54f35caSApple OSS Distributions typedef __darwin_uuid_string_t  uuid_string_t;
44*c54f35caSApple OSS Distributions #endif /* _UUID_STRING_T */
45*c54f35caSApple OSS Distributions 
46*c54f35caSApple OSS Distributions #define UUID_DEFINE(name, u0, u1, u2, u3, u4, u5, u6, u7, u8, u9, u10, u11, u12, u13, u14, u15) \
47*c54f35caSApple OSS Distributions 	static const uuid_t name __attribute__ ((unused)) = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15}
48*c54f35caSApple OSS Distributions 
49*c54f35caSApple OSS Distributions UUID_DEFINE(UUID_NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
50*c54f35caSApple OSS Distributions 
51*c54f35caSApple OSS Distributions #ifdef __cplusplus
52*c54f35caSApple OSS Distributions extern "C" {
53*c54f35caSApple OSS Distributions #endif
54*c54f35caSApple OSS Distributions 
55*c54f35caSApple OSS Distributions void uuid_clear(uuid_t uu);
56*c54f35caSApple OSS Distributions 
57*c54f35caSApple OSS Distributions int uuid_compare(const uuid_t uu1, const uuid_t uu2);
58*c54f35caSApple OSS Distributions 
59*c54f35caSApple OSS Distributions void uuid_copy(uuid_t dst, const uuid_t src);
60*c54f35caSApple OSS Distributions 
61*c54f35caSApple OSS Distributions void uuid_generate(uuid_t out);
62*c54f35caSApple OSS Distributions void uuid_generate_random(uuid_t out);
63*c54f35caSApple OSS Distributions void uuid_generate_time(uuid_t out);
64*c54f35caSApple OSS Distributions 
65*c54f35caSApple OSS Distributions #ifdef KERNEL
66*c54f35caSApple OSS Distributions void uuid_generate_early_random(uuid_t out);
67*c54f35caSApple OSS Distributions #endif /* KERNEL */
68*c54f35caSApple OSS Distributions 
69*c54f35caSApple OSS Distributions int uuid_is_null(const uuid_t uu);
70*c54f35caSApple OSS Distributions 
71*c54f35caSApple OSS Distributions int uuid_parse(const uuid_string_t in, uuid_t uu);
72*c54f35caSApple OSS Distributions 
73*c54f35caSApple OSS Distributions void uuid_unparse(const uuid_t uu, uuid_string_t out);
74*c54f35caSApple OSS Distributions void uuid_unparse_lower(const uuid_t uu, uuid_string_t out);
75*c54f35caSApple OSS Distributions void uuid_unparse_upper(const uuid_t uu, uuid_string_t out);
76*c54f35caSApple OSS Distributions 
77*c54f35caSApple OSS Distributions #ifdef __cplusplus
78*c54f35caSApple OSS Distributions }
79*c54f35caSApple OSS Distributions #endif
80*c54f35caSApple OSS Distributions 
81*c54f35caSApple OSS Distributions #endif /* _UUID_UUID_H */
82