store.cc

   1 /* LBS: An LFS-inspired filesystem backup system
   2  * Copyright (C) 2008  Michael Vrable
   3  *
   4  * Backup data is stored in a collection of objects, which are grouped together
   5  * into segments for storage purposes.  This implementation of the object store
   6  * represents segments as TAR files and objects as files within them. */
   7
   8 #include <assert.h>
   9 #include <errno.h>
  10 #include <stdio.h>
  11 #include <sys/types.h>
  12 #include <sys/stat.h>
  13 #include <sys/resource.h>
  14 #include <sys/wait.h>
  15 #include <unistd.h>
  16 #include <fcntl.h>
  17 #include <time.h>
  18
  19 #include <algorithm>
  20 #include <list>
  21 #include <map>
  22 #include <set>
  23 #include <string>
  24 #include <iostream>
  25
  26 #include "store.h"
  27 #include "ref.h"
  28
  29 using std::max;
  30 using std::list;
  31 using std::map;
  32 using std::set;
  33 using std::string;
  34
  35 /* Default filter program is bzip2 */
  36 const char *filter_program = "bzip2 -c";
  37 const char *filter_extension = ".bz2";
  38
  39 static void cloexec(int fd)
  40 {
  41     long flags = fcntl(fd, F_GETFD);
  42
  43     if (flags < 0)
  44         return;
  45
  46     fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
  47 }
  48
  49 Tarfile::Tarfile(RemoteFile *file, const string &segment)
  50     : size(0),
  51       segment_name(segment)
  52 {
  53     assert(sizeof(struct tar_header) == TAR_BLOCK_SIZE);
  54
  55     this->file = file;
  56     real_fd = file->get_fd();
  57     filter_fd = spawn_filter(real_fd, filter_program, &filter_pid);
  58 }
  59
  60 Tarfile::~Tarfile()
  61 {
  62     char buf[TAR_BLOCK_SIZE];
  63
  64     /* Append the EOF marker: two blocks filled with nulls. */
  65     memset(buf, 0, sizeof(buf));
  66     tar_write(buf, TAR_BLOCK_SIZE);
  67     tar_write(buf, TAR_BLOCK_SIZE);
  68
  69     if (close(filter_fd) != 0)
  70         throw IOException("Error closing Tarfile");
  71
  72     /* ...and wait for filter process to finish. */
  73     int status;
  74     waitpid(filter_pid, &status, 0);
  75
  76     if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
  77         throw IOException("Filter process error");
  78     }
  79
  80     close(real_fd);
  81 }
  82
  83 /* Launch a child process which can act as a filter (compress, encrypt, etc.)
  84  * on the TAR output.  The file descriptor to which output should be written
  85  * must be specified; the return value is the file descriptor which will be
  86  * attached to the standard input of the filter program. */
  87 int spawn_filter(int fd_out, const char *program, pid_t *filter_pid)
  88 {
  89     int fds[2];
  90     pid_t pid;
  91
  92     /* Create a pipe for communicating with the filter process. */
  93     if (pipe(fds) < 0) {
  94         throw IOException("Unable to create pipe for filter");
  95     }
  96
  97     /* Create a child process which can exec() the filter program. */
  98     pid = fork();
  99     if (pid < 0)
 100         throw IOException("Unable to fork filter process");
 101
 102     if (pid > 0) {
 103         /* Parent process */
 104         close(fds[0]);
 105         cloexec(fds[1]);
 106         if (filter_pid != NULL)
 107             *filter_pid = pid;
 108     } else {
 109         /* Child process.  Rearrange file descriptors.  stdin is fds[0], stdout
 110          * is fd_out, stderr is unchanged. */
 111         close(fds[1]);
 112
 113         if (dup2(fds[0], 0) < 0)
 114             exit(1);
 115         close(fds[0]);
 116
 117         if (dup2(fd_out, 1) < 0)
 118             exit(1);
 119         close(fd_out);
 120
 121         /* Exec the filter program. */
 122         execlp("/bin/sh", "/bin/sh", "-c", program, NULL);
 123
 124         /* Should not reach here except for error cases. */
 125         fprintf(stderr, "Could not exec filter: %m\n");
 126         exit(1);
 127     }
 128
 129     return fds[1];
 130 }
 131
 132 void Tarfile::tar_write(const char *data, size_t len)
 133 {
 134     size += len;
 135
 136     while (len > 0) {
 137         int res = write(filter_fd, data, len);
 138
 139         if (res < 0) {
 140             if (errno == EINTR)
 141                 continue;
 142             fprintf(stderr, "Write error: %m\n");
 143             throw IOException("Write error");
 144         }
 145
 146         len -= res;
 147         data += res;
 148     }
 149 }
 150
 151 void Tarfile::write_object(int id, const char *data, size_t len)
 152 {
 153     struct tar_header header;
 154     memset(&header, 0, sizeof(header));
 155
 156     char buf[64];
 157     sprintf(buf, "%08x", id);
 158     string path = segment_name + "/" + buf;
 159
 160     assert(path.size() < 100);
 161     memcpy(header.name, path.data(), path.size());
 162     sprintf(header.mode, "%07o", 0600);
 163     sprintf(header.uid, "%07o", 0);
 164     sprintf(header.gid, "%07o", 0);
 165     sprintf(header.size, "%011o", len);
 166     sprintf(header.mtime, "%011o", (int)time(NULL));
 167     header.typeflag = '0';
 168     strcpy(header.magic, "ustar  ");
 169     strcpy(header.uname, "root");
 170     strcpy(header.gname, "root");
 171
 172     memset(header.chksum, ' ', sizeof(header.chksum));
 173     int checksum = 0;
 174     for (int i = 0; i < TAR_BLOCK_SIZE; i++) {
 175         checksum += ((uint8_t *)&header)[i];
 176     }
 177     sprintf(header.chksum, "%06o", checksum);
 178
 179     tar_write((const char *)&header, TAR_BLOCK_SIZE);
 180
 181     if (len == 0)
 182         return;
 183
 184     tar_write(data, len);
 185
 186     char padbuf[TAR_BLOCK_SIZE];
 187     size_t blocks = (len + TAR_BLOCK_SIZE - 1) / TAR_BLOCK_SIZE;
 188     size_t padding = blocks * TAR_BLOCK_SIZE - len;
 189     memset(padbuf, 0, padding);
 190     tar_write(padbuf, padding);
 191 }
 192
 193 /* Estimate the size based on the size of the actual output file on disk.
 194  * However, it might be the case that the filter program is buffering all its
 195  * data, and might potentially not write a single byte until we have closed
 196  * our end of the pipe.  If we don't do so until we see data written, we have
 197  * a problem.  So, arbitrarily pick an upper bound on the compression ratio
 198  * that the filter will achieve (128:1), and return a size estimate which is
 199  * the larger of a) bytes actually seen written to disk, and b) input
 200  * bytes/128. */
 201 size_t Tarfile::size_estimate()
 202 {
 203     struct stat statbuf;
 204
 205     if (fstat(real_fd, &statbuf) == 0)
 206         return max((int64_t)statbuf.st_size, (int64_t)(size / 128));
 207
 208     /* Couldn't stat the file on disk, so just return the actual number of
 209      * bytes, before compression. */
 210     return size;
 211 }
 212
 213 static const size_t SEGMENT_SIZE = 4 * 1024 * 1024;
 214
 215 static map<string, int64_t> group_sizes;
 216
 217 ObjectReference TarSegmentStore::write_object(const char *data, size_t len,
 218                                               const std::string &group)
 219 {
 220     struct segment_info *segment;
 221
 222     // Find the segment into which the object should be written, looking up by
 223     // group.  If no segment exists yet, create one.
 224     if (segments.find(group) == segments.end()) {
 225         segment = new segment_info;
 226
 227         segment->name = generate_uuid();
 228         segment->basename = segment->name + ".tar";
 229         segment->basename += filter_extension;
 230         segment->count = 0;
 231         segment->size = 0;
 232         segment->rf = remote->alloc_file(segment->basename, "segments");
 233         segment->file = new Tarfile(segment->rf, segment->name);
 234
 235         segments[group] = segment;
 236     } else {
 237         segment = segments[group];
 238     }
 239
 240     int id = segment->count;
 241     char id_buf[64];
 242     sprintf(id_buf, "%08x", id);
 243
 244     segment->file->write_object(id, data, len);
 245     segment->count++;
 246     segment->size += len;
 247
 248     group_sizes[group] += len;
 249
 250     ObjectReference ref(segment->name, id_buf);
 251
 252     // If this segment meets or exceeds the size target, close it so that
 253     // future objects will go into a new segment.
 254     if (segment->file->size_estimate() >= SEGMENT_SIZE)
 255         close_segment(group);
 256
 257     return ref;
 258 }
 259
 260 void TarSegmentStore::sync()
 261 {
 262     while (!segments.empty())
 263         close_segment(segments.begin()->first);
 264 }
 265
 266 void TarSegmentStore::dump_stats()
 267 {
 268     printf("Data written:\n");
 269     for (map<string, int64_t>::iterator i = group_sizes.begin();
 270          i != group_sizes.end(); ++i) {
 271         printf("    %s: %lld\n", i->first.c_str(), i->second);
 272     }
 273 }
 274
 275 void TarSegmentStore::close_segment(const string &group)
 276 {
 277     struct segment_info *segment = segments[group];
 278
 279     delete segment->file;
 280
 281     if (db != NULL) {
 282         SHA1Checksum segment_checksum;
 283         if (segment_checksum.process_file(segment->rf->get_local_path().c_str())) {
 284             string checksum = segment_checksum.checksum_str();
 285             db->SetSegmentChecksum(segment->name, segment->basename, checksum,
 286                                    segment->size);
 287         }
 288     }
 289
 290     segment->rf->send();
 291
 292     segments.erase(segments.find(group));
 293     delete segment;
 294 }
 295
 296 string TarSegmentStore::object_reference_to_segment(const string &object)
 297 {
 298     return object;
 299 }
 300
 301 LbsObject::LbsObject()
 302     : group(""), data(NULL), data_len(0), written(false)
 303 {
 304 }
 305
 306 LbsObject::~LbsObject()
 307 {
 308 }
 309
 310 void LbsObject::write(TarSegmentStore *store)
 311 {
 312     assert(data != NULL);
 313     assert(!written);
 314
 315     ref = store->write_object(data, data_len, group);
 316     written = true;
 317 }
 318
 319 void LbsObject::checksum()
 320 {
 321     assert(written);
 322
 323     SHA1Checksum hash;
 324     hash.process(data, data_len);
 325     ref.set_checksum(hash.checksum_str());
 326 }