1 // Copyright 2012 Google Inc. All Rights Reserved.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
30 // The version is stored as 4 bytes after the signature and also serves as a
31 // byte order mark. Signature and version combined are 16 bytes long.
32 const char kFileSignature[] = "# ninjadeps\n";
33 const int kCurrentVersion = 1;
39 bool DepsLog::OpenForWrite(const string& path, string* err) {
40 file_ = fopen(path.c_str(), "ab");
42 *err = strerror(errno);
45 SetCloseOnExec(fileno(file_));
47 // Opening a file in append mode doesn't set the file pointer to the file's
48 // end on Windows. Do that explicitly.
49 fseek(file_, 0, SEEK_END);
51 if (ftell(file_) == 0) {
52 if (fwrite(kFileSignature, sizeof(kFileSignature) - 1, 1, file_) < 1) {
53 *err = strerror(errno);
56 if (fwrite(&kCurrentVersion, 4, 1, file_) < 1) {
57 *err = strerror(errno);
65 bool DepsLog::RecordDeps(Node* node, TimeStamp mtime,
66 const vector<Node*>& nodes) {
67 return RecordDeps(node, mtime, nodes.size(),
68 nodes.empty() ? NULL : (Node**)&nodes.front());
71 bool DepsLog::RecordDeps(Node* node, TimeStamp mtime,
72 int node_count, Node** nodes) {
73 // Track whether there's any new data to be recorded.
74 bool made_change = false;
76 // Assign ids to all nodes that are missing one.
81 for (int i = 0; i < node_count; ++i) {
82 if (nodes[i]->id() < 0) {
88 // See if the new data is different than the existing data, if any.
90 Deps* deps = GetDeps(node);
92 deps->mtime != mtime ||
93 deps->node_count != node_count) {
96 for (int i = 0; i < node_count; ++i) {
97 if (deps->nodes[i] != nodes[i]) {
105 // Don't write anything if there's no new info.
109 uint16_t size = 4 * (1 + 1 + (uint16_t)node_count);
110 size |= 0x8000; // Deps record: set high bit.
111 fwrite(&size, 2, 1, file_);
113 fwrite(&id, 4, 1, file_);
114 int timestamp = mtime;
115 fwrite(×tamp, 4, 1, file_);
116 for (int i = 0; i < node_count; ++i) {
118 fwrite(&id, 4, 1, file_);
124 void DepsLog::Close() {
130 bool DepsLog::Load(const string& path, State* state, string* err) {
131 METRIC_RECORD(".ninja_deps load");
133 FILE* f = fopen(path.c_str(), "rb");
137 *err = strerror(errno);
141 bool valid_header = true;
143 if (!fgets(buf, sizeof(buf), f) || fread(&version, 4, 1, f) < 1)
144 valid_header = false;
145 if (!valid_header || strcmp(buf, kFileSignature) != 0 ||
146 version != kCurrentVersion) {
147 *err = "bad deps log signature or version; starting over";
149 unlink(path.c_str());
150 // Don't report this as a failure. An empty deps log will cause
151 // us to rebuild the outputs anyway.
156 bool read_failed = false;
161 if (fread(&size, 2, 1, f) < 1) {
166 bool is_deps = (size >> 15) != 0;
167 size = size & 0x7FFF;
169 if (fread(buf, size, 1, f) < 1) {
175 assert(size % 4 == 0);
176 int* deps_data = reinterpret_cast<int*>(buf);
177 int out_id = deps_data[0];
178 int mtime = deps_data[1];
180 int deps_count = (size / 4) - 2;
182 Deps* deps = new Deps(mtime, deps_count);
183 for (int i = 0; i < deps_count; ++i) {
184 assert(deps_data[i] < (int)nodes_.size());
185 assert(nodes_[deps_data[i]]);
186 deps->nodes[i] = nodes_[deps_data[i]];
189 if (out_id >= (int)deps_.size())
190 deps_.resize(out_id + 1);
192 ++dead_record_count_;
193 delete deps_[out_id];
195 deps_[out_id] = deps;
197 StringPiece path(buf, size);
198 Node* node = state->GetNode(path);
199 assert(node->id() < 0);
200 node->set_id(nodes_.size());
201 nodes_.push_back(node);
206 // An error occurred while loading; try to recover by truncating the
207 // file to the last fully-read record.
209 *err = strerror(ferror(f));
211 *err = "premature end of file";
215 if (!Truncate(path.c_str(), offset, err))
218 // The truncate succeeded; we'll just report the load error as a
219 // warning because the build can proceed.
220 *err += "; recovering";
229 DepsLog::Deps* DepsLog::GetDeps(Node* node) {
230 // Abort if the node has no id (never referenced in the deps) or if
231 // there's no deps recorded for the node.
232 if (node->id() < 0 || node->id() >= (int)deps_.size())
234 return deps_[node->id()];
237 bool DepsLog::Recompact(const string& path, string* err) {
238 METRIC_RECORD(".ninja_deps recompact");
239 printf("Recompacting deps...\n");
241 string temp_path = path + ".recompact";
243 // OpenForWrite() opens for append. Make sure it's not appending to a
244 // left-over file from a previous recompaction attempt that crashed somehow.
245 unlink(temp_path.c_str());
248 if (!new_log.OpenForWrite(temp_path, err))
251 // Clear all known ids so that new ones can be reassigned.
252 for (vector<Node*>::iterator i = nodes_.begin();
253 i != nodes_.end(); ++i) {
257 // Write out all deps again.
258 for (int old_id = 0; old_id < (int)deps_.size(); ++old_id) {
259 Deps* deps = deps_[old_id];
260 if (!deps) continue; // If nodes_[old_id] is a leaf, it has no deps.
262 if (!new_log.RecordDeps(nodes_[old_id], deps->mtime,
263 deps->node_count, deps->nodes)) {
271 if (unlink(path.c_str()) < 0) {
272 *err = strerror(errno);
276 if (rename(temp_path.c_str(), path.c_str()) < 0) {
277 *err = strerror(errno);
284 bool DepsLog::RecordId(Node* node) {
285 uint16_t size = (uint16_t)node->path().size();
286 fwrite(&size, 2, 1, file_);
287 fwrite(node->path().data(), node->path().size(), 1, file_);
289 node->set_id(nodes_.size());
290 nodes_.push_back(node);