GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/shortstring.h
Date: 2025-08-31 02:39:21
Exec Total Coverage
Lines: 91 108 84.3%
Branches: 34 50 68.0%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 *
4 * Implements a string class that stores short strings on the stack and
5 * malloc's a std::string on the heap on overflow. Used for file names and
6 * path names that are usually small.
7 */
8
9 #ifndef CVMFS_SHORTSTRING_H_
10 #define CVMFS_SHORTSTRING_H_
11
12 #include <algorithm>
13 #include <cstring>
14 #include <string>
15
16 #include "util/atomic.h"
17
18 #ifdef CVMFS_NAMESPACE_GUARD
19 namespace CVMFS_NAMESPACE_GUARD {
20 #endif
21
22 const unsigned char kDefaultMaxName = 25;
23 const unsigned char kDefaultMaxLink = 25;
24 const unsigned char kDefaultMaxPath = 200;
25
26 template<unsigned char StackSize, char Type>
27 class ShortString {
28 public:
29 78661088 ShortString() : long_string_(NULL), length_(0) {
30 #ifdef DEBUGMSG
31 78661088 atomic_inc64(&num_instances_);
32 #endif
33 78661088 }
34 8299063 ShortString(const ShortString &other) : long_string_(NULL) {
35 #ifdef DEBUGMSG
36 16598126 atomic_inc64(&num_instances_);
37 #endif
38 16630054 Assign(other);
39 16601558 }
40 176128 ShortString(const char *chars, const unsigned length) : long_string_(NULL) {
41 #ifdef DEBUGMSG
42 176128 atomic_inc64(&num_instances_);
43 #endif
44 176344 Assign(chars, length);
45 176216 }
46 8800056 explicit ShortString(const std::string &std_string) : long_string_(NULL) {
47 #ifdef DEBUGMSG
48 8800056 atomic_inc64(&num_instances_);
49 #endif
50 8927008 Assign(std_string.data(), std_string.length());
51 8844168 }
52
53 6035464 ShortString &operator=(const ShortString &other) {
54
1/2
✓ Branch 0 taken 3019656 times.
✗ Branch 1 not taken.
 6035464 if (this != &other)
55 6039312 Assign(other);
56 5958032 return *this;
57 }
58
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 50754822 times.
 101509644 ~ShortString() { delete long_string_; }
60
61 31811462 void Assign(const char *chars, const unsigned length) {
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 15905731 times.
 31811462 delete long_string_;
63 31768918 long_string_ = NULL;
64 31768918 this->length_ = length;
65
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 15884459 times.
 31768918 if (length > StackSize) {
66 #ifdef DEBUGMSG
67 ✗ atomic_inc64(&num_overflows_);
68 #endif
69 ✗ long_string_ = new std::string(chars, length);
70 } else {
71
2/2
✓ Branch 0 taken 15626994 times.
✓ Branch 1 taken 257465 times.
 31768918 if (length)
72 31253988 memcpy(stack_, chars, length);
73 }
74 31768918 }
75
76 22642324 void Assign(const ShortString &other) {
77 22642324 Assign(other.GetChars(), other.GetLength());
78 22565540 }
79
80 132208 void Append(const char *chars, const unsigned length) {
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 132208 times.
 132208 if (long_string_) {
82 ✗ long_string_->append(chars, length);
83 ✗ return;
84 }
85
86 132208 const unsigned new_length = this->length_ + length;
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 132208 times.
 132208 if (new_length > StackSize) {
88 #ifdef DEBUGMSG
89 ✗ atomic_inc64(&num_overflows_);
90 #endif
91 ✗ long_string_ = new std::string();
92 ✗ long_string_->reserve(new_length);
93 ✗ long_string_->assign(stack_, length_);
94 ✗ long_string_->append(chars, length);
95 ✗ return;
96 }
97
2/2
✓ Branch 0 taken 130472 times.
✓ Branch 1 taken 1736 times.
 132208 if (length > 0)
98 130472 memcpy(&stack_[this->length_], chars, length);
99 132208 this->length_ = new_length;
100 }
101
102 /**
103 * Truncates the current string to be of size smaller or equal to current size
104 *
105 * Note: Can lead to a heap allocated string that is shorter than
106 * the reserved stack space.
107 */
108 2592 void Truncate(unsigned new_length) {
109
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2592 times.
 2592 assert(new_length <= this->GetLength());
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2592 times.
 2592 if (long_string_) {
111 ✗ long_string_->erase(new_length);
112 ✗ return;
113 }
114 2592 this->length_ = new_length;
115 }
116
117 void Clear() {
118 delete long_string_;
119 long_string_ = NULL;
120 length_ = 0;
121 }
122
123 32459798 const char *GetChars() const {
124
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 16229899 times.
 32459798 if (long_string_) {
125 ✗ return long_string_->data();
126 } else {
127 32459798 return stack_;
128 }
129 }
130
131 33207632 unsigned GetLength() const {
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 16603816 times.
 33207632 if (long_string_)
133 ✗ return long_string_->length();
134 33207632 return length_;
135 }
136
137 55266 bool IsEmpty() const { return GetLength() == 0; }
138
139 4467270 std::string ToString() const {
140
1/2
✓ Branch 4 taken 4466122 times.
✗ Branch 5 not taken.
 4467270 return std::string(this->GetChars(), this->GetLength());
141 }
142
143 155698 const char *c_str() const {
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 92719 times.
 155698 if (long_string_)
145 ✗ return long_string_->c_str();
146
147 155698 char *c = const_cast<char *>(stack_) + length_;
148 155698 *c = '\0';
149 155698 return stack_;
150 }
151
152 29874 bool operator==(const ShortString &other) const {
153 29874 const unsigned this_length = this->GetLength();
154 29874 const unsigned other_length = other.GetLength();
155
2/2
✓ Branch 0 taken 18395 times.
✓ Branch 1 taken 9222 times.
 29874 if (this_length != other_length)
156 18461 return false;
157
2/2
✓ Branch 0 taken 5433 times.
✓ Branch 1 taken 3789 times.
 11413 if (this_length == 0)
158 7244 return true;
159
160 4169 return memcmp(this->GetChars(), other.GetChars(), this_length) == 0;
161 }
162
163 21222 bool operator!=(const ShortString &other) const { return !(*this == other); }
164
165 29217 bool operator<(const ShortString &other) const {
166 29217 const unsigned this_length = this->GetLength();
167 29217 const unsigned other_length = other.GetLength();
168
169
2/2
✓ Branch 0 taken 8027 times.
✓ Branch 1 taken 21190 times.
 29217 if (this_length < other_length)
170 8027 return true;
171
2/2
✓ Branch 0 taken 4464 times.
✓ Branch 1 taken 16726 times.
 21190 if (this_length > other_length)
172 4464 return false;
173
174 16726 const char *this_chars = this->GetChars();
175 16726 const char *other_chars = other.GetChars();
176
2/2
✓ Branch 0 taken 154688 times.
✓ Branch 1 taken 14906 times.
 169594 for (unsigned i = 0; i < this_length; ++i) {
177
2/2
✓ Branch 0 taken 1390 times.
✓ Branch 1 taken 153298 times.
 154688 if (this_chars[i] < other_chars[i])
178 1390 return true;
179
2/2
✓ Branch 0 taken 430 times.
✓ Branch 1 taken 152868 times.
 153298 if (this_chars[i] > other_chars[i])
180 430 return false;
181 }
182 14906 return false;
183 }
184
185 31264 bool StartsWith(const ShortString &other) const {
186 31264 const unsigned this_length = this->GetLength();
187 31264 const unsigned other_length = other.GetLength();
188
2/2
✓ Branch 0 taken 1364 times.
✓ Branch 1 taken 29900 times.
 31264 if (this_length < other_length)
189 1364 return false;
190
191 29900 return memcmp(this->GetChars(), other.GetChars(), other_length) == 0;
192 }
193
194 12397 ShortString Suffix(const unsigned start_at) const {
195 12397 const unsigned length = this->GetLength();
196
2/2
✓ Branch 0 taken 8 times.
✓ Branch 1 taken 12389 times.
 12397 if (start_at >= length)
197 8 return ShortString("", 0);
198
199 12389 return ShortString(this->GetChars() + start_at, length - start_at);
200 }
201
202 ✗ static uint64_t num_instances() { return atomic_read64(&num_instances_); }
203 ✗ static uint64_t num_overflows() { return atomic_read64(&num_overflows_); }
204
205 private:
206 std::string *long_string_;
207 char stack_[StackSize + 1]; // +1 to add a final '\0' if necessary
208 unsigned char length_;
209 static atomic_int64 num_overflows_;
210 static atomic_int64 num_instances_;
211 }; // class ShortString
212
213 typedef ShortString<kDefaultMaxPath, 0> PathString;
214 typedef ShortString<kDefaultMaxName, 1> NameString;
215 typedef ShortString<kDefaultMaxLink, 2> LinkString;
216
217 template<unsigned char StackSize, char Type>
218 atomic_int64 ShortString<StackSize, Type>::num_overflows_ = 0;
219 template<unsigned char StackSize, char Type>
220 atomic_int64 ShortString<StackSize, Type>::num_instances_ = 0;
221
222 // See posix.cc for the std::string counterparts
223 PathString GetParentPath(const PathString &path);
224 NameString GetFileName(const PathString &path);
225
226 bool IsSubPath(const PathString &parent, const PathString &path);
227
228
229 #ifdef CVMFS_NAMESPACE_GUARD
230 } // namespace CVMFS_NAMESPACE_GUARD
231 #endif
232
233 #endif // CVMFS_SHORTSTRING_H_
234