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