xref: /dragonfly/sys/sys/uuid.h (revision 245bd6bc)
1 /*-
2  * Copyright (c) 2002 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/sys/uuid.h,v 1.6 2005/10/07 13:37:10 marcel Exp $
27  */
28 
29 #ifndef _SYS_UUID_H_
30 #define	_SYS_UUID_H_
31 
32 #include <sys/cdefs.h>
33 #ifndef _KERNEL
34 #include <machine/stdint.h>
35 #else
36 #include <sys/types.h>
37 #endif
38 
39 /* Length of a node address (an IEEE 802 address). */
40 #define	_UUID_NODE_LEN		6
41 
42 /*
43  * See also:
44  *      http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt
45  *      http://www.opengroup.org/onlinepubs/009629399/apdxa.htm
46  *
47  * A DCE 1.1 compatible source representation of UUIDs.
48  */
49 struct uuid {
50 	__uint32_t	time_low;
51 	__uint16_t	time_mid;
52 	__uint16_t	time_hi_and_version;
53 	__uint8_t	clock_seq_hi_and_reserved;
54 	__uint8_t	clock_seq_low;
55 	__uint8_t	node[_UUID_NODE_LEN];
56 };
57 
58 #ifdef _KERNEL
59 
60 typedef struct uuid uuid_t;
61 
62 #define	UUID_NODE_LEN	_UUID_NODE_LEN
63 
64 struct sbuf;
65 
66 int kuuid_compare(const struct uuid *, const struct uuid *);
67 int kuuid_is_nil(const struct uuid *);
68 int kuuid_is_ccd(const struct uuid *);
69 int kuuid_is_vinum(const struct uuid *);
70 
71 int snprintf_uuid(char *, size_t, struct uuid *);
72 int printf_uuid(struct uuid *);
73 int sbuf_printf_uuid(struct sbuf *, struct uuid *);
74 int parse_uuid(const char *, struct uuid *);
75 
76 void be_uuid_dec(void const *buf, struct uuid *uuid);
77 void be_uuid_enc(void *buf, struct uuid const *uuid);
78 void le_uuid_dec(void const *buf, struct uuid *uuid);
79 void le_uuid_enc(void *buf, struct uuid const *uuid);
80 
81 #else	/* !_KERNEL */
82 
83 /* XXX namespace pollution? */
84 typedef struct uuid uuid_t;
85 
86 __BEGIN_DECLS
87 int	uuidgen(struct uuid *, int);
88 __END_DECLS
89 
90 #endif	/* _KERNEL */
91 
92 #endif /* _SYS_UUID_H_ */
93