1 /* LBS: An LFS-inspired filesystem backup system
2 * Copyright (C) 2007 Michael Vrable
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. */
11 #include <sys/types.h>
13 #include <sys/resource.h>
35 /* Default filter program is bzip2 */
36 const char *filter_program = "bzip2 -c";
37 const char *filter_extension = ".bz2";
39 static void cloexec(int fd)
41 long flags = fcntl(fd, F_GETFD);
46 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
49 Tarfile::Tarfile(RemoteFile *file, const string &segment)
53 assert(sizeof(struct tar_header) == TAR_BLOCK_SIZE);
56 real_fd = file->get_fd();
57 filter_fd = spawn_filter(real_fd, filter_program, &filter_pid);
62 char buf[TAR_BLOCK_SIZE];
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);
69 if (close(filter_fd) != 0)
70 throw IOException("Error closing Tarfile");
72 /* ...and wait for filter process to finish. */
74 waitpid(filter_pid, &status, 0);
76 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
77 throw IOException("Filter process error");
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)
92 /* Create a pipe for communicating with the filter process. */
94 throw IOException("Unable to create pipe for filter");
97 /* Create a child process which can exec() the filter program. */
100 throw IOException("Unable to fork filter process");
106 if (filter_pid != NULL)
109 /* Child process. Rearrange file descriptors. stdin is fds[0], stdout
110 * is fd_out, stderr is unchanged. */
113 if (dup2(fds[0], 0) < 0)
117 if (dup2(fd_out, 1) < 0)
121 /* Exec the filter program. */
122 execlp("/bin/sh", "/bin/sh", "-c", program, NULL);
124 /* Should not reach here except for error cases. */
125 fprintf(stderr, "Could not exec filter: %m\n");
132 void Tarfile::tar_write(const char *data, size_t len)
137 int res = write(filter_fd, data, len);
142 fprintf(stderr, "Write error: %m\n");
143 throw IOException("Write error");
151 void Tarfile::write_object(int id, const char *data, size_t len)
153 struct tar_header header;
154 memset(&header, 0, sizeof(header));
157 sprintf(buf, "%08x", id);
158 string path = segment_name + "/" + buf;
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");
172 memset(header.chksum, ' ', sizeof(header.chksum));
174 for (int i = 0; i < TAR_BLOCK_SIZE; i++) {
175 checksum += ((uint8_t *)&header)[i];
177 sprintf(header.chksum, "%06o", checksum);
179 tar_write((const char *)&header, TAR_BLOCK_SIZE);
184 tar_write(data, len);
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);
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
201 size_t Tarfile::size_estimate()
205 if (fstat(real_fd, &statbuf) == 0)
206 return max((int64_t)statbuf.st_size, (int64_t)(size / 128));
208 /* Couldn't stat the file on disk, so just return the actual number of
209 * bytes, before compression. */
213 static const size_t SEGMENT_SIZE = 4 * 1024 * 1024;
215 static map<string, int64_t> group_sizes;
217 ObjectReference TarSegmentStore::write_object(const char *data, size_t len,
218 const std::string &group)
220 struct segment_info *segment;
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;
227 segment->name = generate_uuid();
228 segment->basename = segment->name + ".tar";
229 segment->basename += filter_extension;
232 segment->rf = remote->alloc_file(segment->basename, "segments");
233 segment->file = new Tarfile(segment->rf, segment->name);
235 segments[group] = segment;
237 segment = segments[group];
240 int id = segment->count;
242 sprintf(id_buf, "%08x", id);
244 segment->file->write_object(id, data, len);
246 segment->size += len;
248 group_sizes[group] += len;
250 ObjectReference ref(segment->name, id_buf);
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);
260 void TarSegmentStore::sync()
262 while (!segments.empty())
263 close_segment(segments.begin()->first);
266 void TarSegmentStore::dump_stats()
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);
275 void TarSegmentStore::close_segment(const string &group)
277 struct segment_info *segment = segments[group];
279 delete segment->file;
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,
292 segments.erase(segments.find(group));
296 string TarSegmentStore::object_reference_to_segment(const string &object)
301 LbsObject::LbsObject()
302 : group(""), data(NULL), data_len(0), written(false)
306 LbsObject::~LbsObject()
310 void LbsObject::write(TarSegmentStore *store)
312 assert(data != NULL);
315 ref = store->write_object(data, data_len, group);
319 void LbsObject::checksum()
324 hash.process(data, data_len);
325 ref.set_checksum(hash.checksum_str());