xref: /illumos-gate/usr/src/boot/sys/sys/uuid.h (revision 199767f8)
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$
27  */
28 
29 #ifndef _SYS_UUID_H_
30 #define	_SYS_UUID_H_
31 
32 #include <sys/cdefs.h>
33 
34 /* Length of a node address (an IEEE 802 address). */
35 #define	_UUID_NODE_LEN		6
36 
37 /*
38  * See also:
39  *      http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt
40  *      http://www.opengroup.org/onlinepubs/009629399/apdxa.htm
41  *
42  * A DCE 1.1 compatible source representation of UUIDs.
43  */
44 struct uuid {
45 	uint32_t	time_low;
46 	uint16_t	time_mid;
47 	uint16_t	time_hi_and_version;
48 	uint8_t		clock_seq_hi_and_reserved;
49 	uint8_t		clock_seq_low;
50 	uint8_t		node[_UUID_NODE_LEN];
51 };
52 
53 #ifdef _KERNEL
54 
55 #define	UUID_NODE_LEN	_UUID_NODE_LEN
56 
57 struct sbuf;
58 
59 struct uuid *kern_uuidgen(struct uuid *, size_t);
60 
61 int uuid_ether_add(const uint8_t *);
62 int uuid_ether_del(const uint8_t *);
63 
64 int snprintf_uuid(char *, size_t, struct uuid *);
65 int printf_uuid(struct uuid *);
66 int sbuf_printf_uuid(struct sbuf *, struct uuid *);
67 int parse_uuid(const char *, struct uuid *);
68 
69 void be_uuid_dec(void const *buf, struct uuid *uuid);
70 void be_uuid_enc(void *buf, struct uuid const *uuid);
71 void le_uuid_dec(void const *buf, struct uuid *uuid);
72 void le_uuid_enc(void *buf, struct uuid const *uuid);
73 
74 #else	/* _KERNEL */
75 
76 /* XXX namespace pollution? */
77 typedef struct uuid uuid_t;
78 
79 __BEGIN_DECLS
80 int	uuidgen(struct uuid *, int);
81 __END_DECLS
82 
83 #endif	/* _KERNEL */
84 
85 #endif /* _SYS_UUID_H_ */
86