blob: 90bee73f7bd7a565446f2466dfcd18e71db9b469 [file] [log] [blame]
Huang Yingfab1c232010-05-18 14:35:18 +08001/*
2 * Unified UUID/GUID definition
3 *
Andy Shevchenkoe3a93bc2016-05-20 17:01:07 -07004 * Copyright (C) 2009, 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 */
16
17#include <linux/kernel.h>
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070018#include <linux/ctype.h>
19#include <linux/errno.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050020#include <linux/export.h>
Huang Yingfab1c232010-05-18 14:35:18 +080021#include <linux/uuid.h>
22#include <linux/random.h>
23
Christoph Hellwigf9727a12017-05-17 10:02:48 +020024const u8 guid_index[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
25EXPORT_SYMBOL(guid_index);
26const u8 uuid_index[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
27EXPORT_SYMBOL(uuid_index);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070028
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -070029/***************************************************************
30 * Random UUID interface
31 *
32 * Used here for a Boot ID, but can be useful for other kernel
33 * drivers.
34 ***************************************************************/
35
36/*
37 * Generate random UUID
38 */
39void generate_random_uuid(unsigned char uuid[16])
40{
41 get_random_bytes(uuid, 16);
42 /* Set UUID version to 4 --- truly random generation */
43 uuid[6] = (uuid[6] & 0x0F) | 0x40;
44 /* Set the UUID variant to DCE */
45 uuid[8] = (uuid[8] & 0x3F) | 0x80;
46}
47EXPORT_SYMBOL(generate_random_uuid);
48
Huang Yingfab1c232010-05-18 14:35:18 +080049static void __uuid_gen_common(__u8 b[16])
50{
Akinobu Mitacedddb02013-04-29 16:21:25 -070051 prandom_bytes(b, 16);
Huang Yingfab1c232010-05-18 14:35:18 +080052 /* reversion 0b10 */
53 b[8] = (b[8] & 0x3F) | 0x80;
54}
55
Christoph Hellwigf9727a12017-05-17 10:02:48 +020056void guid_gen(guid_t *lu)
Huang Yingfab1c232010-05-18 14:35:18 +080057{
58 __uuid_gen_common(lu->b);
59 /* version 4 : random generation */
60 lu->b[7] = (lu->b[7] & 0x0F) | 0x40;
61}
Christoph Hellwigf9727a12017-05-17 10:02:48 +020062EXPORT_SYMBOL_GPL(guid_gen);
Huang Yingfab1c232010-05-18 14:35:18 +080063
Christoph Hellwigf9727a12017-05-17 10:02:48 +020064void uuid_gen(uuid_t *bu)
Huang Yingfab1c232010-05-18 14:35:18 +080065{
66 __uuid_gen_common(bu->b);
67 /* version 4 : random generation */
68 bu->b[6] = (bu->b[6] & 0x0F) | 0x40;
69}
Christoph Hellwigf9727a12017-05-17 10:02:48 +020070EXPORT_SYMBOL_GPL(uuid_gen);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070071
72/**
73 * uuid_is_valid - checks if UUID string valid
74 * @uuid: UUID string to check
75 *
76 * Description:
77 * It checks if the UUID string is following the format:
78 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
79 * where x is a hex digit.
80 *
81 * Return: true if input is valid UUID string.
82 */
83bool uuid_is_valid(const char *uuid)
84{
85 unsigned int i;
86
87 for (i = 0; i < UUID_STRING_LEN; i++) {
88 if (i == 8 || i == 13 || i == 18 || i == 23) {
89 if (uuid[i] != '-')
90 return false;
91 } else if (!isxdigit(uuid[i])) {
92 return false;
93 }
94 }
95
96 return true;
97}
98EXPORT_SYMBOL(uuid_is_valid);
99
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200100static int __uuid_parse(const char *uuid, __u8 b[16], const u8 ei[16])
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700101{
102 static const u8 si[16] = {0,2,4,6,9,11,14,16,19,21,24,26,28,30,32,34};
103 unsigned int i;
104
105 if (!uuid_is_valid(uuid))
106 return -EINVAL;
107
108 for (i = 0; i < 16; i++) {
Bjørn Morkbc9dc9d2016-05-30 17:40:42 +0300109 int hi = hex_to_bin(uuid[si[i] + 0]);
110 int lo = hex_to_bin(uuid[si[i] + 1]);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700111
112 b[ei[i]] = (hi << 4) | lo;
113 }
114
115 return 0;
116}
117
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200118int guid_parse(const char *uuid, guid_t *u)
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700119{
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200120 return __uuid_parse(uuid, u->b, guid_index);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700121}
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200122EXPORT_SYMBOL(guid_parse);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700123
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200124int uuid_parse(const char *uuid, uuid_t *u)
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700125{
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200126 return __uuid_parse(uuid, u->b, uuid_index);
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -0700127}
Christoph Hellwigf9727a12017-05-17 10:02:48 +0200128EXPORT_SYMBOL(uuid_parse);