store.cc

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