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