opr: Add UUID handling functions
[openafs.git] / src / opr / uuid.c
1 /*
2  * Copyright (c) 2012 Your File System Inc. All rights reserved.
3  */
4
5 #include <afsconfig.h>
6 #include <afs/param.h>
7
8 #include <roken.h>
9
10 #ifdef HAVE_UUID_UUID_H
11 # include <uuid/uuid.h>
12 #endif
13
14 #ifdef AFS_NT40_ENV
15 # include <rpc.h>
16 #endif
17
18 #include <hcrypto/rand.h>
19
20 #include "uuid.h"
21 #include "jhash.h"
22
23 static const opr_uuid_t nilUid = {{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
24
25 void
26 opr_uuid_create(opr_uuid_t *uuid)
27 {
28 #if defined (AFS_NT40_ENV)
29     struct opr_uuid_unpacked raw;
30
31     UuidCreate((UUID *) &raw);
32     opr_uuid_pack(uuid, &raw);
33
34 #elif !defined(KERNEL) && defined(HAVE_UUID_GENERATE)
35
36     uuid_generate(uuid->data);
37
38 #else
39     RAND_bytes(uuid->data, 16);
40
41     uuid->data[6] = (uuid->data[6] & 0x0F) | 0x40; /* verison is 4 */
42     uuid->data[8] = (uuid->data[8] & 0x3F) | 0x80; /* variant is DCE */
43 #endif
44 }
45
46 int
47 opr_uuid_isNil(const opr_uuid_t *uuid)
48 {
49    return opr_uuid_equal(uuid, &nilUid);
50 }
51
52 int
53 opr_uuid_equal(const opr_uuid_t *uuid1, const opr_uuid_t *uuid2)
54 {
55    return memcmp(uuid1, uuid2, sizeof(opr_uuid_t)) == 0;
56 }
57
58 int
59 opr_uuid_hash(const opr_uuid_t *uuid)
60 {
61    /* uuid->data is a (unsigned char *), so there's every danger that this
62     * may cause an unaligned access on some platforms */
63    return opr_jhash((const afs_uint32 *)uuid->data, 4, 0);
64 }
65
66 #if !defined(KERNEL)
67 void
68 opr_uuid_toString(const opr_uuid_t *uuid, char **string)
69 {
70    unsigned const char *p;
71
72    p = uuid->data;
73    asprintf(string,
74             "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
75             "%02x%02x%02x%02x%02x%02x",
76             p[0], p[1], p[2],  p[3],  p[4],  p[5],  p[6],  p[7],
77             p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
78 }
79
80 void
81 opr_uuid_freeString(char *string)
82 {
83     free(string);
84 }
85
86 int
87 opr_uuid_fromString(opr_uuid_t *uuid, const char *string)
88 {
89     unsigned int i[16];
90     int items, c;
91
92     /* XXX - Traditionally, AFS has printed UUIDs as
93      * 00000000-0000-00-00-00000000. We should perhaps also accept
94      * that format here
95      */
96     items = sscanf(string,
97                    "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
98                    "%02x%02x%02x%02x%02x%02x",
99                    &i[0],  &i[1],  &i[2],  &i[3], &i[4],  &i[5],
100                    &i[6],  &i[7],  &i[8],  &i[9], &i[10], &i[11],
101                    &i[12], &i[13], &i[14], &i[15]);
102     if (items !=16) {
103         /* Originally, AFS's printed UUIDs would take the form
104          * 00000000-0000-0000-00-00-00000000. Also handle this. */
105         items = sscanf(string,
106                    "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x-%02x-"
107                    "%02x%02x%02x%02x%02x%02x",
108                    &i[0],  &i[1],  &i[2],  &i[3], &i[4],  &i[5],
109                    &i[6],  &i[7],  &i[8],  &i[9], &i[10], &i[11],
110                    &i[12], &i[13], &i[14], &i[15]);
111     }
112     if (items !=16)
113         return EINVAL;
114
115     for (c=0; c<16; c++)
116         uuid->data[c] = i[c];
117
118     return 0;
119 }
120
121 void
122 opr_uuid_pack(opr_uuid_t *uuid, const struct opr_uuid_unpacked *raw)
123 {
124     afs_uint32 intval;
125     unsigned short shortval;
126
127     intval = htonl(raw->time_low);
128     memcpy(&uuid->data[0], &intval, sizeof(uint32_t));
129
130     shortval = htons(raw->time_mid);
131     memcpy(&uuid->data[4], &shortval, sizeof(uint16_t));
132
133     shortval = htons(raw->time_hi_and_version);
134     memcpy(&uuid->data[6], &shortval, sizeof(uint16_t));
135
136     uuid->data[8] = raw->clock_seq_hi_and_reserved;
137     uuid->data[9] = raw->clock_seq_low;
138
139     memcpy(&uuid->data[10], &raw->node, 6);
140 }
141
142 void
143 opr_uuid_unpack(const opr_uuid_t *uuid, struct opr_uuid_unpacked *raw)
144 {
145     afs_uint32 intval;
146     unsigned short shortval;
147
148     memcpy(&intval, &uuid->data[0], sizeof(uint32_t));
149     raw->time_low = ntohl(intval);
150
151     memcpy(&shortval, &uuid->data[4], sizeof(uint16_t));
152     raw->time_mid = ntohs(shortval);
153
154     memcpy(&shortval, &uuid->data[6], sizeof(uint16_t));
155     raw->time_hi_and_version = ntohs(shortval);
156
157     raw->clock_seq_hi_and_reserved = uuid->data[8];
158     raw->clock_seq_low = uuid->data[9];
159
160     memcpy(&raw->node, &uuid->data[10], 6);
161 }
162
163 #endif