1 /* Cumulus: Smart Filesystem Backup to Dumb Servers
3 * Copyright (C) 2008 The Regents of the University of California
4 * Written by Michael Vrable <mvrable@cs.ucsd.edu>
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.
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.
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.
21 /* Backup data (segments and backup descriptors) may be stored on a remote
22 * fileserver instead of locally. The only local storage needed is for the
23 * local database and some temporary space for staging files before they are
24 * transferred to the remote server.
26 * Like encryption, remote storage is handled through the use of external
27 * scripts that are called when a file is to be transferred. */
40 static const size_t MAX_QUEUE_SIZE = 4;
42 RemoteStore(const std::string &stagedir, const std::string &script = "");
44 RemoteFile *alloc_file(const std::string &name, const std::string &type);
45 void enqueue(RemoteFile *file);
53 std::string staging_dir, backup_script;
54 bool terminate; // Set when thread should shut down
55 bool busy; // True while there are pending transfers
56 std::list<RemoteFile *> transfer_queue;
58 /* For error-checking purposes, track the number of files which have been
59 * allocated but not yet queued to be sent. This should be zero when the
60 * RemoteStore is destroyed. */
61 int files_outstanding;
63 void transfer_thread();
64 static void *start_transfer_thread(void *arg);
69 /* Get the file descriptor for writing to the (staging copy of the) file.
70 * The _caller_ is responsible for closing this file descriptor once all
71 * data is written, and before send() is called. */
72 int get_fd() const { return fd; }
74 const std::string &get_local_path() const { return local_path; }
76 /* Called when the file is finished--request that it be sent to the remote
77 * server. This will delete the RemoteFile object. */
78 void send() { remote_store->enqueue(this); }
80 friend class RemoteStore;
82 RemoteFile(RemoteStore *remote,
83 const std::string &name, const std::string &type,
84 const std::string &local_path);
86 RemoteStore *remote_store;
89 std::string type, local_path;
90 std::string remote_path;
93 #endif // _LBS_REMOTE_H