GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/shortstring.h
Date: 2025-06-22 02:36:02
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 284399628 ShortString() : long_string_(NULL), length_(0) {
30 #ifdef DEBUGMSG
31 284399628 atomic_inc64(&num_instances_);
32 #endif
33 284399628 }
34 93714629 ShortString(const ShortString &other) : long_string_(NULL) {
35 #ifdef DEBUGMSG
36 187429258 atomic_inc64(&num_instances_);
37 #endif
38 187898972 Assign(other);
39 187504914 }
40 91516 ShortString(const char *chars, const unsigned length) : long_string_(NULL) {
41 #ifdef DEBUGMSG
42 91516 atomic_inc64(&num_instances_);
43 #endif
44 91880 Assign(chars, length);
45 91642 }
46 81857134 explicit ShortString(const std::string &std_string) : long_string_(NULL) {
47 #ifdef DEBUGMSG
48 81857134 atomic_inc64(&num_instances_);
49 #endif
50 82293934 Assign(std_string.data(), std_string.length());
51 81997218 }
52
53 46242516 ShortString &operator=(const ShortString &other) {
54
1/2
✓ Branch 0 taken 23128552 times.
✗ Branch 1 not taken.
 46242516 if (this != &other)
55 46257104 Assign(other);
56 45977328 return *this;
57 }
58
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 259189177 times.
 518378354 ~ShortString() { delete long_string_; }
60
61 315663834 void Assign(const char *chars, const unsigned length) {
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 157831917 times.
 315663834 delete long_string_;
63 315503128 long_string_ = NULL;
64 315503128 this->length_ = length;
65
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 157751564 times.
 315503128 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 157432005 times.
✓ Branch 1 taken 319559 times.
 315503128 if (length)
72 314864010 memcpy(stack_, chars, length);
73 }
74 315503128 }
75
76 233907712 void Assign(const ShortString &other) {
77 233907712 Assign(other.GetChars(), other.GetLength());
78 233497442 }
79
80 165456 void Append(const char *chars, const unsigned length) {
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 165456 times.
 165456 if (long_string_) {
82 ✗ long_string_->append(chars, length);
83 ✗ return;
84 }
85
86 165456 const unsigned new_length = this->length_ + length;
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 165456 times.
 165456 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 163664 times.
✓ Branch 1 taken 1792 times.
 165456 if (length > 0)
98 163664 memcpy(&stack_[this->length_], chars, length);
99 165456 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 2646 void Truncate(unsigned new_length) {
109
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2646 times.
 2646 assert(new_length <= this->GetLength());
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2646 times.
 2646 if (long_string_) {
111 ✗ long_string_->erase(new_length);
112 ✗ return;
113 }
114 2646 this->length_ = new_length;
115 }
116
117 void Clear() {
118 delete long_string_;
119 long_string_ = NULL;
120 length_ = 0;
121 }
122
123 316770530 const char *GetChars() const {
124
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158385265 times.
 316770530 if (long_string_) {
125 ✗ return long_string_->data();
126 } else {
127 316770530 return stack_;
128 }
129 }
130
131 317449182 unsigned GetLength() const {
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158724591 times.
 317449182 if (long_string_)
133 ✗ return long_string_->length();
134 317449182 return length_;
135 }
136
137 23612 bool IsEmpty() const { return GetLength() == 0; }
138
139 41346562 std::string ToString() const {
140
1/2
✓ Branch 4 taken 41337374 times.
✗ Branch 5 not taken.
 41346562 return std::string(this->GetChars(), this->GetLength());
141 }
142
143 74265 const char *c_str() const {
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 54494 times.
 74265 if (long_string_)
145 ✗ return long_string_->c_str();
146
147 74265 char *c = const_cast<char *>(stack_) + length_;
148 74265 *c = '\0';
149 74265 return stack_;
150 }
151
152 32026 bool operator==(const ShortString &other) const {
153 32026 const unsigned this_length = this->GetLength();
154 32026 const unsigned other_length = other.GetLength();
155
2/2
✓ Branch 0 taken 18976 times.
✓ Branch 1 taken 10690 times.
 32026 if (this_length != other_length)
156 19067 return false;
157
2/2
✓ Branch 0 taken 6794 times.
✓ Branch 1 taken 3896 times.
 12959 if (this_length == 0)
158 8643 return true;
159
160 4316 return memcmp(this->GetChars(), other.GetChars(), this_length) == 0;
161 }
162
163 22341 bool operator!=(const ShortString &other) const { return !(*this == other); }
164
165 30629 bool operator<(const ShortString &other) const {
166 30629 const unsigned this_length = this->GetLength();
167 30629 const unsigned other_length = other.GetLength();
168
169
2/2
✓ Branch 0 taken 6052 times.
✓ Branch 1 taken 24577 times.
 30629 if (this_length < other_length)
170 6052 return true;
171
2/2
✓ Branch 0 taken 4299 times.
✓ Branch 1 taken 20278 times.
 24577 if (this_length > other_length)
172 4299 return false;
173
174 20278 const char *this_chars = this->GetChars();
175 20278 const char *other_chars = other.GetChars();
176
2/2
✓ Branch 0 taken 159460 times.
✓ Branch 1 taken 17964 times.
 177424 for (unsigned i = 0; i < this_length; ++i) {
177
2/2
✓ Branch 0 taken 1788 times.
✓ Branch 1 taken 157672 times.
 159460 if (this_chars[i] < other_chars[i])
178 1788 return true;
179
2/2
✓ Branch 0 taken 526 times.
✓ Branch 1 taken 157146 times.
 157672 if (this_chars[i] > other_chars[i])
180 526 return false;
181 }
182 17964 return false;
183 }
184
185 34146 bool StartsWith(const ShortString &other) const {
186 34146 const unsigned this_length = this->GetLength();
187 34146 const unsigned other_length = other.GetLength();
188
2/2
✓ Branch 0 taken 1065 times.
✓ Branch 1 taken 33081 times.
 34146 if (this_length < other_length)
189 1065 return false;
190
191 33081 return memcmp(this->GetChars(), other.GetChars(), other_length) == 0;
192 }
193
194 15524 ShortString Suffix(const unsigned start_at) const {
195 15524 const unsigned length = this->GetLength();
196
2/2
✓ Branch 0 taken 28 times.
✓ Branch 1 taken 15496 times.
 15524 if (start_at >= length)
197 28 return ShortString("", 0);
198
199 15496 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