src/deps_log.cc

   1 // Copyright 2012 Google Inc. All Rights Reserved.
   2 //
   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
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   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.
  14
  15 #include "deps_log.h"
  16
  17 #include <assert.h>
  18 #include <stdio.h>
  19 #include <errno.h>
  20 #include <string.h>
  21 #ifndef _WIN32
  22 #include <unistd.h>
  23 #endif
  24
  25 #include "graph.h"
  26 #include "metrics.h"
  27 #include "state.h"
  28 #include "util.h"
  29
  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;
  34
  35 DepsLog::~DepsLog() {
  36   Close();
  37 }
  38
  39 bool DepsLog::OpenForWrite(const string& path, string* err) {
  40   file_ = fopen(path.c_str(), "ab");
  41   if (!file_) {
  42     *err = strerror(errno);
  43     return false;
  44   }
  45   SetCloseOnExec(fileno(file_));
  46
  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);
  50
  51   if (ftell(file_) == 0) {
  52     if (fwrite(kFileSignature, sizeof(kFileSignature) - 1, 1, file_) < 1) {
  53       *err = strerror(errno);
  54       return false;
  55     }
  56     if (fwrite(&kCurrentVersion, 4, 1, file_) < 1) {
  57       *err = strerror(errno);
  58       return false;
  59     }
  60   }
  61
  62   return true;
  63 }
  64
  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());
  69 }
  70
  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;
  75
  76   // Assign ids to all nodes that are missing one.
  77   if (node->id() < 0) {
  78     RecordId(node);
  79     made_change = true;
  80   }
  81   for (int i = 0; i < node_count; ++i) {
  82     if (nodes[i]->id() < 0) {
  83       RecordId(nodes[i]);
  84       made_change = true;
  85     }
  86   }
  87
  88   // See if the new data is different than the existing data, if any.
  89   if (!made_change) {
  90     Deps* deps = GetDeps(node);
  91     if (!deps ||
  92         deps->mtime != mtime ||
  93         deps->node_count != node_count) {
  94       made_change = true;
  95     } else {
  96       for (int i = 0; i < node_count; ++i) {
  97         if (deps->nodes[i] != nodes[i]) {
  98           made_change = true;
  99           break;
 100         }
 101       }
 102     }
 103   }
 104
 105   // Don't write anything if there's no new info.
 106   if (!made_change)
 107     return true;
 108
 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_);
 112   int id = node->id();
 113   fwrite(&id, 4, 1, file_);
 114   int timestamp = mtime;
 115   fwrite(&timestamp, 4, 1, file_);
 116   for (int i = 0; i < node_count; ++i) {
 117     id = nodes[i]->id();
 118     fwrite(&id, 4, 1, file_);
 119   }
 120
 121   return true;
 122 }
 123
 124 void DepsLog::Close() {
 125   if (file_)
 126     fclose(file_);
 127   file_ = NULL;
 128 }
 129
 130 bool DepsLog::Load(const string& path, State* state, string* err) {
 131   METRIC_RECORD(".ninja_deps load");
 132   char buf[32 << 10];
 133   FILE* f = fopen(path.c_str(), "rb");
 134   if (!f) {
 135     if (errno == ENOENT)
 136       return true;
 137     *err = strerror(errno);
 138     return false;
 139   }
 140
 141   bool valid_header = true;
 142   int version = 0;
 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";
 148     fclose(f);
 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.
 152     return true;
 153   }
 154
 155   long offset;
 156   bool read_failed = false;
 157   for (;;) {
 158     offset = ftell(f);
 159
 160     uint16_t size;
 161     if (fread(&size, 2, 1, f) < 1) {
 162       read_failed = true;
 163       break;
 164     }
 165     bool is_deps = (size >> 15) != 0;
 166     size = size & 0x7FFF;
 167
 168     if (fread(buf, size, 1, f) < 1) {
 169       read_failed = true;
 170       break;
 171     }
 172
 173     if (is_deps) {
 174       assert(size % 4 == 0);
 175       int* deps_data = reinterpret_cast<int*>(buf);
 176       int out_id = deps_data[0];
 177       int mtime = deps_data[1];
 178       deps_data += 2;
 179       int deps_count = (size / 4) - 2;
 180
 181       Deps* deps = new Deps;
 182       deps->mtime = mtime;
 183       deps->node_count = deps_count;
 184       deps->nodes = new Node*[deps_count];
 185       for (int i = 0; i < deps_count; ++i) {
 186         assert(deps_data[i] < (int)nodes_.size());
 187         assert(nodes_[deps_data[i]]);
 188         deps->nodes[i] = nodes_[deps_data[i]];
 189       }
 190
 191       if (out_id >= (int)deps_.size())
 192         deps_.resize(out_id + 1);
 193       if (deps_[out_id]) {
 194         ++dead_record_count_;
 195         delete deps_[out_id];
 196       }
 197       deps_[out_id] = deps;
 198     } else {
 199       StringPiece path(buf, size);
 200       Node* node = state->GetNode(path);
 201       assert(node->id() < 0);
 202       node->set_id(nodes_.size());
 203       nodes_.push_back(node);
 204     }
 205   }
 206
 207   if (read_failed) {
 208     // An error occurred while loading; try to recover by truncating the
 209     // file to the last fully-read record.
 210     if (ferror(f)) {
 211       *err = strerror(ferror(f));
 212     } else {
 213       *err = "premature end of file";
 214     }
 215     fclose(f);
 216
 217     if (truncate(path.c_str(), offset) < 0) {
 218       *err = strerror(errno);
 219       return false;
 220     }
 221
 222     // The truncate succeeded; we'll just report the load error as a
 223     // warning because the build can proceed.
 224     *err += "; recovering";
 225     return true;
 226   }
 227
 228   fclose(f);
 229
 230   return true;
 231 }
 232
 233 DepsLog::Deps* DepsLog::GetDeps(Node* node) {
 234   // Abort if the node has no id (never referenced in the deps) or if
 235   // there's no deps recorded for the node.
 236   if (node->id() < 0 || node->id() >= deps_.size())
 237     return NULL;
 238   return deps_[node->id()];
 239 }
 240
 241 bool DepsLog::Recompact(const string& path, string* err) {
 242   METRIC_RECORD(".ninja_deps recompact");
 243   printf("Recompacting deps...\n");
 244
 245   string temp_path = path + ".recompact";
 246   DepsLog new_log;
 247   if (!new_log.OpenForWrite(temp_path, err))
 248     return false;
 249
 250   // Clear all known ids so that new ones can be reassigned.
 251   for (vector<Node*>::iterator i = nodes_.begin();
 252        i != nodes_.end(); ++i) {
 253     (*i)->set_id(-1);
 254   }
 255
 256   // Write out all deps again.
 257   for (int old_id = 0; old_id < (int)deps_.size(); ++old_id) {
 258     Deps* deps = deps_[old_id];
 259     if (!new_log.RecordDeps(nodes_[old_id], deps->mtime,
 260                             deps->node_count, deps->nodes)) {
 261       new_log.Close();
 262       return false;
 263     }
 264   }
 265
 266   new_log.Close();
 267
 268   if (unlink(path.c_str()) < 0) {
 269     *err = strerror(errno);
 270     return false;
 271   }
 272
 273   if (rename(temp_path.c_str(), path.c_str()) < 0) {
 274     *err = strerror(errno);
 275     return false;
 276   }
 277
 278   return true;
 279 }
 280
 281 bool DepsLog::RecordId(Node* node) {
 282   uint16_t size = (uint16_t)node->path().size();
 283   fwrite(&size, 2, 1, file_);
 284   fwrite(node->path().data(), node->path().size(), 1, file_);
 285
 286   node->set_id(nodes_.size());
 287   nodes_.push_back(node);
 288
 289   return true;
 290 }