LXR linux/include/linux/uuid.h

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