-
Notifications
You must be signed in to change notification settings - Fork 5
/
folve-main.cc
426 lines (381 loc) · 14.1 KB
/
folve-main.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
// Folve - A fuse filesystem that convolves audio files on-the-fly.
//
// Copyright (C) 2012 Henner Zeller <h.zeller@acm.org>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Use latest version.
#define FUSE_USE_VERSION 26
#include <fuse/fuse.h>
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <sndfile.h> // for sf_version_string
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/syscall.h> // need to call gettid syscall.
#include <sys/time.h>
#include <sys/types.h>
#include <syslog.h>
#include <unistd.h>
#include "folve-filesystem.h"
#include "status-server.h"
#include "util.h"
static const char kStatusFileName[] = "/folve-status.html";
// Compilation unit variables to communicate with the fuse callbacks.
static struct FolveRuntime {
FolveRuntime() : fs(NULL), mount_point(NULL),
status_port(-1), refresh_time(10), parameter_error(false),
readdir_dump_file(NULL), status_server(NULL) {}
FolveFilesystem *fs;
const char *mount_point;
int status_port;
int refresh_time;
bool parameter_error;
FILE *readdir_dump_file;
StatusServer *status_server;
} folve_rt;
// Logger that only prints to stderr; used for
class ReaddirLogger {
public:
ReaddirLogger() : start_time_(folve::CurrentTime()) {}
void WriteInit() {
if (!folve_rt.readdir_dump_file) return;
fprintf (folve_rt.readdir_dump_file, "%-11s %-8s: <log>\n",
"# time", " tid");
fflush(folve_rt.readdir_dump_file);
}
ReaddirLogger &Log(const char *fmt, ...)
__attribute__ ((format (printf, 2, 3))) {
if (!folve_rt.readdir_dump_file) return *this;
fprintf (folve_rt.readdir_dump_file, "%011.6f %08lx: ",
folve::CurrentTime() - start_time_, syscall(SYS_gettid));
va_list ap;
va_start(ap, fmt);
folve::MutexLock l(&io_mutex_);
vfprintf(folve_rt.readdir_dump_file, fmt, ap);
va_end(ap);
return *this;
}
void Flush() {
if (folve_rt.readdir_dump_file) {
folve::MutexLock l(&io_mutex_);
fflush(folve_rt.readdir_dump_file);
}
}
private:
const double start_time_;
folve::Mutex io_mutex_;
} rlog;
static char *concat_path(char *buf, const char *a, const char *b) {
strcpy(buf, a);
strcat(buf, b);
return buf;
}
// Given a relative path from the root of the mounted file-system, get the
// original file from the source filesystem.
static const char *assemble_orig_path(char *buf, const char *path) {
return concat_path(buf, folve_rt.fs->underlying_dir().c_str(), path);
}
// Essentially lstat(). Just forward to the original filesystem (this
// will by lying: our convolved files are of different size...)
static int folve_getattr(const char *path, struct stat *stbuf) {
if (strcmp(path, kStatusFileName) == 0) {
FileHandler *status = folve_rt.status_server->CreateStatusFileHandler();
status->Stat(stbuf);
delete status;
return 0;
}
// If this is a currently open filename, we might be able to output a better
// estimate.
int result = folve_rt.fs->StatByFilename(path, stbuf);
if (result != 0) {
char path_buf[PATH_MAX];
result = lstat(assemble_orig_path(path_buf, path), stbuf);
rlog.Log("STAT %s mode=%03o %s %s %s", path,
stbuf->st_mode & 0777, S_ISDIR(stbuf->st_mode) ? "DIR" : "",
(result == -1) ? strerror(errno) : "",
ctime(&stbuf->st_mtime)); // ctime ends with \n, so put that last
stbuf->st_size *= folve_rt.fs->file_oversize_factor();
if (result == -1)
return -errno;
} else {
rlog.Log("FOLVE-Stat %s\n", path);
}
// Whatever write mode was there before: now things are readonly.
stbuf->st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
return 0;
}
// readdir(). Just forward to original filesystem.
static int folve_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
off_t offset, struct fuse_file_info *fi) {
if (strcmp(path, "/") == 0) {
struct stat st;
memset(&st, 0, sizeof(st));
filler(buf, kStatusFileName + 1, &st, 0);
}
DIR *dp;
struct dirent *de;
char path_buf[PATH_MAX];
dp = opendir(assemble_orig_path(path_buf, path));
if (dp == NULL)
return -errno;
// Entry size is a bit shaky to calculate, but this should be the upper bound.
const size_t entry_size = sizeof(struct dirent) + PATH_MAX;
struct dirent *entry_buf = (struct dirent *) malloc(entry_size);
rlog.Log("LIST %s\n", path);
while (readdir_r(dp, entry_buf, &de) == 0 && de != NULL) {
struct stat st;
memset(&st, 0, sizeof(st));
st.st_ino = de->d_ino;
st.st_mode = de->d_type << 12;
const char *entry_name = de->d_name;
rlog.Log("ITEM %s%s%s\n", path, strlen(path) > 1 ? "/" : "", de->d_name);
if (filler(buf, entry_name, &st, 0)) {
rlog.Log("DONE (%s)\n", de->d_name);
break;
}
}
free(entry_buf);
rlog.Log("DONE %s\n", path).Flush();
closedir(dp);
return 0;
}
// readlink(): forward to original filesystem.
static int folve_readlink(const char *path, char *buf, size_t size) {
char path_buf[PATH_MAX];
const int result = readlink(assemble_orig_path(path_buf, path),
buf, size - 1);
if (result == -1)
return -errno;
buf[result] = '\0';
return 0;
}
static int folve_open(const char *path, struct fuse_file_info *fi) {
if (strcmp(path, kStatusFileName) == 0) {
fi->fh = (uint64_t) folve_rt.status_server->CreateStatusFileHandler();
return 0;
}
// We want to be allowed to only return part of the requested data in read().
// That way, we can separate reading the ID3-tags from
// decoding of the music stream - that way indexing should be fast.
// Setting the flag 'direct_io' allows us to return partial results.
fi->direct_io = 1;
// The file-handle has the neat property to be 64 bit - so we can actually
// stuff a pointer to our file handler object in there :)
// (Yay, someone was thinking while developing that API).
FileHandler *handler = folve_rt.fs->GetOrCreateHandler(path);
if (handler == NULL)
return -errno;
fi->fh = (uint64_t) handler;
return 0;
}
static int folve_read(const char *path, char *buf, size_t size, off_t offset,
struct fuse_file_info *fi) {
return reinterpret_cast<FileHandler *>(fi->fh)->Read(buf, size, offset);
}
static int folve_release(const char *path, struct fuse_file_info *fi) {
if (strcmp(path, kStatusFileName) == 0) {
delete reinterpret_cast<FileHandler *>(fi->fh);
} else {
folve_rt.fs->Close(path, reinterpret_cast<FileHandler *>(fi->fh));
}
return 0;
}
static int folve_fgetattr(const char *path, struct stat *result,
struct fuse_file_info *fi) {
return reinterpret_cast<FileHandler *>(fi->fh)->Stat(result);
}
static void *folve_init(struct fuse_conn_info *conn) {
const int ident_len = 20;
char *ident = (char*) malloc(ident_len); // openlog() keeps reference. Leaks.
snprintf(ident, ident_len, "folve[%d]", getpid());
openlog(ident, LOG_CONS|LOG_PERROR, LOG_USER);
syslog(LOG_INFO, "Version " FOLVE_VERSION " started "
"(with fuse=%d.%d; sndfile=%s). ",
FUSE_MAJOR_VERSION, FUSE_MINOR_VERSION, sf_version_string());
syslog(LOG_INFO, "Serving '%s' on mount point '%s'",
folve_rt.fs->underlying_dir().c_str(), folve_rt.mount_point);
if (folve::IsDebugLogEnabled()) {
syslog(LOG_INFO, "Debug logging enabled (-D)");
}
// Status server is always used - it serves the status as an HTML file.
folve_rt.status_server = new StatusServer(folve_rt.fs);
if (folve_rt.status_port > 0) {
// Need to start status server after we're daemonized.
if (folve_rt.status_server->Start(folve_rt.status_port)) {
syslog(LOG_INFO, "HTTP status server on port %d; refresh=%d",
folve_rt.status_port, folve_rt.refresh_time);
folve_rt.status_server->set_meta_refresh(folve_rt.refresh_time);
} else {
syslog(LOG_ERR, "Couldn't start HTTP server on port %d\n",
folve_rt.status_port);
}
}
folve_rt.fs->SetupInitialConfig();
return NULL;
}
static void folve_destroy(void *) {
if (folve_rt.readdir_dump_file) {
fclose(folve_rt.readdir_dump_file);
}
syslog(LOG_INFO, "Exiting.");
}
static int usage(const char *prg) {
printf("usage: %s [options] <original-dir> <mount-point-dir>\n", prg);
printf("Options: (in sequence of usefulness)\n"
"\t-C <cfg-dir> : Convolver base configuration directory.\n"
"\t Sub-directories name the different filters.\n"
"\t Select on the HTTP status page.\n"
"\t-p <port> : Port to run the HTTP status server on.\n"
"\t-r <refresh> : Seconds between refresh of status page;\n"
"\t Default is %d seconds; switch off with -1.\n"
"\t-g : Gapless convolving alphabetically adjacent files.\n"
"\t-b <KibiByte>: Pre-buffer files by given KiB.\n"
"\t-D : Moderate volume Folve debug messages to syslog,\n"
"\t and some more detailed configuration info in UI\n"
"\t-f : Operate in foreground; useful for debugging.\n"
"\t-o <mnt-opt> : other generic mount parameters passed to FUSE.\n"
"\t-d : High volume FUSE debug log. Implies -f.\n"
"\t-R <file> : Debug readdir() & stat() calls. Output to file.\n",
folve_rt.refresh_time);
return 1;
}
struct FolveConfig {
FolveConfig() : base_dir(NULL), config_dir(NULL), port(-1) {}
const char *base_dir;
const char *mount_point;
const char *config_dir;
int port;
};
enum {
FOLVE_OPT_PORT = 42,
FOLVE_OPT_PREBUFFER,
FOLVE_OPT_REFRESH_TIME,
FOLVE_OPT_CONFIG,
FOLVE_OPT_DEBUG,
FOLVE_OPT_DEBUG_READDIR,
FOLVE_OPT_GAPLESS,
};
int FolveOptionHandling(void *data, const char *arg, int key,
struct fuse_args *outargs) {
char realpath_buf[PATH_MAX]; // running as daemon, need absolute names.
FolveRuntime *rt = (FolveRuntime*) data;
switch (key) {
case FUSE_OPT_KEY_NONOPT:
// First non-opt: our underlying dir.
if (rt->fs->underlying_dir().empty()) {
const char *base_dir = realpath(arg, realpath_buf);
if (base_dir != NULL) {
rt->fs->set_underlying_dir(base_dir);
} else {
fprintf(stderr, "Invalid base path '%s': %s\n",
arg, strerror(errno));
rt->parameter_error = true;
}
return 0; // we consumed this.
} else {
rt->mount_point = strdup(arg); // remmber as FYI
return 1; // .. but leave it to fuse
}
case FOLVE_OPT_PORT:
rt->status_port = atoi(arg + 2); // strip "-p"
return 0;
case FOLVE_OPT_PREBUFFER: {
char *end;
const double value = strtod(arg + 2, &end);
if (*end != '\0') {
fprintf(stderr, "Invalid number %s\n", arg + 2);
rt->parameter_error= true;
} else if (value > 16384) {
fprintf(stderr, "-b %.1f out of range. More than 16MiB prebuffer. "
"That is a lot!\n",
value);
rt->parameter_error= true;
} else if (value < 8) {
fprintf(stderr, "-b %.1f is really small. You want more than 64KiB to "
"be useful, typically 1024.\n", value);
rt->parameter_error= true;
} else {
rt->fs->set_pre_buffer_size(value * (1 << 10));
}
return 0;
}
case FOLVE_OPT_REFRESH_TIME:
rt->refresh_time = atoi(arg + 2); // strip "-r"
return 0;
case FOLVE_OPT_CONFIG: {
const char *config_dir = realpath(arg + 2, realpath_buf); // strip "-C"
if (config_dir != NULL) {
rt->fs->SetBaseConfigDir(config_dir);
} else {
fprintf(stderr, "Invalid config dir '%s': %s\n", arg + 2, strerror(errno));
rt->parameter_error = true;
}
return 0;
}
case FOLVE_OPT_DEBUG:
folve::EnableDebugLog(true);
return 0;
case FOLVE_OPT_DEBUG_READDIR:
rt->readdir_dump_file = fopen(arg + 2, "w");
rlog.WriteInit();
return 0;
case FOLVE_OPT_GAPLESS:
rt->fs->set_gapless_processing(true);
return 0;
}
return 1;
}
int main(int argc, char *argv[]) {
const char *progname = argv[0];
if (argc < 4) {
return usage(progname);
}
folve_rt.fs = new FolveFilesystem();
static struct fuse_opt folve_options[] = {
FUSE_OPT_KEY("-p ", FOLVE_OPT_PORT),
FUSE_OPT_KEY("-b ", FOLVE_OPT_PREBUFFER),
FUSE_OPT_KEY("-r ", FOLVE_OPT_REFRESH_TIME),
FUSE_OPT_KEY("-C ", FOLVE_OPT_CONFIG),
FUSE_OPT_KEY("-D", FOLVE_OPT_DEBUG),
FUSE_OPT_KEY("-R ", FOLVE_OPT_DEBUG_READDIR),
FUSE_OPT_KEY("-g", FOLVE_OPT_GAPLESS),
FUSE_OPT_END // This fails to compile for fuse <= 2.8.1; get >= 2.8.4
};
struct fuse_args args = FUSE_ARGS_INIT(argc, argv);
fuse_opt_parse(&args, &folve_rt, folve_options, FolveOptionHandling);
if (folve_rt.parameter_error || !folve_rt.fs->CheckInitialized()) {
return usage(progname);
}
struct fuse_operations folve_operations;
memset(&folve_operations, 0, sizeof(folve_operations));
// Start/stop. Will write to syslog and start auxiliary http service.
folve_operations.init = folve_init;
folve_operations.destroy = folve_destroy;
// Basic operations to make navigation work.
folve_operations.readdir = folve_readdir;
folve_operations.readlink = folve_readlink;
// open() and close() file.
folve_operations.open = folve_open;
folve_operations.release = folve_release;
// Actual workhorse: reading a file and returning predicted file-size
folve_operations.read = folve_read;
folve_operations.fgetattr = folve_fgetattr;
folve_operations.getattr = folve_getattr;
return fuse_main(args.argc, args.argv, &folve_operations, NULL);
}