GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/catalog_diff_tool_impl.h
Date: 2024-04-28 02:33:07
Exec Total Coverage
Lines: 109 126 86.5%
Branches: 111 218 50.9%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #ifndef CVMFS_CATALOG_DIFF_TOOL_IMPL_H_
6 #define CVMFS_CATALOG_DIFF_TOOL_IMPL_H_
7
8 #include <algorithm>
9 #include <string>
10
11 #include "catalog.h"
12 #include "crypto/hash.h"
13 #include "network/download.h"
14 #include "util/exception.h"
15 #include "util/logging.h"
16 #include "util/posix.h"
17
18 const uint64_t kLastInode = uint64_t(-1);
19
20 16 inline void AppendFirstEntry(catalog::DirectoryEntryList* entry_list) {
21
1/2
✓ Branch 1 taken 16 times.
✗ Branch 2 not taken.
 16 catalog::DirectoryEntry empty_entry;
22
1/2
✓ Branch 1 taken 16 times.
✗ Branch 2 not taken.
 16 entry_list->push_back(empty_entry);
23 16 }
24
25 16 inline void AppendLastEntry(catalog::DirectoryEntryList* entry_list) {
26
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 16 times.
 16 assert(!entry_list->empty());
27
1/2
✓ Branch 1 taken 16 times.
✗ Branch 2 not taken.
 16 catalog::DirectoryEntry last_entry;
28 16 last_entry.set_inode(kLastInode);
29
1/2
✓ Branch 1 taken 16 times.
✗ Branch 2 not taken.
 16 entry_list->push_back(last_entry);
30 16 }
31
32 86 inline bool IsSmaller(const catalog::DirectoryEntry& a,
33 const catalog::DirectoryEntry& b) {
34 86 bool a_is_first = (a.inode() == catalog::DirectoryEntryBase::kInvalidInode);
35 86 bool a_is_last = (a.inode() == kLastInode);
36 86 bool b_is_first = (b.inode() == catalog::DirectoryEntryBase::kInvalidInode);
37 86 bool b_is_last = (b.inode() == kLastInode);
38
39
4/4
✓ Branch 0 taken 68 times.
✓ Branch 1 taken 18 times.
✓ Branch 2 taken 44 times.
✓ Branch 3 taken 24 times.
 86 if (a_is_last || b_is_first) return false;
40
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 24 times.
 24 if (a_is_first) return !b_is_first;
41
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 20 times.
 24 if (b_is_last) return !a_is_last;
42
1/2
✓ Branch 2 taken 20 times.
✗ Branch 3 not taken.
 20 return a.name() < b.name();
43 }
44
45 template <typename RoCatalogMgr>
46 2 bool CatalogDiffTool<RoCatalogMgr>::Init() {
47
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
 2 if (needs_setup_) {
48 // Create a temp directory
49 2 old_raii_temp_dir_ = RaiiTempDir::Create(temp_dir_prefix_);
50 2 new_raii_temp_dir_ = RaiiTempDir::Create(temp_dir_prefix_);
51
52 // Old catalog from release manager machine (before lease)
53
1/2
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
 4 old_catalog_mgr_ =
54
1/2
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 2 OpenCatalogManager(repo_path_, old_raii_temp_dir_->dir(),
55 2 old_root_hash_, download_manager_, &stats_old_);
56
57 // New catalog from release manager machine (before lease)
58
1/2
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
 4 new_catalog_mgr_ =
59
1/2
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 2 OpenCatalogManager(repo_path_, new_raii_temp_dir_->dir(),
60 2 new_root_hash_, download_manager_, &stats_new_);
61
62
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
 2 if (!old_catalog_mgr_.IsValid()) {
63 ✗ LogCvmfs(kLogCvmfs, kLogStderr, "Could not open old catalog");
64 ✗ return false;
65 }
66
67
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
 2 if (!new_catalog_mgr_.IsValid()) {
68 ✗ LogCvmfs(kLogCvmfs, kLogStderr, "Could not open new catalog");
69 ✗ return false;
70 }
71 }
72
73 2 return true;
74 }
75
76 template <typename RoCatalogMgr>
77 2 bool CatalogDiffTool<RoCatalogMgr>::Run(const PathString& path) {
78 2 DiffRec(path);
79
80 2 return true;
81 }
82
83 template <typename RoCatalogMgr>
84 4 RoCatalogMgr* CatalogDiffTool<RoCatalogMgr>::OpenCatalogManager(
85 const std::string& repo_path, const std::string& temp_dir,
86 const shash::Any& root_hash, download::DownloadManager* download_manager,
87 perf::Statistics* stats) {
88
1/2
✓ Branch 2 taken 4 times.
✗ Branch 3 not taken.
 4 RoCatalogMgr* mgr = new RoCatalogMgr(root_hash, repo_path, temp_dir,
89 download_manager, stats, true);
90 4 mgr->Init();
91
92 4 return mgr;
93 }
94
95 template <typename RoCatalogMgr>
96 8 void CatalogDiffTool<RoCatalogMgr>::DiffRec(const PathString& path) {
97 // Terminate recursion upon reaching an ignored path
98
2/4
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 8 times.
 8 if (IsIgnoredPath(path)) {
99 ✗ assert(!IsReportablePath(path));
100 ✗ return;
101 }
102
103 8 catalog::DirectoryEntryList old_listing;
104
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 AppendFirstEntry(&old_listing);
105
1/2
✓ Branch 2 taken 8 times.
✗ Branch 3 not taken.
 8 old_catalog_mgr_->Listing(path, &old_listing);
106
1/2
✓ Branch 3 taken 8 times.
✗ Branch 4 not taken.
 8 sort(old_listing.begin(), old_listing.end(), IsSmaller);
107
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 AppendLastEntry(&old_listing);
108
109 // create these paths here so it can be "reused" in the loop without
110 // re-initializing every time, this should save time in doing memcpy
111 // especially when the path gets longer
112
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 PathString old_path(path);
113
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 old_path.Append("/", 1);
114
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 PathString new_path(path);
115
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 new_path.Append("/", 1);
116 8 unsigned length_after_truncate = old_path.GetLength();
117
118 8 catalog::DirectoryEntryList new_listing;
119
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 AppendFirstEntry(&new_listing);
120
1/2
✓ Branch 2 taken 8 times.
✗ Branch 3 not taken.
 8 new_catalog_mgr_->Listing(path, &new_listing);
121
1/2
✓ Branch 3 taken 8 times.
✗ Branch 4 not taken.
 8 sort(new_listing.begin(), new_listing.end(), IsSmaller);
122
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 AppendLastEntry(&new_listing);
123
124 8 unsigned i_from = 0, size_from = old_listing.size();
125 8 unsigned i_to = 0, size_to = new_listing.size();
126
9/10
✓ Branch 1 taken 3 times.
✓ Branch 2 taken 24 times.
✓ Branch 4 taken 3 times.
✓ Branch 5 taken 24 times.
✓ Branch 7 taken 3 times.
✓ Branch 8 taken 24 times.
✓ Branch 9 taken 27 times.
✓ Branch 10 taken 8 times.
✗ Branch 11 not taken.
✓ Branch 12 taken 8 times.
 110 while ((i_from < size_from) || (i_to < size_to)) {
127
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 catalog::DirectoryEntry old_entry = old_listing[i_from];
128
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 catalog::DirectoryEntry new_entry = new_listing[i_to];
129
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 27 times.
 27 if (old_entry.linkcount() == 0) {
131 ✗ PANIC(kLogStderr,
132 "CatalogDiffTool - Entry %s in old catalog has linkcount 0. "
133 "Aborting.",
134 old_entry.name().c_str());
135 }
136
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 27 times.
 27 if (new_entry.linkcount() == 0) {
137 ✗ PANIC(kLogStderr,
138 "CatalogDiffTool - Entry %s in new catalog has linkcount 0. "
139 "Aborting.",
140 new_entry.name().c_str());
141 }
142
143 // Skip .cvmfs hidden directory
144
1/4
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 5 not taken.
✓ Branch 6 taken 27 times.
 27 while (old_entry.IsHidden()) old_entry = old_listing[++i_from];
145
1/4
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✗ Branch 5 not taken.
✓ Branch 6 taken 27 times.
 27 while (new_entry.IsHidden()) new_entry = new_listing[++i_to];
146
147
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 old_path.Truncate(length_after_truncate);
148
3/6
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 27 times.
✗ Branch 6 not taken.
✓ Branch 9 taken 27 times.
✗ Branch 10 not taken.
 27 old_path.Append(old_entry.name().GetChars(), old_entry.name().GetLength());
149
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 new_path.Truncate(length_after_truncate);
150
3/6
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 27 times.
✗ Branch 6 not taken.
✓ Branch 9 taken 27 times.
✗ Branch 10 not taken.
 27 new_path.Append(new_entry.name().GetChars(), new_entry.name().GetLength());
151
152 27 XattrList xattrs;
153
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 27 times.
 27 if (new_entry.HasXattrs()) {
154 ✗ new_catalog_mgr_->LookupXattrs(new_path, &xattrs);
155 }
156
157
3/4
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 25 times.
 27 if (IsSmaller(new_entry, old_entry)) {
158 2 i_to++;
159
2/4
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✗ Branch 4 not taken.
 2 if (IsReportablePath(new_path)) {
160
1/2
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 2 FileChunkList chunks;
161
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
 2 if (new_entry.IsChunkedFile()) {
162 ✗ new_catalog_mgr_->ListFileChunks(new_path, new_entry.hash_algorithm(),
163 &chunks);
164 }
165
1/2
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 2 ReportAddition(new_path, new_entry, xattrs, chunks);
166 2 }
167
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 1 times.
 2 if (new_entry.IsDirectory()) {
168
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 DiffRec(new_path);
169 }
170 2 continue;
171
3/4
✓ Branch 1 taken 25 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3 times.
✓ Branch 4 taken 22 times.
 27 } else if (IsSmaller(old_entry, new_entry)) {
172 3 i_from++;
173
5/6
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 2 times.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 1 times.
✓ Branch 7 taken 2 times.
 3 if (old_entry.IsDirectory() && !old_entry.IsNestedCatalogMountpoint()) {
174
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 DiffRec(old_path);
175 }
176
2/4
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3 times.
✗ Branch 4 not taken.
 3 if (IsReportablePath(old_path)) {
177
1/2
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 3 ReportRemoval(old_path, old_entry);
178 }
179 3 continue;
180 }
181
182
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 22 times.
 22 assert(old_path == new_path);
183 22 i_from++;
184 22 i_to++;
185
186 catalog::DirectoryEntryBase::Differences diff =
187
1/2
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
 22 old_entry.CompareTo(new_entry);
188
4/6
✓ Branch 0 taken 19 times.
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 19 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 22 times.
 41 if ((diff == catalog::DirectoryEntryBase::Difference::kIdentical) &&
189 19 old_entry.IsNestedCatalogMountpoint()) {
190 // Early recursion stop if nested catalogs are identical
191 ✗ shash::Any id_nested_from, id_nested_to;
192 ✗ id_nested_from = old_catalog_mgr_->GetNestedCatalogHash(old_path);
193 ✗ id_nested_to = new_catalog_mgr_->GetNestedCatalogHash(new_path);
194 ✗ assert(!id_nested_from.IsNull() && !id_nested_to.IsNull());
195 ✗ if (id_nested_from == id_nested_to) continue;
196 }
197
198
6/8
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 22 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 19 times.
✓ Branch 6 taken 3 times.
✓ Branch 7 taken 3 times.
✓ Branch 8 taken 19 times.
 41 if (IsReportablePath(old_path) &&
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 19 times.
 19 ((diff != catalog::DirectoryEntryBase::Difference::kIdentical) ||
200 19 old_entry.IsNestedCatalogMountpoint())) {
201 // Modified directory entry, or nested catalog with modified hash
202
1/2
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 3 FileChunkList chunks;
203
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3 times.
 3 if (new_entry.IsChunkedFile()) {
204 ✗ new_catalog_mgr_->ListFileChunks(new_path, new_entry.hash_algorithm(),
205 &chunks);
206 }
207 bool recurse =
208
1/2
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 3 ReportModification(old_path, old_entry, new_entry, xattrs, chunks);
209
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if (!recurse) continue;
210
1/2
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 3 }
211
212
6/6
✓ Branch 1 taken 4 times.
✓ Branch 2 taken 18 times.
✓ Branch 4 taken 1 times.
✓ Branch 5 taken 3 times.
✓ Branch 6 taken 19 times.
✓ Branch 7 taken 3 times.
 22 if (!old_entry.IsDirectory() || !new_entry.IsDirectory()) {
213
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 18 times.
 19 if (old_entry.IsDirectory()) {
214
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 DiffRec(old_path);
215
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 18 times.
 18 } else if (new_entry.IsDirectory()) {
216 ✗ DiffRec(new_path);
217 }
218 19 continue;
219 }
220
221 // Recursion
222
1/2
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 3 DiffRec(old_path);
223 }
224 8 }
225
226 #endif // CVMFS_CATALOG_DIFF_TOOL_IMPL_H_
227