blob: 7a9706449b9c2e98bc48f04c8196d019826d759f
1 | /* vi: set sw=4 ts=4: */ |
2 | /* |
3 | * Public include file for the UUID library |
4 | * |
5 | * Copyright (C) 1996, 1997, 1998 Theodore Ts'o. |
6 | * |
7 | * %Begin-Header% |
8 | * Redistribution and use in source and binary forms, with or without |
9 | * modification, are permitted provided that the following conditions |
10 | * are met: |
11 | * 1. Redistributions of source code must retain the above copyright |
12 | * notice, and the entire permission notice in its entirety, |
13 | * including the disclaimer of warranties. |
14 | * 2. Redistributions in binary form must reproduce the above copyright |
15 | * notice, this list of conditions and the following disclaimer in the |
16 | * documentation and/or other materials provided with the distribution. |
17 | * 3. The name of the author may not be used to endorse or promote |
18 | * products derived from this software without specific prior |
19 | * written permission. |
20 | * |
21 | * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED |
22 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
23 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF |
24 | * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE |
25 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
26 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
27 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
28 | * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
29 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
30 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE |
31 | * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH |
32 | * DAMAGE. |
33 | * %End-Header% |
34 | */ |
35 | #ifndef UUID_UUID_H |
36 | #define UUID_UUID_H 1 |
37 | |
38 | #include <sys/types.h> |
39 | #include <time.h> |
40 | |
41 | typedef unsigned char uuid_t[16]; |
42 | |
43 | /* UUID Variant definitions */ |
44 | #define UUID_VARIANT_NCS 0 |
45 | #define UUID_VARIANT_DCE 1 |
46 | #define UUID_VARIANT_MICROSOFT 2 |
47 | #define UUID_VARIANT_OTHER 3 |
48 | |
49 | /* UUID Type definitions */ |
50 | #define UUID_TYPE_DCE_TIME 1 |
51 | #define UUID_TYPE_DCE_RANDOM 4 |
52 | |
53 | /* Allow UUID constants to be defined */ |
54 | #ifdef __GNUC__ |
55 | #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \ |
56 | static const uuid_t name UNUSED_PARAM = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15} |
57 | #else |
58 | #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \ |
59 | static const uuid_t name = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15} |
60 | #endif |
61 | |
62 | #ifdef __cplusplus |
63 | extern "C" { |
64 | #endif |
65 | |
66 | /* clear.c */ |
67 | /*void uuid_clear(uuid_t uu);*/ |
68 | #define uuid_clear(uu) memset(uu, 0, sizeof(uu)) |
69 | |
70 | /* compare.c */ |
71 | int uuid_compare(const uuid_t uu1, const uuid_t uu2); |
72 | |
73 | /* copy.c */ |
74 | /*void uuid_copy(uuid_t dst, const uuid_t src);*/ |
75 | #define uuid_copy(dst,src) memcpy(dst, src, sizeof(dst)) |
76 | |
77 | /* gen_uuid.c */ |
78 | void uuid_generate(uuid_t out); |
79 | void uuid_generate_random(uuid_t out); |
80 | void uuid_generate_time(uuid_t out); |
81 | |
82 | /* isnull.c */ |
83 | /*int uuid_is_null(const uuid_t uu);*/ |
84 | #define uuid_is_null(uu) (!memcmp(uu, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", sizeof(uu))) |
85 | |
86 | /* parse.c */ |
87 | int uuid_parse(const char *in, uuid_t uu); |
88 | |
89 | /* unparse.c */ |
90 | void uuid_unparse(const uuid_t uu, char *out); |
91 | void uuid_unparse_lower(const uuid_t uu, char *out); |
92 | void uuid_unparse_upper(const uuid_t uu, char *out); |
93 | |
94 | /* uuid_time.c */ |
95 | time_t uuid_time(const uuid_t uu, struct timeval *ret_tv); |
96 | int uuid_type(const uuid_t uu); |
97 | int uuid_variant(const uuid_t uu); |
98 | |
99 | #ifdef __cplusplus |
100 | } |
101 | #endif |
102 | |
103 | #endif /* _UUID_UUID_H */ |
104 |