GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/shortstring.h
Date: 2025-10-19 02:35:28
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 237517096 ShortString() : long_string_(NULL), length_(0) {
30 #ifdef DEBUGMSG
31 237517096 atomic_inc64(&num_instances_);
32 #endif
33 237517096 }
34 76758459 ShortString(const ShortString &other) : long_string_(NULL) {
35 #ifdef DEBUGMSG
36 153516918 atomic_inc64(&num_instances_);
37 #endif
38 154064358 Assign(other);
39 153581798 }
40 195109 ShortString(const char *chars, const unsigned length) : long_string_(NULL) {
41 #ifdef DEBUGMSG
42 195109 atomic_inc64(&num_instances_);
43 #endif
44 196504 Assign(chars, length);
45 195016 }
46 80462266 explicit ShortString(const std::string &std_string) : long_string_(NULL) {
47 #ifdef DEBUGMSG
48 80462266 atomic_inc64(&num_instances_);
49 #endif
50 81446888 Assign(std_string.data(), std_string.length());
51 80440318 }
52
53 51705354 ShortString &operator=(const ShortString &other) {
54
1/2
✓ Branch 0 taken 25858226 times.
✗ Branch 1 not taken.
 51705354 if (this != &other)
55 51716452 Assign(other);
56 51040156 return *this;
57 }
58
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 221457267 times.
 442914534 ~ShortString() { delete long_string_; }
60
61 285630192 void Assign(const char *chars, const unsigned length) {
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 142815096 times.
 285630192 delete long_string_;
63 285108206 long_string_ = NULL;
64 285108206 this->length_ = length;
65
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 142554103 times.
 285108206 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 142071728 times.
✓ Branch 1 taken 482375 times.
 285108206 if (length)
72 284143456 memcpy(stack_, chars, length);
73 }
74 285108206 }
75
76 205412498 void Assign(const ShortString &other) {
77 205412498 Assign(other.GetChars(), other.GetLength());
78 204670472 }
79
80 152838 void Append(const char *chars, const unsigned length) {
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 152838 times.
 152838 if (long_string_) {
82 ✗ long_string_->append(chars, length);
83 ✗ return;
84 }
85
86 152838 const unsigned new_length = this->length_ + length;
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 152838 times.
 152838 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 151570 times.
✓ Branch 1 taken 1268 times.
 152838 if (length > 0)
98 151570 memcpy(&stack_[this->length_], chars, length);
99 152838 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 1674 void Truncate(unsigned new_length) {
109
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1674 times.
 1674 assert(new_length <= this->GetLength());
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1674 times.
 1674 if (long_string_) {
111 ✗ long_string_->erase(new_length);
112 ✗ return;
113 }
114 1674 this->length_ = new_length;
115 }
116
117 void Clear() {
118 delete long_string_;
119 long_string_ = NULL;
120 length_ = 0;
121 }
122
123 287713238 const char *GetChars() const {
124
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 143856619 times.
 287713238 if (long_string_) {
125 ✗ return long_string_->data();
126 } else {
127 287713238 return stack_;
128 }
129 }
130
131 288606792 unsigned GetLength() const {
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 144303396 times.
 288606792 if (long_string_)
133 ✗ return long_string_->length();
134 288606792 return length_;
135 }
136
137 49440 bool IsEmpty() const { return GetLength() == 0; }
138
139 41092895 std::string ToString() const {
140
1/2
✓ Branch 4 taken 41086002 times.
✗ Branch 5 not taken.
 41092895 return std::string(this->GetChars(), this->GetLength());
141 }
142
143 142348 const char *c_str() const {
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 89969 times.
 142348 if (long_string_)
145 ✗ return long_string_->c_str();
146
147 142348 char *c = const_cast<char *>(stack_) + length_;
148 142348 *c = '\0';
149 142348 return stack_;
150 }
151
152 33007 bool operator==(const ShortString &other) const {
153 33007 const unsigned this_length = this->GetLength();
154 33007 const unsigned other_length = other.GetLength();
155
2/2
✓ Branch 0 taken 20398 times.
✓ Branch 1 taken 10677 times.
 33007 if (this_length != other_length)
156 20657 return false;
157
2/2
✓ Branch 0 taken 5929 times.
✓ Branch 1 taken 4748 times.
 12350 if (this_length == 0)
158 7088 return true;
159
160 5262 return memcmp(this->GetChars(), other.GetChars(), this_length) == 0;
161 }
162
163 21295 bool operator!=(const ShortString &other) const { return !(*this == other); }
164
165 36532 bool operator<(const ShortString &other) const {
166 36532 const unsigned this_length = this->GetLength();
167 36532 const unsigned other_length = other.GetLength();
168
169
2/2
✓ Branch 0 taken 9185 times.
✓ Branch 1 taken 27347 times.
 36532 if (this_length < other_length)
170 9185 return true;
171
2/2
✓ Branch 0 taken 5785 times.
✓ Branch 1 taken 21562 times.
 27347 if (this_length > other_length)
172 5785 return false;
173
174 21562 const char *this_chars = this->GetChars();
175 21562 const char *other_chars = other.GetChars();
176
2/2
✓ Branch 0 taken 198928 times.
✓ Branch 1 taken 18938 times.
 217866 for (unsigned i = 0; i < this_length; ++i) {
177
2/2
✓ Branch 0 taken 2050 times.
✓ Branch 1 taken 196878 times.
 198928 if (this_chars[i] < other_chars[i])
178 2050 return true;
179
2/2
✓ Branch 0 taken 574 times.
✓ Branch 1 taken 196304 times.
 196878 if (this_chars[i] > other_chars[i])
180 574 return false;
181 }
182 18938 return false;
183 }
184
185 33573 bool StartsWith(const ShortString &other) const {
186 33573 const unsigned this_length = this->GetLength();
187 33573 const unsigned other_length = other.GetLength();
188
2/2
✓ Branch 0 taken 1717 times.
✓ Branch 1 taken 31856 times.
 33573 if (this_length < other_length)
189 1717 return false;
190
191 31856 return memcmp(this->GetChars(), other.GetChars(), other_length) == 0;
192 }
193
194 14154 ShortString Suffix(const unsigned start_at) const {
195 14154 const unsigned length = this->GetLength();
196
2/2
✓ Branch 0 taken 152 times.
✓ Branch 1 taken 14002 times.
 14154 if (start_at >= length)
197 152 return ShortString("", 0);
198
199 14002 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