xref: /freebsd/sys/compat/linuxkpi/common/include/linux/uuid.h (revision a3cefe7f2b4df0f70ff92d4570ce18e517af43ec)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2021,2023 The FreeBSD Foundation
5  *
6  * This software was developed by Björn Zeeb under sponsorship from
7  * the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
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  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef	_LINUXKPI_LINUX_UUID_H
32 #define	_LINUXKPI_LINUX_UUID_H
33 
34 #include <linux/random.h>
35 
36 #define	UUID_SIZE	16
37 #define	UUID_STRING_LEN	36
38 
39 #define	GUID_INIT(x0_3, x4_5, x6_7, x8, x9, x10, x11, x12, x13, x14, x15) \
40 	((guid_t) { .x = { 						\
41 		[0]  =  (x0_3)        & 0xff,				\
42 		[1]  = ((x0_3) >> 8)  & 0xff,				\
43 		[2]  = ((x0_3) >> 16) & 0xff,				\
44 		[3]  = ((x0_3) >> 24) & 0xff,				\
45 		[4]  =  (x4_5)        & 0xff,				\
46 		[5]  = ((x4_5) >> 8)  & 0xff,				\
47 		[6]  =  (x6_7)        & 0xff,				\
48 		[7]  = ((x6_7) >> 8)  & 0xff,				\
49 		[8]  =  (x8),						\
50 		[9]  =  (x9),						\
51 		[10] =  (x10),						\
52 		[11] =  (x11),						\
53 		[12] =  (x12),						\
54 		[13] =  (x13),						\
55 		[14] =  (x14),						\
56 		[15] =  (x15)						\
57 }})
58 
59 typedef struct {
60 	char	x[16];
61 } guid_t;
62 
63 extern const guid_t guid_null;
64 
65 static inline void
66 guid_gen(guid_t *g)
67 {
68 
69 	get_random_bytes(g, 16);
70 	g->x[7] = (g->x[7] & 0x0f) | 0x40;
71 	g->x[8] = (g->x[8] & 0x3f) | 0x80;
72 }
73 
74 static inline bool
75 guid_equal(const guid_t *u1, const guid_t *u2)
76 {
77 	return (memcmp(u1, u2, sizeof(guid_t)) == 0);
78 }
79 
80 static inline void
81 guid_copy(guid_t *dst, const guid_t *src)
82 {
83 	memcpy(dst, src, sizeof(*dst));
84 }
85 
86 static inline void
87 import_guid(guid_t *dst, const uint8_t *src)
88 {
89 	memcpy(dst, src, sizeof(guid_t));
90 }
91 
92 static inline void
93 export_guid(uint8_t *dst, const guid_t *src)
94 {
95 	memcpy(dst, src, sizeof(guid_t));
96 }
97 
98 static inline bool
99 guid_is_null(const guid_t *guid)
100 {
101 	return (guid_equal(guid, &guid_null));
102 }
103 
104 #endif	/* _LINUXKPI_LINUX_UUID_H */
105