]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | /*- |
2 | * BSD LICENSE | |
3 | * | |
11fdf7f2 | 4 | * Copyright (c) Intel Corporation. |
7c673cae FG |
5 | * All rights reserved. |
6 | * | |
7 | * Redistribution and use in source and binary forms, with or without | |
8 | * modification, are permitted provided that the following conditions | |
9 | * are met: | |
10 | * | |
11 | * * Redistributions of source code must retain the above copyright | |
12 | * notice, this list of conditions and the following disclaimer. | |
13 | * * Redistributions in binary form must reproduce the above copyright | |
14 | * notice, this list of conditions and the following disclaimer in | |
15 | * the documentation and/or other materials provided with the | |
16 | * distribution. | |
17 | * * Neither the name of Intel Corporation nor the names of its | |
18 | * contributors may be used to endorse or promote products derived | |
19 | * from this software without specific prior written permission. | |
20 | * | |
21 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
22 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
23 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
24 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
25 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
26 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
27 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
28 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
29 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
30 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
31 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
32 | */ | |
33 | ||
11fdf7f2 TL |
34 | /** \file |
35 | * UUID types and functions | |
36 | */ | |
37 | ||
38 | #ifndef SPDK_UUID_H | |
39 | #define SPDK_UUID_H | |
40 | ||
41 | #include "spdk/stdinc.h" | |
7c673cae | 42 | |
11fdf7f2 | 43 | #include "spdk/assert.h" |
7c673cae FG |
44 | |
45 | #ifdef __cplusplus | |
46 | extern "C" { | |
47 | #endif | |
48 | ||
11fdf7f2 TL |
49 | struct spdk_uuid { |
50 | union { | |
51 | uint8_t raw[16]; | |
52 | } u; | |
53 | }; | |
54 | SPDK_STATIC_ASSERT(sizeof(struct spdk_uuid) == 16, "Incorrect size"); | |
55 | ||
56 | #define SPDK_UUID_STRING_LEN 37 /* 36 characters + null terminator */ | |
7c673cae FG |
57 | |
58 | /** | |
11fdf7f2 | 59 | * Convert UUID in textual format into a spdk_uuid. |
7c673cae | 60 | * |
11fdf7f2 TL |
61 | * \param[out] uuid User-provided UUID buffer. |
62 | * \param uuid_str UUID in textual format in C string. | |
7c673cae | 63 | * |
11fdf7f2 | 64 | * \return 0 on success, or negative errno on failure. |
7c673cae | 65 | */ |
11fdf7f2 | 66 | int spdk_uuid_parse(struct spdk_uuid *uuid, const char *uuid_str); |
7c673cae FG |
67 | |
68 | /** | |
11fdf7f2 TL |
69 | * Convert UUID in spdk_uuid into lowercase textual format. |
70 | * | |
71 | * \param uuid_str User-provided string buffer to write the textual format into. | |
72 | * \param uuid_str_size Size of uuid_str buffer. Must be at least SPDK_UUID_STRING_LEN. | |
73 | * \param uuid UUID to convert to textual format. | |
7c673cae | 74 | * |
11fdf7f2 | 75 | * \return 0 on success, or negative errno on failure. |
7c673cae | 76 | */ |
11fdf7f2 | 77 | int spdk_uuid_fmt_lower(char *uuid_str, size_t uuid_str_size, const struct spdk_uuid *uuid); |
7c673cae FG |
78 | |
79 | /** | |
11fdf7f2 | 80 | * Compare two UUIDs. |
7c673cae | 81 | * |
11fdf7f2 TL |
82 | * \param u1 UUID 1. |
83 | * \param u2 UUID 2. | |
7c673cae | 84 | * |
11fdf7f2 | 85 | * \return 0 if u1 == u2, less than 0 if u1 < u2, greater than 0 if u1 > u2. |
7c673cae | 86 | */ |
11fdf7f2 | 87 | int spdk_uuid_compare(const struct spdk_uuid *u1, const struct spdk_uuid *u2); |
7c673cae FG |
88 | |
89 | /** | |
11fdf7f2 | 90 | * Generate a new UUID. |
7c673cae | 91 | * |
11fdf7f2 | 92 | * \param[out] uuid User-provided UUID buffer to fill. |
7c673cae | 93 | */ |
11fdf7f2 | 94 | void spdk_uuid_generate(struct spdk_uuid *uuid); |
7c673cae | 95 | |
9f95a23c TL |
96 | /** |
97 | * Copy a UUID. | |
98 | * | |
99 | * \param src Source UUID to copy from. | |
100 | * \param dst Destination UUID to store. | |
101 | */ | |
102 | void spdk_uuid_copy(struct spdk_uuid *dst, const struct spdk_uuid *src); | |
103 | ||
7c673cae FG |
104 | #ifdef __cplusplus |
105 | } | |
106 | #endif | |
107 | ||
11fdf7f2 | 108 | #endif |