xref: /linux-6.15/include/linux/uuid.h (revision df33767d)
1 /*
2  * UUID/GUID definition
3  *
4  * Copyright (C) 2010, 2016 Intel Corp.
5  *	Huang Ying <[email protected]>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License version
9  * 2 as published by the Free Software Foundation;
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  */
16 #ifndef _LINUX_UUID_H_
17 #define _LINUX_UUID_H_
18 
19 #include <uapi/linux/uuid.h>
20 
21 typedef struct {
22 	__u8 b[16];
23 } uuid_t;
24 
25 #define UUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)			\
26 ((uuid_t)								\
27 {{ ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, ((a) >> 8) & 0xff, (a) & 0xff, \
28    ((b) >> 8) & 0xff, (b) & 0xff,					\
29    ((c) >> 8) & 0xff, (c) & 0xff,					\
30    (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
31 
32 /*
33  * The length of a UUID string ("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
34  * not including trailing NUL.
35  */
36 #define	UUID_STRING_LEN		36
37 
38 static inline bool guid_equal(const guid_t *u1, const guid_t *u2)
39 {
40 	return memcmp(u1, u2, sizeof(guid_t)) == 0;
41 }
42 
43 static inline void guid_copy(guid_t *dst, const guid_t *src)
44 {
45 	memcpy(dst, src, sizeof(guid_t));
46 }
47 
48 static inline bool uuid_equal(const uuid_t *u1, const uuid_t *u2)
49 {
50 	return memcmp(u1, u2, sizeof(uuid_t)) == 0;
51 }
52 
53 static inline void uuid_copy(uuid_t *dst, const uuid_t *src)
54 {
55 	memcpy(dst, src, sizeof(uuid_t));
56 }
57 
58 void generate_random_uuid(unsigned char uuid[16]);
59 
60 extern void guid_gen(guid_t *u);
61 extern void uuid_gen(uuid_t *u);
62 
63 bool __must_check uuid_is_valid(const char *uuid);
64 
65 extern const u8 guid_index[16];
66 extern const u8 uuid_index[16];
67 
68 int guid_parse(const char *uuid, guid_t *u);
69 int uuid_parse(const char *uuid, uuid_t *u);
70 
71 /* backwards compatibility, don't use in new code */
72 typedef uuid_t uuid_be;
73 #define UUID_BE(a, _b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
74 	UUID_INIT(a, _b, c, d0, d1, d2, d3, d4, d5, d6, d7)
75 #define NULL_UUID_BE 							\
76 	UUID_BE(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00,	\
77 	     0x00, 0x00, 0x00, 0x00)
78 
79 #define uuid_le_gen(u)		guid_gen(u)
80 #define uuid_be_gen(u)		uuid_gen(u)
81 #define uuid_le_to_bin(guid, u)	guid_parse(guid, u)
82 #define uuid_be_to_bin(uuid, u)	uuid_parse(uuid, u)
83 
84 static inline int uuid_le_cmp(const guid_t u1, const guid_t u2)
85 {
86 	return memcmp(&u1, &u2, sizeof(guid_t));
87 }
88 
89 static inline int uuid_be_cmp(const uuid_t u1, const uuid_t u2)
90 {
91 	return memcmp(&u1, &u2, sizeof(uuid_t));
92 }
93 
94 #endif
95