|
|
|
|
@ -7,13 +7,13 @@
|
|
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @defgroup sys_uuid (Locally) Unique ID Generator |
|
|
|
|
* @defgroup sys_luid Locally Unique ID Generator |
|
|
|
|
* @ingroup sys |
|
|
|
|
* @brief Generate system wide unique IDs |
|
|
|
|
* @brief Generate system wide (locally) unique IDs |
|
|
|
|
* |
|
|
|
|
* This module generates system wide, variable length unique IDs based on on the |
|
|
|
|
* cpuid module. If the cpuid module is not present, the module falls back to a |
|
|
|
|
* pre-defined, constant seed for creating unique ids. |
|
|
|
|
* pre-defined, constant seed for creating unique IDs. |
|
|
|
|
* |
|
|
|
|
* The main purpose of this module is to have a unified way for e.g. creating |
|
|
|
|
* hardware addresses and similar. |
|
|
|
|
@ -24,24 +24,24 @@
|
|
|
|
|
* base ID is created by simple 'memsetting' the base ID with the defined |
|
|
|
|
* backup seed value. |
|
|
|
|
* |
|
|
|
|
* Once the base ID is generated, a UUID is generated by (i) XORing a counter |
|
|
|
|
* Once the base ID is generated, a LUID is generated by (i) XORing a counter |
|
|
|
|
* value with the LSB of the base ID, or (ii) by XORing the least significant |
|
|
|
|
* byes with a value given by the user. |
|
|
|
|
* |
|
|
|
|
* Example: Calling `uuid_base(&buf, 8)` will always yield an identical value, |
|
|
|
|
* Example: Calling `luid_base(&buf, 8)` will always yield an identical value, |
|
|
|
|
* independent how often the function is called. But calling |
|
|
|
|
* `uuid_base(&buf, 2)` afterwards will results in a different value, if the |
|
|
|
|
* `luid_base(&buf, 2)` afterwards will results in a different value, if the |
|
|
|
|
* cpuid module is present, and in the same (but shorter) value if not. |
|
|
|
|
* |
|
|
|
|
* Example: Calling `uuid_get(&buf, 8)` four times in a row, will yield four |
|
|
|
|
* Example: Calling `luid_get(&buf, 8)` four times in a row, will yield four |
|
|
|
|
* different IDs, differing in their LSB. |
|
|
|
|
* |
|
|
|
|
* Example: Calling `uuid_custom(&buf, 8, 123)` will always yield the same |
|
|
|
|
* value, but calling `uuid_custom(&buf, 8, 124)` will differ. |
|
|
|
|
* Example: Calling `luid_custom(&buf, 8, 123)` will always yield the same |
|
|
|
|
* value, but calling `luid_custom(&buf, 8, 124)` will differ. |
|
|
|
|
* |
|
|
|
|
* @note This module generates unique IDs without any guarantees on their |
|
|
|
|
* structure. These UUIDs are not compatible nor conform to the |
|
|
|
|
* UUIDs as defined in RFC4122. |
|
|
|
|
* @note This module generates locally unique IDs without any guarantees |
|
|
|
|
* on their structure. These LUIDs are not compatible nor conform |
|
|
|
|
* to UUIDs as defined in RFC4122. |
|
|
|
|
* |
|
|
|
|
* @{ |
|
|
|
|
* @file |
|
|
|
|
@ -50,8 +50,8 @@
|
|
|
|
|
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> |
|
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
#ifndef UUID_H_ |
|
|
|
|
#define UUID_H_ |
|
|
|
|
#ifndef LUID_H_ |
|
|
|
|
#define LUID_H_ |
|
|
|
|
|
|
|
|
|
#include <stddef.h> |
|
|
|
|
|
|
|
|
|
@ -60,27 +60,27 @@ extern "C" {
|
|
|
|
|
#endif |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Value used as based for the UUIDs in case the cpuid module is not |
|
|
|
|
* @brief Value used as based for the LUIDs in case the cpuid module is not |
|
|
|
|
* present |
|
|
|
|
*/ |
|
|
|
|
#ifndef UUID_BACKUP_SEED |
|
|
|
|
#define UUID_BACKUP_SEED 0x23 |
|
|
|
|
#ifndef LUID_BACKUP_SEED |
|
|
|
|
#define LUID_BACKUP_SEED 0x23 |
|
|
|
|
#endif |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Get a unique ID |
|
|
|
|
* |
|
|
|
|
* The resulting ID is built from the base ID generated with uuid_base(), which |
|
|
|
|
* The resulting ID is built from the base ID generated with luid_base(), which |
|
|
|
|
* isXORed with an 8-bit incrementing counter value into the most significant |
|
|
|
|
* byte. |
|
|
|
|
* |
|
|
|
|
* @note The resulting UUID will repeat after 255 calls. |
|
|
|
|
* @note The resulting LUID will repeat after 255 calls. |
|
|
|
|
* |
|
|
|
|
* @param[out] buf memory location to copy the UUID into. MUST be able to |
|
|
|
|
* @param[out] buf memory location to copy the LUID into. MUST be able to |
|
|
|
|
* hold at least @p len bytes |
|
|
|
|
* @param[in] len length of the UUID in bytes |
|
|
|
|
* @param[in] len length of the LUID in bytes |
|
|
|
|
*/ |
|
|
|
|
void uuid_get(void *buf, size_t len); |
|
|
|
|
void luid_get(void *buf, size_t len); |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Get a custom unique ID based on a user given generator value |
|
|
|
|
@ -89,31 +89,31 @@ void uuid_get(void *buf, size_t len);
|
|
|
|
|
* ID's most significant bytes. |
|
|
|
|
* |
|
|
|
|
* @note Calling this function with identical values for @p gen and @p len |
|
|
|
|
* will always result in identical UUIDs. |
|
|
|
|
* will always result in identical LUIDs. |
|
|
|
|
* |
|
|
|
|
* @param[out] buf memory location to copy the UUID into. MUST be able to |
|
|
|
|
* @param[out] buf memory location to copy the LUID into. MUST be able to |
|
|
|
|
* hold at least @p len bytes |
|
|
|
|
* @param[in] len length of the UUID in bytes |
|
|
|
|
* @param[in] gen custom UUID generator value |
|
|
|
|
* @param[in] len length of the LUID in bytes |
|
|
|
|
* @param[in] gen custom LUID generator value |
|
|
|
|
*/ |
|
|
|
|
void uuid_custom(void *buf, size_t len, int gen); |
|
|
|
|
void luid_custom(void *buf, size_t len, int gen); |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Get a UUID base value |
|
|
|
|
* @brief Get a LUID base value |
|
|
|
|
* |
|
|
|
|
* The uuid module creates the value dependent on the given @p len value using |
|
|
|
|
* the cpuid module if present or a static seed value (@ref UUID_BACKUP_SEED) if |
|
|
|
|
* The luid module creates the value dependent on the given @p len value using |
|
|
|
|
* the cpuid module if present or a static seed value (@ref LUID_BACKUP_SEED) if |
|
|
|
|
* not. |
|
|
|
|
* |
|
|
|
|
* @param[out] buf memory location to copy the UUID into. MUST be able to |
|
|
|
|
* @param[out] buf memory location to copy the LUID into. MUST be able to |
|
|
|
|
* hold at least @p len bytes |
|
|
|
|
* @param[in] len length of the UUID in bytes |
|
|
|
|
* @param[in] len length of the LUID in bytes |
|
|
|
|
*/ |
|
|
|
|
void uuid_base(void *buf, size_t len); |
|
|
|
|
void luid_base(void *buf, size_t len); |
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus |
|
|
|
|
} |
|
|
|
|
#endif |
|
|
|
|
|
|
|
|
|
#endif /* UUID_H_ */ |
|
|
|
|
#endif /* LUID_H_ */ |
|
|
|
|
/** @} */ |
Hauke Petersen
5 years ago