uuid.h

  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 * UUID/GUID definition
  4 *
  5 * Copyright (C) 2010, 2016 Intel Corp.
  6 *	Huang Ying <ying.huang@intel.com>
  7 */
  8#ifndef _LINUX_UUID_H_
  9#define _LINUX_UUID_H_
 10
 11#include <linux/string.h>
 12
 13#define UUID_SIZE 16
 14
 15typedef struct {
 16	__u8 b[UUID_SIZE];
 17} guid_t;
 18
 19typedef struct {
 20	__u8 b[UUID_SIZE];
 21} uuid_t;
 22
 23#define GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)			\
 24((guid_t)								\
 25{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
 26   (b) & 0xff, ((b) >> 8) & 0xff,					\
 27   (c) & 0xff, ((c) >> 8) & 0xff,					\
 28   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
 29
 30#define UUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)			\
 31((uuid_t)								\
 32{{ ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, ((a) >> 8) & 0xff, (a) & 0xff, \
 33   ((b) >> 8) & 0xff, (b) & 0xff,					\
 34   ((c) >> 8) & 0xff, (c) & 0xff,					\
 35   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
 36
 37/*
 38 * The length of a UUID string ("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
 39 * not including trailing NUL.
 40 */
 41#define	UUID_STRING_LEN		36
 42
 43extern const guid_t guid_null;
 44extern const uuid_t uuid_null;
 45
 46static inline bool guid_equal(const guid_t *u1, const guid_t *u2)
 47{
 48	return memcmp(u1, u2, sizeof(guid_t)) == 0;
 49}
 50
 51static inline void guid_copy(guid_t *dst, const guid_t *src)
 52{
 53	memcpy(dst, src, sizeof(guid_t));
 54}
 55
 56static inline void import_guid(guid_t *dst, const __u8 *src)
 57{
 58	memcpy(dst, src, sizeof(guid_t));
 59}
 60
 61static inline void export_guid(__u8 *dst, const guid_t *src)
 62{
 63	memcpy(dst, src, sizeof(guid_t));
 64}
 65
 66static inline bool guid_is_null(const guid_t *guid)
 67{
 68	return guid_equal(guid, &guid_null);
 69}
 70
 71static inline bool uuid_equal(const uuid_t *u1, const uuid_t *u2)
 72{
 73	return memcmp(u1, u2, sizeof(uuid_t)) == 0;
 74}
 75
 76static inline void uuid_copy(uuid_t *dst, const uuid_t *src)
 77{
 78	memcpy(dst, src, sizeof(uuid_t));
 79}
 80
 81static inline void import_uuid(uuid_t *dst, const __u8 *src)
 82{
 83	memcpy(dst, src, sizeof(uuid_t));
 84}
 85
 86static inline void export_uuid(__u8 *dst, const uuid_t *src)
 87{
 88	memcpy(dst, src, sizeof(uuid_t));
 89}
 90
 91static inline bool uuid_is_null(const uuid_t *uuid)
 92{
 93	return uuid_equal(uuid, &uuid_null);
 94}
 95
 96void generate_random_uuid(unsigned char uuid[16]);
 97void generate_random_guid(unsigned char guid[16]);
 98
 99extern void guid_gen(guid_t *u);
100extern void uuid_gen(uuid_t *u);
101
102bool __must_check uuid_is_valid(const char *uuid);
103
104extern const u8 guid_index[16];
105extern const u8 uuid_index[16];
106
107int guid_parse(const char *uuid, guid_t *u);
108int uuid_parse(const char *uuid, uuid_t *u);
109
110#endif