src/common/uuid.h

   1 /*
   2  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  */
   7
   8 #ifndef LTTNG_UUID_H
   9 #define LTTNG_UUID_H
  10
  11 #include <common/macros.h>
  12 #include <stdbool.h>
  13 #include <stdint.h>
  14 #include <inttypes.h>
  15
  16 /*
  17  * Includes final \0.
  18  */
  19 #define LTTNG_UUID_STR_LEN      37
  20 #define LTTNG_UUID_LEN          16
  21 #define LTTNG_UUID_VER          4
  22
  23 #define LTTNG_UUID_FMT \
  24         "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 "-%02" SCNx8 \
  25         "%02" SCNx8 "-%02" SCNx8 "%02" SCNx8 "-%02" SCNx8 "%02" SCNx8 \
  26         "-%02" SCNx8 "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 \
  27         "%02" SCNx8
  28
  29 #define LTTNG_UUID_FMT_VALUES(uuid) \
  30         (uuid)[0], (uuid)[1], (uuid)[2], (uuid)[3], (uuid)[4], (uuid)[5], \
  31         (uuid)[6], (uuid)[7], (uuid)[8], (uuid)[9], (uuid)[10], (uuid)[11], \
  32         (uuid)[12], (uuid)[13], (uuid)[14], (uuid)[15]
  33
  34 #define LTTNG_UUID_SCAN_VALUES(uuid) \
  35         &(uuid)[0], &(uuid)[1], &(uuid)[2], &(uuid)[3], &(uuid)[4], &(uuid)[5], \
  36         &(uuid)[6], &(uuid)[7], &(uuid)[8], &(uuid)[9], &(uuid)[10], &(uuid)[11], \
  37         &(uuid)[12], &(uuid)[13], &(uuid)[14], &(uuid)[15]
  38
  39 typedef uint8_t lttng_uuid[LTTNG_UUID_LEN];
  40
  41 LTTNG_HIDDEN
  42 int lttng_uuid_from_str(const char *str_in, lttng_uuid uuid_out);
  43
  44 /*
  45  * Convert a UUID to a human-readable, NULL-terminated, string of the form
  46  * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  47  *
  48  * Assumes uuid_str is at least LTTNG_UUID_STR_LEN byte long.
  49  */
  50 LTTNG_HIDDEN
  51 void lttng_uuid_to_str(const lttng_uuid uuid, char *uuid_str);
  52
  53 LTTNG_HIDDEN
  54 bool lttng_uuid_is_equal(const lttng_uuid a, const lttng_uuid b);
  55
  56 LTTNG_HIDDEN
  57 bool lttng_uuid_is_nil(const lttng_uuid uuid);
  58
  59 LTTNG_HIDDEN
  60 void lttng_uuid_copy(lttng_uuid dst, const lttng_uuid src);
  61
  62 /*
  63  * Generate a random UUID according to RFC4122, section 4.4.
  64  */
  65 LTTNG_HIDDEN
  66 int lttng_uuid_generate(lttng_uuid uuid_out);
  67
  68 #endif /* LTTNG_UUID_H */