Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Public include file for the UUID library |
Theodore Ts'o | efc6f62 | 2008-08-27 23:07:54 -0400 | [diff] [blame] | 3 | * |
Theodore Ts'o | 1e0a221 | 1998-12-04 08:13:52 +0000 | [diff] [blame] | 4 | * Copyright (C) 1996, 1997, 1998 Theodore Ts'o. |
Theodore Ts'o | 19c78dc | 1997-04-29 16:17:09 +0000 | [diff] [blame] | 5 | * |
| 6 | * %Begin-Header% |
Theodore Ts'o | 1bbfec6 | 2004-03-20 14:02:24 -0500 | [diff] [blame] | 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. |
Theodore Ts'o | efc6f62 | 2008-08-27 23:07:54 -0400 | [diff] [blame] | 19 | * |
Theodore Ts'o | 1bbfec6 | 2004-03-20 14:02:24 -0500 | [diff] [blame] | 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. |
Theodore Ts'o | 19c78dc | 1997-04-29 16:17:09 +0000 | [diff] [blame] | 32 | * %End-Header% |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 33 | */ |
| 34 | |
Theodore Ts'o | 163337b | 2001-06-22 20:51:42 -0400 | [diff] [blame] | 35 | #ifndef _UUID_UUID_H |
| 36 | #define _UUID_UUID_H |
| 37 | |
Theodore Ts'o | 1e0a221 | 1998-12-04 08:13:52 +0000 | [diff] [blame] | 38 | #include <sys/types.h> |
Theodore Ts'o | 6ec9ef1 | 2008-08-22 12:15:56 -0400 | [diff] [blame] | 39 | #ifndef _WIN32 |
Theodore Ts'o | 1e0a221 | 1998-12-04 08:13:52 +0000 | [diff] [blame] | 40 | #include <sys/time.h> |
Theodore Ts'o | 6ec9ef1 | 2008-08-22 12:15:56 -0400 | [diff] [blame] | 41 | #endif |
Theodore Ts'o | 1e0a221 | 1998-12-04 08:13:52 +0000 | [diff] [blame] | 42 | #include <time.h> |
| 43 | |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 44 | typedef unsigned char uuid_t[16]; |
| 45 | |
Theodore Ts'o | b19d1a9 | 1999-06-18 00:32:03 +0000 | [diff] [blame] | 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 | |
Theodore Ts'o | 880f30a | 2004-03-19 21:54:13 -0500 | [diff] [blame] | 52 | /* UUID Type definitions */ |
| 53 | #define UUID_TYPE_DCE_TIME 1 |
| 54 | #define UUID_TYPE_DCE_RANDOM 4 |
| 55 | |
| 56 | /* Allow UUID constants to be defined */ |
Theodore Ts'o | 37a1ee9 | 2004-05-27 20:24:52 -0400 | [diff] [blame] | 57 | #ifdef __GNUC__ |
Theodore Ts'o | 880f30a | 2004-03-19 21:54:13 -0500 | [diff] [blame] | 58 | #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \ |
Theodore Ts'o | 37a1ee9 | 2004-05-27 20:24:52 -0400 | [diff] [blame] | 59 | static const uuid_t name __attribute__ ((unused)) = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15} |
| 60 | #else |
| 61 | #define UUID_DEFINE(name,u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15) \ |
| 62 | static const uuid_t name = {u0,u1,u2,u3,u4,u5,u6,u7,u8,u9,u10,u11,u12,u13,u14,u15} |
| 63 | #endif |
Theodore Ts'o | 880f30a | 2004-03-19 21:54:13 -0500 | [diff] [blame] | 64 | |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 65 | #ifdef __cplusplus |
| 66 | extern "C" { |
| 67 | #endif |
| 68 | |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 69 | /* clear.c */ |
| 70 | void uuid_clear(uuid_t uu); |
| 71 | |
| 72 | /* compare.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 73 | int uuid_compare(const uuid_t uu1, const uuid_t uu2); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 74 | |
| 75 | /* copy.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 76 | void uuid_copy(uuid_t dst, const uuid_t src); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 77 | |
| 78 | /* gen_uuid.c */ |
| 79 | void uuid_generate(uuid_t out); |
Theodore Ts'o | 36caf25 | 1999-10-26 14:29:22 +0000 | [diff] [blame] | 80 | void uuid_generate_random(uuid_t out); |
| 81 | void uuid_generate_time(uuid_t out); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 82 | |
| 83 | /* isnull.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 84 | int uuid_is_null(const uuid_t uu); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 85 | |
| 86 | /* parse.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 87 | int uuid_parse(const char *in, uuid_t uu); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 88 | |
| 89 | /* unparse.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 90 | void uuid_unparse(const uuid_t uu, char *out); |
Theodore Ts'o | d3d741f | 2004-03-22 16:22:28 -0500 | [diff] [blame] | 91 | void uuid_unparse_lower(const uuid_t uu, char *out); |
| 92 | void uuid_unparse_upper(const uuid_t uu, char *out); |
Theodore Ts'o | 1e3472c | 1997-04-29 14:53:37 +0000 | [diff] [blame] | 93 | |
Theodore Ts'o | 1e0a221 | 1998-12-04 08:13:52 +0000 | [diff] [blame] | 94 | /* uuid_time.c */ |
Theodore Ts'o | ce2722f | 2001-09-10 20:30:09 -0400 | [diff] [blame] | 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 |
Theodore Ts'o | 163337b | 2001-06-22 20:51:42 -0400 | [diff] [blame] | 102 | |
| 103 | #endif /* _UUID_UUID_H */ |