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