blob: d9c4a6cce3c2cbee624117a5bc051c745050b236 [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>
Alexey Dobriyandfbc3c6cb2018-02-06 15:37:48 -080020#include <linux/string.h>
Huang Yingfab1c232010-05-18 14:35:18 +080021
Tyler Baicar297b64c2017-06-21 12:17:12 -060022#define UUID_SIZE 16
23
Christoph Hellwig60927bc2017-05-17 09:56:45 +020024typedef struct {
Tyler Baicar297b64c2017-06-21 12:17:12 -060025 __u8 b[UUID_SIZE];
Christoph Hellwigf9727a12017-05-17 10:02:48 +020026} uuid_t;
Christoph Hellwig60927bc2017-05-17 09:56:45 +020027
Christoph Hellwigf9727a12017-05-17 10:02:48 +020028#define UUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
29((uuid_t) \
Christoph Hellwig60927bc2017-05-17 09:56:45 +020030{{ ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, ((a) >> 8) & 0xff, (a) & 0xff, \
31 ((b) >> 8) & 0xff, (b) & 0xff, \
32 ((c) >> 8) & 0xff, (c) & 0xff, \
33 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
34
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070035/*
36 * The length of a UUID string ("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
37 * not including trailing NUL.
38 */
39#define UUID_STRING_LEN 36
Tomas Winklerb544f3f2012-05-09 16:38:58 +030040
Christoph Hellwigef40dda2017-05-11 09:01:42 +020041extern const guid_t guid_null;
42extern const uuid_t uuid_null;
43
Christoph Hellwigdf337672017-05-11 14:00:57 +020044static inline bool guid_equal(const guid_t *u1, const guid_t *u2)
45{
46 return memcmp(u1, u2, sizeof(guid_t)) == 0;
47}
48
49static inline void guid_copy(guid_t *dst, const guid_t *src)
50{
51 memcpy(dst, src, sizeof(guid_t));
52}
53
Andy Shevchenko63709fd2017-06-16 21:13:38 +030054static inline bool guid_is_null(const guid_t *guid)
Christoph Hellwigef40dda2017-05-11 09:01:42 +020055{
56 return guid_equal(guid, &guid_null);
57}
58
Christoph Hellwigdf337672017-05-11 14:00:57 +020059static inline bool uuid_equal(const uuid_t *u1, const uuid_t *u2)
60{
61 return memcmp(u1, u2, sizeof(uuid_t)) == 0;
62}
63
64static inline void uuid_copy(uuid_t *dst, const uuid_t *src)
65{
66 memcpy(dst, src, sizeof(uuid_t));
67}
68
Andy Shevchenko63709fd2017-06-16 21:13:38 +030069static inline bool uuid_is_null(const uuid_t *uuid)
Christoph Hellwigef40dda2017-05-11 09:01:42 +020070{
71 return uuid_equal(uuid, &uuid_null);
72}
73
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -070074void generate_random_uuid(unsigned char uuid[16]);
75
Christoph Hellwigf9727a12017-05-17 10:02:48 +020076extern void guid_gen(guid_t *u);
77extern void uuid_gen(uuid_t *u);
Huang Yingfab1c232010-05-18 14:35:18 +080078
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070079bool __must_check uuid_is_valid(const char *uuid);
80
Christoph Hellwigf9727a12017-05-17 10:02:48 +020081extern const u8 guid_index[16];
82extern const u8 uuid_index[16];
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070083
Christoph Hellwigf9727a12017-05-17 10:02:48 +020084int guid_parse(const char *uuid, guid_t *u);
85int uuid_parse(const char *uuid, uuid_t *u);
86
87/* backwards compatibility, don't use in new code */
Christoph Hellwigf9727a12017-05-17 10:02:48 +020088#define uuid_le_gen(u) guid_gen(u)
Christoph Hellwigf9727a12017-05-17 10:02:48 +020089#define uuid_le_to_bin(guid, u) guid_parse(guid, u)
Christoph Hellwigf9727a12017-05-17 10:02:48 +020090
91static inline int uuid_le_cmp(const guid_t u1, const guid_t u2)
92{
93 return memcmp(&u1, &u2, sizeof(guid_t));
94}
95
Huang Yingfab1c232010-05-18 14:35:18 +080096#endif