src/common/uuid.hpp

   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.hpp>
  12 #include <stdbool.h>
  13 #include <stdint.h>
  14 #include <inttypes.h>
  15 #include <array>
  16
  17 /*
  18  * Includes final \0.
  19  */
  20 #define LTTNG_UUID_STR_LEN      37
  21 #define LTTNG_UUID_LEN          16
  22 #define LTTNG_UUID_VER          4
  23
  24 #define LTTNG_UUID_FMT \
  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 "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 "%02" SCNx8 \
  28         "%02" SCNx8
  29
  30 #define LTTNG_UUID_FMT_VALUES(uuid) \
  31         (uuid)[0], (uuid)[1], (uuid)[2], (uuid)[3], (uuid)[4], (uuid)[5], \
  32         (uuid)[6], (uuid)[7], (uuid)[8], (uuid)[9], (uuid)[10], (uuid)[11], \
  33         (uuid)[12], (uuid)[13], (uuid)[14], (uuid)[15]
  34
  35 #define LTTNG_UUID_SCAN_VALUES(uuid) \
  36         &(uuid)[0], &(uuid)[1], &(uuid)[2], &(uuid)[3], &(uuid)[4], &(uuid)[5], \
  37         &(uuid)[6], &(uuid)[7], &(uuid)[8], &(uuid)[9], &(uuid)[10], &(uuid)[11], \
  38         &(uuid)[12], &(uuid)[13], &(uuid)[14], &(uuid)[15]
  39
  40 using lttng_uuid = std::array<uint8_t, LTTNG_UUID_LEN>;
  41
  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 void lttng_uuid_to_str(const lttng_uuid& uuid, char *uuid_str);
  51
  52 bool lttng_uuid_is_equal(const lttng_uuid& a, const lttng_uuid& b);
  53
  54 bool lttng_uuid_is_nil(const lttng_uuid& uuid);
  55
  56 /*
  57  * Generate a random UUID according to RFC4122, section 4.4.
  58  */
  59 int lttng_uuid_generate(lttng_uuid& uuid_out);
  60
  61 #endif /* LTTNG_UUID_H */