LXR linux/include/linux/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 <uapi/linux/uuid.h>
  12#include <linux/string.h>
  13
  14#define UUID_SIZE 16
  15
  16typedef struct {
  17        __u8 b[UUID_SIZE];
  18} uuid_t;
  19
  20#define UUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)                      \
  21((uuid_t)                                                               \
  22{{ ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, ((a) >> 8) & 0xff, (a) & 0xff, \
  23   ((b) >> 8) & 0xff, (b) & 0xff,                                       \
  24   ((c) >> 8) & 0xff, (c) & 0xff,                                       \
  25   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
  26
  27/*
  28 * The length of a UUID string ("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
  29 * not including trailing NUL.
  30 */
  31#define UUID_STRING_LEN         36
  32
  33extern const guid_t guid_null;
  34extern const uuid_t uuid_null;
  35
  36static inline bool guid_equal(const guid_t *u1, const guid_t *u2)
  37{
  38        return memcmp(u1, u2, sizeof(guid_t)) == 0;
  39}
  40
  41static inline void guid_copy(guid_t *dst, const guid_t *src)
  42{
  43        memcpy(dst, src, sizeof(guid_t));
  44}
  45
  46static inline void import_guid(guid_t *dst, const __u8 *src)
  47{
  48        memcpy(dst, src, sizeof(guid_t));
  49}
  50
  51static inline void export_guid(__u8 *dst, const guid_t *src)
  52{
  53        memcpy(dst, src, sizeof(guid_t));
  54}
  55
  56static inline bool guid_is_null(const guid_t *guid)
  57{
  58        return guid_equal(guid, &guid_null);
  59}
  60
  61static inline bool uuid_equal(const uuid_t *u1, const uuid_t *u2)
  62{
  63        return memcmp(u1, u2, sizeof(uuid_t)) == 0;
  64}
  65
  66static inline void uuid_copy(uuid_t *dst, const uuid_t *src)
  67{
  68        memcpy(dst, src, sizeof(uuid_t));
  69}
  70
  71static inline void import_uuid(uuid_t *dst, const __u8 *src)
  72{
  73        memcpy(dst, src, sizeof(uuid_t));
  74}
  75
  76static inline void export_uuid(__u8 *dst, const uuid_t *src)
  77{
  78        memcpy(dst, src, sizeof(uuid_t));
  79}
  80
  81static inline bool uuid_is_null(const uuid_t *uuid)
  82{
  83        return uuid_equal(uuid, &uuid_null);
  84}
  85
  86void generate_random_uuid(unsigned char uuid[16]);
  87void generate_random_guid(unsigned char guid[16]);
  88
  89extern void guid_gen(guid_t *u);
  90extern void uuid_gen(uuid_t *u);
  91
  92bool __must_check uuid_is_valid(const char *uuid);
  93
  94extern const u8 guid_index[16];
  95extern const u8 uuid_index[16];
  96
  97int guid_parse(const char *uuid, guid_t *u);
  98int uuid_parse(const char *uuid, uuid_t *u);
  99
 100/* backwards compatibility, don't use in new code */
 101static inline int uuid_le_cmp(const guid_t u1, const guid_t u2)
 102{
 103        return memcmp(&u1, &u2, sizeof(guid_t));
 104}
 105
 106#endif
 107