blob: 61641faca38be48b2295b7ef76141ec56842ced2 [file] [log] [blame]
Huang Yingfab1c232010-05-18 14:35:18 +08001/*
2 * UUID/GUID definition
3 *
Andy Shevchenkoe3a93bc2016-05-20 17:01:07 -07004 * Copyright (C) 2010, 2016 Intel Corp.
Huang Yingfab1c232010-05-18 14:35:18 +08005 * Huang Ying <ying.huang@intel.com>
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.
Huang Yingfab1c232010-05-18 14:35:18 +080015 */
Huang Yingfab1c232010-05-18 14:35:18 +080016#ifndef _LINUX_UUID_H_
17#define _LINUX_UUID_H_
18
David Howells607ca462012-10-13 10:46:48 +010019#include <uapi/linux/uuid.h>
Huang Yingfab1c232010-05-18 14:35:18 +080020
Tyler Baicar297b64c2017-06-21 12:17:12 -060021#define UUID_SIZE 16
22
Christoph Hellwig60927bc2017-05-17 09:56:45 +020023typedef struct {
Tyler Baicar297b64c2017-06-21 12:17:12 -060024 __u8 b[UUID_SIZE];
Christoph Hellwigf9727a12017-05-17 10:02:48 +020025} uuid_t;
Christoph Hellwig60927bc2017-05-17 09:56:45 +020026
Christoph Hellwigf9727a12017-05-17 10:02:48 +020027#define UUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
28((uuid_t) \
Christoph Hellwig60927bc2017-05-17 09:56:45 +020029{{ ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, ((a) >> 8) & 0xff, (a) & 0xff, \
30 ((b) >> 8) & 0xff, (b) & 0xff, \
31 ((c) >> 8) & 0xff, (c) & 0xff, \
32 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
33
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070034/*
35 * The length of a UUID string ("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
36 * not including trailing NUL.
37 */
38#define UUID_STRING_LEN 36
Tomas Winklerb544f3f2012-05-09 16:38:58 +030039
Christoph Hellwigef40dda2017-05-11 09:01:42 +020040extern const guid_t guid_null;
41extern const uuid_t uuid_null;
42
Christoph Hellwigdf337672017-05-11 14:00:57 +020043static inline bool guid_equal(const guid_t *u1, const guid_t *u2)
44{
45 return memcmp(u1, u2, sizeof(guid_t)) == 0;
46}
47
48static inline void guid_copy(guid_t *dst, const guid_t *src)
49{
50 memcpy(dst, src, sizeof(guid_t));
51}
52
Christoph Hellwigef40dda2017-05-11 09:01:42 +020053static inline bool guid_is_null(guid_t *guid)
54{
55 return guid_equal(guid, &guid_null);
56}
57
Christoph Hellwigdf337672017-05-11 14:00:57 +020058static inline bool uuid_equal(const uuid_t *u1, const uuid_t *u2)
59{
60 return memcmp(u1, u2, sizeof(uuid_t)) == 0;
61}
62
63static inline void uuid_copy(uuid_t *dst, const uuid_t *src)
64{
65 memcpy(dst, src, sizeof(uuid_t));
66}
67
Christoph Hellwigef40dda2017-05-11 09:01:42 +020068static inline bool uuid_is_null(uuid_t *uuid)
69{
70 return uuid_equal(uuid, &uuid_null);
71}
72
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -070073void generate_random_uuid(unsigned char uuid[16]);
74
Christoph Hellwigf9727a12017-05-17 10:02:48 +020075extern void guid_gen(guid_t *u);
76extern void uuid_gen(uuid_t *u);
Huang Yingfab1c232010-05-18 14:35:18 +080077
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070078bool __must_check uuid_is_valid(const char *uuid);
79
Christoph Hellwigf9727a12017-05-17 10:02:48 +020080extern const u8 guid_index[16];
81extern const u8 uuid_index[16];
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070082
Christoph Hellwigf9727a12017-05-17 10:02:48 +020083int guid_parse(const char *uuid, guid_t *u);
84int uuid_parse(const char *uuid, uuid_t *u);
85
86/* backwards compatibility, don't use in new code */
87typedef uuid_t uuid_be;
88#define UUID_BE(a, _b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
89 UUID_INIT(a, _b, c, d0, d1, d2, d3, d4, d5, d6, d7)
90#define NULL_UUID_BE \
91 UUID_BE(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, \
92 0x00, 0x00, 0x00, 0x00)
93
94#define uuid_le_gen(u) guid_gen(u)
95#define uuid_be_gen(u) uuid_gen(u)
96#define uuid_le_to_bin(guid, u) guid_parse(guid, u)
97#define uuid_be_to_bin(uuid, u) uuid_parse(uuid, u)
98
99static inline int uuid_le_cmp(const guid_t u1, const guid_t u2)
100{
101 return memcmp(&u1, &u2, sizeof(guid_t));
102}
103
104static inline int uuid_be_cmp(const uuid_t u1, const uuid_t u2)
105{
106 return memcmp(&u1, &u2, sizeof(uuid_t));
107}
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700108
Huang Yingfab1c232010-05-18 14:35:18 +0800109#endif