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