1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/**
* Copyright (C) 2017 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <functional>
#include <string>
#include <third_party/murmurhash3/MurmurHash3.h>
#include "mongo/base/status_with.h"
#include "mongo/bson/bsonelement.h"
#include "mongo/bson/bsonmisc.h"
#include "mongo/bson/bsonobj.h"
namespace mongo {
/**
* A UUID is a 128-bit unique identifier, per RFC 4122, v4, using
* a secure random number generator.
*/
class UUID {
using UUIDStorage = std::array<unsigned char, 16>;
public:
UUID() = delete;
/**
* The number of bytes contained in a UUID.
*/
static constexpr int kNumBytes = sizeof(UUIDStorage);
/**
* Generate a new random v4 UUID per RFC 4122.
*/
static UUID gen();
/**
* If the given string represents a valid UUID, constructs and returns the UUID,
* otherwise returns an error.
*/
static StatusWith<UUID> parse(const std::string& s);
/**
* If the given BSONElement represents a valid UUID, constructs and returns the UUID,
* otherwise returns an error.
*/
static StatusWith<UUID> parse(BSONElement from);
/**
* Returns whether this string represents a valid UUID.
*/
static bool isUUIDString(const std::string& s);
/**
* Append to builder as BinData(4, "...") element with the given name.
*/
void appendToBuilder(BSONObjBuilder* builder, StringData name) const;
/**
* Return a BSON object of the form { uuid: BinData(4, "...") }.
*/
BSONObj toBSON() const;
/**
* Return a string representation of this UUID, in hexadecimal,
* as per RFC 4122:
*
* 4 Octets - 2 Octets - 2 Octets - 2 Octets - 6 Octets
*/
std::string toString() const;
inline bool operator==(const UUID& rhs) const {
return !memcmp(&_uuid, &rhs._uuid, sizeof(_uuid));
}
inline bool operator!=(const UUID& rhs) const {
return !(*this == rhs);
}
/**
* Custom hasher so UUIDs can be used in unordered data structures.
*
* ex: std::unordered_set<UUID, UUID::Hash> uuidSet;
*/
struct Hash {
std::size_t operator()(const UUID& uuid) const {
uint32_t hash;
MurmurHash3_x86_32(uuid._uuid.data(), UUID::kNumBytes, 0, &hash);
return hash;
}
};
private:
UUID(const UUIDStorage& uuid) : _uuid(uuid) {}
UUIDStorage _uuid; // UUID in network byte order
};
inline std::ostream& operator<<(std::ostream& s, const UUID& uuid) {
return (s << uuid.toString());
}
inline StringBuilder& operator<<(StringBuilder& s, const UUID& uuid) {
return (s << uuid.toString());
}
/**
* Supports use of UUID with the BSON macro:
* BSON("uuid" << uuid) -> { uuid: BinData(4, "...") }
*/
template <>
BSONObjBuilder& BSONObjBuilderValueStream::operator<<<UUID>(UUID value);
} // namespace mongo
|
