uuid.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal/uuid.h: A type and helper functions for a Universally Unique Identifier (UUID) */
 
#ifndef ETCPAL_UUID_H_
#define ETCPAL_UUID_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include "etcpal/error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ETCPAL_UUID_BYTES 16u
 
typedef struct EtcPalUuid
{
  uint8_t data[ETCPAL_UUID_BYTES]; 
} EtcPalUuid;
 
#define ETCPAL_UUID_CMP(uuid1ptr, uuid2ptr) memcmp((uuid1ptr)->data, (uuid2ptr)->data, ETCPAL_UUID_BYTES)
 
extern const EtcPalUuid kEtcPalNullUuid;
 
#define ETCPAL_UUID_IS_NULL(uuidptr) (memcmp((uuidptr)->data, kEtcPalNullUuid.data, ETCPAL_UUID_BYTES) == 0)
 
#define ETCPAL_UUID_STRING_BYTES 37
 
#define ETCPAL_UUID_DEV_STR_MAX_LEN 32
 
bool etcpal_uuid_to_string(const EtcPalUuid* uuid, char* buf);
bool etcpal_string_to_uuid(const char* str, EtcPalUuid* uuid);
 
/************************ UUID Generation Functions **************************/
 
etcpal_error_t etcpal_generate_v1_uuid(EtcPalUuid* uuid);
etcpal_error_t etcpal_generate_v3_uuid(const EtcPalUuid* ns, const void* name, size_t name_len, EtcPalUuid* uuid);
etcpal_error_t etcpal_generate_v4_uuid(EtcPalUuid* uuid);
etcpal_error_t etcpal_generate_v5_uuid(const EtcPalUuid* ns, const void* name, size_t name_len, EtcPalUuid* uuid);
etcpal_error_t etcpal_generate_os_preferred_uuid(EtcPalUuid* uuid);
etcpal_error_t etcpal_generate_device_uuid(const char*    dev_str,
                                           const uint8_t* mac_addr,
                                           uint32_t       uuid_num,
                                           EtcPalUuid*    uuid);
 
#ifdef __cplusplus
}
#endif
 
#ifdef __cplusplus
 
/* C++ utilities */
 
/* Comparison operators for UUIDs */
 
inline bool operator<(const EtcPalUuid& a, const EtcPalUuid& b)
{
  return (ETCPAL_UUID_CMP(&a, &b) < 0);
}
 
inline bool operator==(const EtcPalUuid& a, const EtcPalUuid& b)
{
  return (ETCPAL_UUID_CMP(&a, &b) == 0);
}
 
#endif
 
#endif /* ETCPAL_UUID_H_ */