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