blob: b6a1edb61d87b95c2c111ff852f98ac22b4df1ee [file] [log] [blame]
Thomas Gleixner1802d0b2019-05-27 08:55:21 +02001// SPDX-License-Identifier: GPL-2.0-only
Huang Yingfab1c232010-05-18 14:35:18 +08002/*
3 * Unified UUID/GUID definition
4 *
Andy Shevchenkoe3a93bc2016-05-20 17:01:07 -07005 * Copyright (C) 2009, 2016 Intel Corp.
Huang Yingfab1c232010-05-18 14:35:18 +08006 * Huang Ying <ying.huang@intel.com>
Huang Yingfab1c232010-05-18 14:35:18 +08007 */
8
9#include <linux/kernel.h>
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070010#include <linux/ctype.h>
11#include <linux/errno.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050012#include <linux/export.h>
Huang Yingfab1c232010-05-18 14:35:18 +080013#include <linux/uuid.h>
14#include <linux/random.h>
15
Christoph Hellwigef40dda2017-05-11 09:01:42 +020016const guid_t guid_null;
17EXPORT_SYMBOL(guid_null);
18const uuid_t uuid_null;
19EXPORT_SYMBOL(uuid_null);
20
Christoph Hellwigf9727a12017-05-17 10:02:48 +020021const u8 guid_index[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
Christoph Hellwigf9727a12017-05-17 10:02:48 +020022const u8 uuid_index[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070023
Randy Dunlapd0636232017-11-29 12:32:42 -080024/**
25 * generate_random_uuid - generate a random UUID
26 * @uuid: where to put the generated UUID
27 *
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -070028 * Random UUID interface
29 *
Randy Dunlapd0636232017-11-29 12:32:42 -080030 * Used to create a Boot ID or a filesystem UUID/GUID, but can be
31 * useful for other kernel drivers.
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -070032 */
33void generate_random_uuid(unsigned char uuid[16])
34{
35 get_random_bytes(uuid, 16);
36 /* Set UUID version to 4 --- truly random generation */
37 uuid[6] = (uuid[6] & 0x0F) | 0x40;
38 /* Set the UUID variant to DCE */
39 uuid[8] = (uuid[8] & 0x3F) | 0x80;
40}
41EXPORT_SYMBOL(generate_random_uuid);
42
Huang Yingfab1c232010-05-18 14:35:18 +080043static void __uuid_gen_common(__u8 b[16])
44{
Akinobu Mitacedddb02013-04-29 16:21:25 -070045 prandom_bytes(b, 16);
Huang Yingfab1c232010-05-18 14:35:18 +080046 /* reversion 0b10 */
47 b[8] = (b[8] & 0x3F) | 0x80;
48}
49
Christoph Hellwigf9727a12017-05-17 10:02:48 +020050void guid_gen(guid_t *lu)
Huang Yingfab1c232010-05-18 14:35:18 +080051{
52 __uuid_gen_common(lu->b);
53 /* version 4 : random generation */
54 lu->b[7] = (lu->b[7] & 0x0F) | 0x40;
55}
Christoph Hellwigf9727a12017-05-17 10:02:48 +020056EXPORT_SYMBOL_GPL(guid_gen);
Huang Yingfab1c232010-05-18 14:35:18 +080057
Christoph Hellwigf9727a12017-05-17 10:02:48 +020058void uuid_gen(uuid_t *bu)
Huang Yingfab1c232010-05-18 14:35:18 +080059{
60 __uuid_gen_common(bu->b);
61 /* version 4 : random generation */
62 bu->b[6] = (bu->b[6] & 0x0F) | 0x40;
63}
Christoph Hellwigf9727a12017-05-17 10:02:48 +020064EXPORT_SYMBOL_GPL(uuid_gen);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070065
66/**
Randy Dunlapd0636232017-11-29 12:32:42 -080067 * uuid_is_valid - checks if a UUID string is valid
68 * @uuid: UUID string to check
69 *
70 * Description:
71 * It checks if the UUID string is following the format:
72 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
73 *
74 * where x is a hex digit.
75 *
76 * Return: true if input is valid UUID string.
77 */
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070078bool uuid_is_valid(const char *uuid)
79{
80 unsigned int i;
81
82 for (i = 0; i < UUID_STRING_LEN; i++) {
83 if (i == 8 || i == 13 || i == 18 || i == 23) {
84 if (uuid[i] != '-')
85 return false;
86 } else if (!isxdigit(uuid[i])) {
87 return false;
88 }
89 }
90
91 return true;
92}
93EXPORT_SYMBOL(uuid_is_valid);
94
Christoph Hellwigf9727a12017-05-17 10:02:48 +020095static int __uuid_parse(const char *uuid, __u8 b[16], const u8 ei[16])
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070096{
97 static const u8 si[16] = {0,2,4,6,9,11,14,16,19,21,24,26,28,30,32,34};
98 unsigned int i;
99
100 if (!uuid_is_valid(uuid))
101 return -EINVAL;
102
103 for (i = 0; i < 16; i++) {
Bjørn Morkbc9dc9d2016-05-30 17:40:42 +0300104 int hi = hex_to_bin(uuid[si[i] + 0]);
105 int lo = hex_to_bin(uuid[si[i] + 1]);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700106
107 b[ei[i]] = (hi << 4) | lo;
108 }
109
110 return 0;
111}
112
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200113int guid_parse(const char *uuid, guid_t *u)
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700114{
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200115 return __uuid_parse(uuid, u->b, guid_index);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700116}
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200117EXPORT_SYMBOL(guid_parse);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700118
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200119int uuid_parse(const char *uuid, uuid_t *u)
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700120{
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200121 return __uuid_parse(uuid, u->b, uuid_index);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700122}
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200123EXPORT_SYMBOL(uuid_parse);