util-linux (2.39)
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 _UL_LIBUUID_UUID_H
36 #define _UL_LIBUUID_UUID_H
37
38 #include <sys/types.h>
39 #ifndef _WIN32
40 #include <sys/time.h>
41 #endif
42 #include <time.h>
43
44 typedef unsigned char uuid_t[16];
45
46 /* UUID Variant definitions */
47 #define UUID_VARIANT_NCS 0
48 #define UUID_VARIANT_DCE 1
49 #define UUID_VARIANT_MICROSOFT 2
50 #define UUID_VARIANT_OTHER 3
51
52 #define UUID_VARIANT_SHIFT 5
53 #define UUID_VARIANT_MASK 0x7
54
55 /* UUID Type definitions */
56 #define UUID_TYPE_DCE_NIL 0
57 #define UUID_TYPE_DCE_TIME 1
58 #define UUID_TYPE_DCE_SECURITY 2
59 #define UUID_TYPE_DCE_MD5 3
60 #define UUID_TYPE_DCE_RANDOM 4
61 #define UUID_TYPE_DCE_SHA1 5
62
63 #define UUID_TYPE_SHIFT 4
64 #define UUID_TYPE_MASK 0xf
65
66 #define UUID_STR_LEN 37
67
68 /* Allow UUID constants to be defined */
69 #ifdef __GNUC__
70 #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \
71 static const uuid_t name __attribute__ ((unused)) = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15}
72 #else
73 #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \
74 static const uuid_t name = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15}
75 #endif
76
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80
81 /* clear.c */
82 extern void uuid_clear(uuid_t uu);
83
84 /* compare.c */
85 extern int uuid_compare(const uuid_t uu1, const uuid_t uu2);
86
87 /* copy.c */
88 extern void uuid_copy(uuid_t dst, const uuid_t src);
89
90 /* gen_uuid.c */
91 extern void uuid_generate(uuid_t out);
92 extern void uuid_generate_random(uuid_t out);
93 extern void uuid_generate_time(uuid_t out);
94 extern int uuid_generate_time_safe(uuid_t out);
95
96 extern void uuid_generate_md5(uuid_t out, const uuid_t ns, const char *name, size_t len);
97 extern void uuid_generate_sha1(uuid_t out, const uuid_t ns, const char *name, size_t len);
98
99 /* isnull.c */
100 extern int uuid_is_null(const uuid_t uu);
101
102 /* parse.c */
103 extern int uuid_parse(const char *in, uuid_t uu);
104 extern int uuid_parse_range(const char *in_start, const char *in_end, uuid_t uu);
105
106 /* unparse.c */
107 extern void uuid_unparse(const uuid_t uu, char *out);
108 extern void uuid_unparse_lower(const uuid_t uu, char *out);
109 extern void uuid_unparse_upper(const uuid_t uu, char *out);
110
111 /* uuid_time.c */
112 extern time_t uuid_time(const uuid_t uu, struct timeval *ret_tv);
113 extern int uuid_type(const uuid_t uu);
114 extern int uuid_variant(const uuid_t uu);
115
116 /* predefined.c */
117 extern const uuid_t *uuid_get_template(const char *alias);
118
119 #ifdef __cplusplus
120 }
121 #endif
122
123 #endif /* _UL_LIBUUID_UUID_H */
Browse
Usage
Versions