GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/shortstring.h
Date: 2026-08-30 02:40:36
Exec Total Coverage
Lines: 96 109 88.1%
Branches: 40 50 80.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 208264534 ShortString() : long_string_(NULL), length_(0) {
30 #ifdef DEBUGMSG
31 208264534 atomic_inc64(&num_instances_);
32 #endif
33 208264594 }
34 14343307 ShortString(const ShortString &other) : long_string_(NULL) {
35 #ifdef DEBUGMSG
36 28686614 atomic_inc64(&num_instances_);
37 #endif
38 28761444 Assign(other);
39 28694202 }
40 212769 ShortString(const char *chars, const unsigned length) : long_string_(NULL) {
41 #ifdef DEBUGMSG
42 212769 atomic_inc64(&num_instances_);
43 #endif
44 214389 Assign(chars, length);
45 213729 }
46 31230852 explicit ShortString(const std::string &std_string) : long_string_(NULL) {
47 #ifdef DEBUGMSG
48 31230852 atomic_inc64(&num_instances_);
49 #endif
50 32264892 Assign(std_string.data(), std_string.length());
51 31542972 }
52
53 26790670 ShortString &operator=(const ShortString &other) {
54
1/2
✓ Branch 0 taken 13405955 times.
✗ Branch 1 not taken.
 26790670 if (this != &other)
55 26811910 Assign(other);
56 26238730 return *this;
57 }
58
59
2/2
✓ Branch 0 taken 60 times.
✓ Branch 1 taken 131759392 times.
 263518904 ~ShortString() { delete long_string_; }
60
61 86890250 void Assign(const char *chars, const unsigned length) {
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 43445125 times.
 86890250 delete long_string_;
63 86508912 long_string_ = NULL;
64 86508912 this->length_ = length;
65
2/2
✓ Branch 0 taken 60 times.
✓ Branch 1 taken 43254396 times.
 86508912 if (length > StackSize) {
66 #ifdef DEBUGMSG
67 120 atomic_inc64(&num_overflows_);
68 #endif
69
2/4
✓ Branch 2 taken 60 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 60 times.
✗ Branch 6 not taken.
 120 long_string_ = new std::string(chars, length);
70 } else {
71
2/2
✓ Branch 0 taken 42867413 times.
✓ Branch 1 taken 386983 times.
 86508792 if (length)
72 85734826 memcpy(stack_, chars, length);
73 }
74 86508912 }
75
76 55463268 void Assign(const ShortString &other) {
77 55463268 Assign(other.GetChars(), other.GetLength());
78 54973942 }
79
80 198790 void Append(const char *chars, const unsigned length) {
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 198790 times.
 198790 if (long_string_) {
82 ✗ long_string_->append(chars, length);
83 ✗ return;
84 }
85
86 198790 const unsigned new_length = this->length_ + length;
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 198790 times.
 198790 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 194968 times.
✓ Branch 1 taken 3822 times.
 198790 if (length > 0)
98 194968 memcpy(&stack_[this->length_], chars, length);
99 198790 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 5096 void Truncate(unsigned new_length) {
109
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 5096 times.
 5096 assert(new_length <= this->GetLength());
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5096 times.
 5096 if (long_string_) {
111 ✗ long_string_->erase(new_length);
112 ✗ return;
113 }
114 5096 this->length_ = new_length;
115 }
116
117 void Clear() {
118 delete long_string_;
119 long_string_ = NULL;
120 length_ = 0;
121 }
122
123 89145912 const char *GetChars() const {
124
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 44572866 times.
 89145912 if (long_string_) {
125 180 return long_string_->data();
126 } else {
127 89145732 return stack_;
128 }
129 }
130
131 90128794 unsigned GetLength() const {
132
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 45064307 times.
 90128794 if (long_string_)
133 180 return long_string_->length();
134 90128614 return length_;
135 }
136
137 54328 bool IsEmpty() const { return GetLength() == 0; }
138
139 16493373 std::string ToString() const {
140
1/2
✓ Branch 4 taken 16490630 times.
✗ Branch 5 not taken.
 16493373 return std::string(this->GetChars(), this->GetLength());
141 }
142
143 162305 const char *c_str() const {
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 104253 times.
 162305 if (long_string_)
145 ✗ return long_string_->c_str();
146
147 162305 char *c = const_cast<char *>(stack_) + length_;
148 162305 *c = '\0';
149 162305 return stack_;
150 }
151
152 43769 bool operator==(const ShortString &other) const {
153 43769 const unsigned this_length = this->GetLength();
154 43769 const unsigned other_length = other.GetLength();
155
2/2
✓ Branch 0 taken 21247 times.
✓ Branch 1 taken 17733 times.
 43769 if (this_length != other_length)
156 21590 return false;
157
2/2
✓ Branch 0 taken 10940 times.
✓ Branch 1 taken 6793 times.
 22179 if (this_length == 0)
158 14497 return true;
159
160 7682 return memcmp(this->GetChars(), other.GetChars(), this_length) == 0;
161 }
162
163 27594 bool operator!=(const ShortString &other) const { return !(*this == other); }
164
165 35305 bool operator<(const ShortString &other) const {
166 35305 const unsigned this_length = this->GetLength();
167 35305 const unsigned other_length = other.GetLength();
168
169
2/2
✓ Branch 0 taken 7401 times.
✓ Branch 1 taken 27904 times.
 35305 if (this_length < other_length)
170 7401 return true;
171
2/2
✓ Branch 0 taken 6234 times.
✓ Branch 1 taken 21670 times.
 27904 if (this_length > other_length)
172 6234 return false;
173
174 21670 const char *this_chars = this->GetChars();
175 21670 const char *other_chars = other.GetChars();
176
2/2
✓ Branch 0 taken 210862 times.
✓ Branch 1 taken 18642 times.
 229504 for (unsigned i = 0; i < this_length; ++i) {
177
2/2
✓ Branch 0 taken 2285 times.
✓ Branch 1 taken 208577 times.
 210862 if (this_chars[i] < other_chars[i])
178 2285 return true;
179
2/2
✓ Branch 0 taken 743 times.
✓ Branch 1 taken 207834 times.
 208577 if (this_chars[i] > other_chars[i])
180 743 return false;
181 }
182 18642 return false;
183 }
184
185 39917 bool StartsWith(const ShortString &other) const {
186 39917 const unsigned this_length = this->GetLength();
187 39917 const unsigned other_length = other.GetLength();
188
2/2
✓ Branch 0 taken 2701 times.
✓ Branch 1 taken 37216 times.
 39917 if (this_length < other_length)
189 2701 return false;
190
191 37216 return memcmp(this->GetChars(), other.GetChars(), other_length) == 0;
192 }
193
194 17754 ShortString Suffix(const unsigned start_at) const {
195 17754 const unsigned length = this->GetLength();
196
2/2
✓ Branch 0 taken 196 times.
✓ Branch 1 taken 17558 times.
 17754 if (start_at >= length)
197 196 return ShortString("", 0);
198
199 17558 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 240 operator bool() const { return not IsEmpty(); }
206
207 private:
208 std::string *long_string_;
209 char stack_[StackSize + 1]; // +1 to add a final '\0' if necessary
210 unsigned char length_;
211 static atomic_int64 num_overflows_;
212 static atomic_int64 num_instances_;
213 }; // class ShortString
214
215 typedef ShortString<kDefaultMaxPath, 0> PathString;
216 typedef ShortString<kDefaultMaxName, 1> NameString;
217 typedef ShortString<kDefaultMaxLink, 2> LinkString;
218
219 template<unsigned char StackSize, char Type>
220 atomic_int64 ShortString<StackSize, Type>::num_overflows_ = 0;
221 template<unsigned char StackSize, char Type>
222 atomic_int64 ShortString<StackSize, Type>::num_instances_ = 0;
223
224 // See posix.cc for the std::string counterparts
225 PathString GetParentPath(const PathString &path);
226 NameString GetFileName(const PathString &path);
227
228 bool IsSubPath(const PathString &parent, const PathString &path);
229
230
231 #ifdef CVMFS_NAMESPACE_GUARD
232 } // namespace CVMFS_NAMESPACE_GUARD
233 #endif
234
235 #endif // CVMFS_SHORTSTRING_H_
236
237