forked from archiecobbs/s3backer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
s3b_config.c
2088 lines (1915 loc) · 86.5 KB
/
s3b_config.c
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* s3backer - FUSE-based single file backing store via Amazon S3
*
* Copyright 2008-2020 Archie L. Cobbs <archie.cobbs@gmail.com>
*
* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations including
* the two.
*
* You must obey the GNU General Public License in all respects for all
* of the code used other than OpenSSL. If you modify file(s) with this
* exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do
* so, delete this exception statement from your version. If you delete
* this exception statement from all source files in the program, then
* also delete it here.
*/
#include "s3backer.h"
#include "block_cache.h"
#include "zero_cache.h"
#include "ec_protect.h"
#include "fuse_ops.h"
#include "http_io.h"
#include "test_io.h"
#include "s3b_config.h"
#include "dcache.h"
#include "compress.h"
#include "util.h"
/****************************************************************************
* DEFINITIONS *
****************************************************************************/
// S3 URL
#define S3_DOMAIN "amazonaws.com"
// S3 access permission strings
#define S3_ACCESS_PRIVATE "private"
#define S3_ACCESS_PUBLIC_READ "public-read"
#define S3_ACCESS_PUBLIC_READ_WRITE "public-read-write"
#define S3_ACCESS_AUTHENTICATED_READ "authenticated-read"
// Default values for some configuration parameters
#define S3BACKER_DEFAULT_ACCESS_TYPE S3_ACCESS_PRIVATE
#define S3BACKER_DEFAULT_AUTH_VERSION AUTH_VERSION_AWS4
#define S3BACKER_DEFAULT_REGION "us-east-1"
#define S3BACKER_DEFAULT_PWD_FILE ".s3backer_passwd"
#define S3BACKER_DEFAULT_PREFIX ""
#define S3BACKER_DEFAULT_FILENAME "file"
#define S3BACKER_DEFAULT_STATS_FILENAME "stats"
#define S3BACKER_DEFAULT_BLOCKSIZE 4096
#define S3BACKER_DEFAULT_TIMEOUT 30 // 30s
#define S3BACKER_DEFAULT_FILE_MODE 0600
#define S3BACKER_DEFAULT_FILE_MODE_READ_ONLY 0400
#define S3BACKER_DEFAULT_INITIAL_RETRY_PAUSE 200 // 200ms
#define S3BACKER_DEFAULT_MAX_RETRY_PAUSE 30000 // 30s
#define S3BACKER_DEFAULT_MIN_WRITE_DELAY 0 // disabled
#define S3BACKER_DEFAULT_MD5_CACHE_TIME 0 // disabled
#define S3BACKER_DEFAULT_MD5_CACHE_SIZE 0 // disabled
#define S3BACKER_DEFAULT_BLOCK_CACHE_SIZE 1000
#define S3BACKER_DEFAULT_BLOCK_CACHE_NUM_THREADS 20
#define S3BACKER_DEFAULT_BLOCK_CACHE_WRITE_DELAY 250 // 250ms
#define S3BACKER_DEFAULT_BLOCK_CACHE_TIMEOUT 0
#define S3BACKER_DEFAULT_BLOCK_CACHE_MAX_DIRTY 0
#define S3BACKER_DEFAULT_READ_AHEAD 4
#define S3BACKER_DEFAULT_READ_AHEAD_TRIGGER 2
#define S3BACKER_DEFAULT_COMPRESSION "deflate"
#define S3BACKER_DEFAULT_ENCRYPTION "AES-128-CBC"
#define S3BACKER_DEFAULT_LIST_BLOCKS_THREADS 16
// Macro for quoting stuff
#define s3bquote0(x) #x
#define s3bquote(x) s3bquote0(x)
// MacFUSE setting for kernel daemon timeout
#ifdef __APPLE__
#ifndef FUSE_MAX_DAEMON_TIMEOUT
#define FUSE_MAX_DAEMON_TIMEOUT 600
#endif
#define FUSE_MAX_DAEMON_TIMEOUT_STRING s3bquote(FUSE_MAX_DAEMON_TIMEOUT)
#endif // __APPLE__
/****************************************************************************
* FUNCTION DECLARATIONS *
****************************************************************************/
static print_stats_t s3b_config_print_stats;
static clear_stats_t s3b_config_clear_stats;
static void insert_fuse_arg(int pos, const char *arg);
static void append_fuse_arg(const char *arg);
static void remove_fuse_arg(int pos);
static void read_fuse_args(const char *filename, int pos);
static int search_access_for(const char *file, const char *accessId, char **idptr, char **pwptr);
static int handle_unknown_option(void *data, const char *arg, int key, struct fuse_args *outargs);
static int validate_config(int parse_only);
/****************************************************************************
* VARIABLE DEFINITIONS *
****************************************************************************/
// Upload/download strings
static const char *const upload_download_names[] = { "download", "upload" };
// Valid S3 access values
static const char *const s3_acls[] = {
S3_ACCESS_PRIVATE,
S3_ACCESS_PUBLIC_READ,
S3_ACCESS_PUBLIC_READ_WRITE,
S3_ACCESS_AUTHENTICATED_READ,
NULL
};
// Valid S3 authentication types
static const char *const s3_auth_types[] = {
AUTH_VERSION_AWS2,
AUTH_VERSION_AWS4,
NULL
};
// Valid S3 storage classes
static const char *const s3_storage_classes[] = {
STORAGE_CLASS_STANDARD,
STORAGE_CLASS_STANDARD_IA,
STORAGE_CLASS_ONEZONE_IA,
STORAGE_CLASS_REDUCED_REDUNDANCY,
STORAGE_CLASS_INTELLIGENT_TIERING,
STORAGE_CLASS_GLACIER,
STORAGE_CLASS_DEEP_ARCHIVE,
STORAGE_CLASS_OUTPOSTS,
NULL
};
// Configuration structure
static char user_agent_buf[64];
static struct s3b_config config = {
// HTTP config
.http_io= {
.accessId= NULL,
.accessKey= NULL,
.baseURL= NULL,
.region= NULL,
.sse= NULL,
.sse_key_id= NULL,
.accessType= S3BACKER_DEFAULT_ACCESS_TYPE,
.authVersion= S3BACKER_DEFAULT_AUTH_VERSION,
.user_agent= user_agent_buf,
.timeout= S3BACKER_DEFAULT_TIMEOUT,
.initial_retry_pause= S3BACKER_DEFAULT_INITIAL_RETRY_PAUSE,
.max_retry_pause= S3BACKER_DEFAULT_MAX_RETRY_PAUSE,
.list_blocks_threads= S3BACKER_DEFAULT_LIST_BLOCKS_THREADS,
},
// "Eventual consistency" protection config
.ec_protect= {
.min_write_delay= S3BACKER_DEFAULT_MIN_WRITE_DELAY,
.cache_time= S3BACKER_DEFAULT_MD5_CACHE_TIME,
.cache_size= S3BACKER_DEFAULT_MD5_CACHE_SIZE,
},
// Block cache config
.block_cache= {
.cache_size= S3BACKER_DEFAULT_BLOCK_CACHE_SIZE,
.num_threads= S3BACKER_DEFAULT_BLOCK_CACHE_NUM_THREADS,
.write_delay= S3BACKER_DEFAULT_BLOCK_CACHE_WRITE_DELAY,
.max_dirty= S3BACKER_DEFAULT_BLOCK_CACHE_MAX_DIRTY,
.timeout= S3BACKER_DEFAULT_BLOCK_CACHE_TIMEOUT,
.read_ahead= S3BACKER_DEFAULT_READ_AHEAD,
.read_ahead_trigger= S3BACKER_DEFAULT_READ_AHEAD_TRIGGER,
},
// FUSE operations config
.fuse_ops= {
.filename= S3BACKER_DEFAULT_FILENAME,
.stats_filename= S3BACKER_DEFAULT_STATS_FILENAME,
.file_mode= -1, // default depends on 'read_only'
},
// Common/global stuff
.block_size= 0,
.file_size= 0,
.bucket= NULL,
.prefix= S3BACKER_DEFAULT_PREFIX,
.accessKeyEnv= NULL,
.blockHashPrefix= 0,
.quiet= 0,
.erase= 0,
.no_auto_detect= 0,
.reset= 0,
.log= stderr_logger
};
/*
* Command line flags
*
* Note: each entry here is listed twice, so both version "--foo=X" and "-o foo=X" work.
* See http://code.google.com/p/s3backer/issues/detail?id=7
*/
static const struct fuse_opt option_list[] = {
{
.templ= "--accessFile=%s",
.offset= offsetof(struct s3b_config, accessFile),
},
{
.templ= "--accessId=%s",
.offset= offsetof(struct s3b_config, http_io.accessId),
},
{
.templ= "--accessKey=%s",
.offset= offsetof(struct s3b_config, http_io.accessKey),
},
{
.templ= "--accessKeyEnv=%s",
.offset= offsetof(struct s3b_config, accessKeyEnv),
},
{
.templ= "--accessType=%s",
.offset= offsetof(struct s3b_config, http_io.accessType),
},
{
.templ= "--accessEC2IAM=%s",
.offset= offsetof(struct s3b_config, http_io.ec2iam_role),
},
{
.templ= "--authVersion=%s",
.offset= offsetof(struct s3b_config, http_io.authVersion),
},
{
.templ= "--listBlocks",
.offset= offsetof(struct s3b_config, list_blocks),
.value= 1
},
{
.templ= "--listBlocksThreads=%d",
.offset= offsetof(struct s3b_config, http_io.list_blocks_threads),
},
{
.templ= "--baseURL=%s",
.offset= offsetof(struct s3b_config, http_io.baseURL),
},
{
.templ= "--region=%s",
.offset= offsetof(struct s3b_config, http_io.region),
},
{
.templ= "--sse=%s",
.offset= offsetof(struct s3b_config, http_io.sse),
},
{
.templ= "--sse-key-id=%s",
.offset= offsetof(struct s3b_config, http_io.sse_key_id),
},
{
.templ= "--blockCacheSize=%u",
.offset= offsetof(struct s3b_config, block_cache.cache_size),
},
{
.templ= "--blockCacheSync",
.offset= offsetof(struct s3b_config, block_cache.synchronous),
.value= 1
},
{
.templ= "--blockCacheThreads=%u",
.offset= offsetof(struct s3b_config, block_cache.num_threads),
},
{
.templ= "--blockCacheTimeout=%u",
.offset= offsetof(struct s3b_config, block_cache.timeout),
},
{
.templ= "--blockCacheWriteDelay=%u",
.offset= offsetof(struct s3b_config, block_cache.write_delay),
},
{
.templ= "--blockCacheMaxDirty=%u",
.offset= offsetof(struct s3b_config, block_cache.max_dirty),
},
{
.templ= "--blockCacheRecoverDirtyBlocks",
.offset= offsetof(struct s3b_config, block_cache.recover_dirty_blocks),
.value= 1
},
{
.templ= "--readAhead=%u",
.offset= offsetof(struct s3b_config, block_cache.read_ahead),
},
{
.templ= "--readAheadTrigger=%u",
.offset= offsetof(struct s3b_config, block_cache.read_ahead_trigger),
},
{
.templ= "--blockCacheNumProtected=%u",
.offset= offsetof(struct s3b_config, block_cache.num_protected),
},
{
.templ= "--blockCacheFile=%s",
.offset= offsetof(struct s3b_config, block_cache.cache_file),
},
{
.templ= "--blockCacheNoVerify",
.offset= offsetof(struct s3b_config, block_cache.no_verify),
.value= 1
},
{
.templ= "--blockCacheFileAdvise",
.offset= offsetof(struct s3b_config, block_cache.fadvise),
.value= 1
},
{
.templ= "--blockSize=%s",
.offset= offsetof(struct s3b_config, block_size_str),
},
{
.templ= "--maxUploadSpeed=%s",
.offset= offsetof(struct s3b_config, max_speed_str[HTTP_UPLOAD]),
},
{
.templ= "--maxDownloadSpeed=%s",
.offset= offsetof(struct s3b_config, max_speed_str[HTTP_DOWNLOAD]),
},
{
.templ= "--md5CacheSize=%u",
.offset= offsetof(struct s3b_config, ec_protect.cache_size),
},
{
.templ= "--md5CacheTime=%u",
.offset= offsetof(struct s3b_config, ec_protect.cache_time),
},
{
.templ= "--debug",
.offset= offsetof(struct s3b_config, debug),
.value= 1
},
{
.templ= "--debug-http",
.offset= offsetof(struct s3b_config, http_io.debug_http),
.value= 1
},
{
.templ= "--http11",
.offset= offsetof(struct s3b_config, http_io.http_11),
.value= 1
},
{
.templ= "--quiet",
.offset= offsetof(struct s3b_config, quiet),
.value= 1
},
{
.templ= "--erase",
.offset= offsetof(struct s3b_config, erase),
.value= 1
},
{
.templ= "--reset-mounted-flag",
.offset= offsetof(struct s3b_config, reset),
.value= 1
},
{
.templ= "--vhost",
.offset= offsetof(struct s3b_config, http_io.vhost),
.value= 1
},
{
.templ= "--no-vhost",
.offset= offsetof(struct s3b_config, http_io.vhost),
.value= -1
},
{
.templ= "--fileMode=%o",
.offset= offsetof(struct s3b_config, fuse_ops.file_mode),
},
{
.templ= "--filename=%s",
.offset= offsetof(struct s3b_config, fuse_ops.filename),
},
{
.templ= "--force",
.offset= offsetof(struct s3b_config, force),
.value= 1
},
{
.templ= "--noAutoDetect",
.offset= offsetof(struct s3b_config, no_auto_detect),
.value= 1
},
{
.templ= "--initialRetryPause=%u",
.offset= offsetof(struct s3b_config, http_io.initial_retry_pause),
},
{
.templ= "--maxRetryPause=%u",
.offset= offsetof(struct s3b_config, http_io.max_retry_pause),
},
{
.templ= "--minWriteDelay=%u",
.offset= offsetof(struct s3b_config, ec_protect.min_write_delay),
},
{
.templ= "--blockHashPrefix",
.offset= offsetof(struct s3b_config, blockHashPrefix),
.value= 1
},
{
.templ= "--prefix=%s",
.offset= offsetof(struct s3b_config, prefix),
},
{
.templ= "--defaultContentEncoding=%s",
.offset= offsetof(struct s3b_config, http_io.default_ce),
},
{
.templ= "--readOnly",
.offset= offsetof(struct s3b_config, fuse_ops.read_only),
.value= 1
},
{
.templ= "--size=%s",
.offset= offsetof(struct s3b_config, file_size_str),
},
{
.templ= "--statsFilename=%s",
.offset= offsetof(struct s3b_config, fuse_ops.stats_filename),
},
{
.templ= "--storageClass=%s",
.offset= offsetof(struct s3b_config, http_io.storage_class),
},
{
.templ= "--ssl",
.offset= offsetof(struct s3b_config, ssl),
.value= 1
},
{
.templ= "--cacert=%s",
.offset= offsetof(struct s3b_config, http_io.cacert),
},
{
.templ= "--insecure",
.offset= offsetof(struct s3b_config, http_io.insecure),
.value= 1
},
{
.templ= "--compress",
.offset= offsetof(struct s3b_config, compress_flag),
.value= 1
},
{
.templ= "--compress=%s",
.offset= offsetof(struct s3b_config, compress_alg),
},
{
.templ= "--compress-level=%s",
.offset= offsetof(struct s3b_config, compress_level),
},
{
.templ= "--encrypt",
.offset= offsetof(struct s3b_config, encrypt),
.value= 1
},
{
.templ= "--encrypt=%s",
.offset= offsetof(struct s3b_config, http_io.encryption),
},
{
.templ= "--keyLength=%u",
.offset= offsetof(struct s3b_config, http_io.key_length),
},
{
.templ= "--password=%s",
.offset= offsetof(struct s3b_config, http_io.password),
},
{
.templ= "--passwordFile=%s",
.offset= offsetof(struct s3b_config, password_file),
},
{
.templ= "--test",
.offset= offsetof(struct s3b_config, test),
.value= 1
},
{
.templ= "--test-errors",
.offset= offsetof(struct s3b_config, test_io.random_errors),
.value= 1
},
{
.templ= "--test-delays",
.offset= offsetof(struct s3b_config, test_io.random_delays),
.value= 1
},
{
.templ= "--test-discard",
.offset= offsetof(struct s3b_config, test_io.discard_data),
.value= 1
},
{
.templ= "--timeout=%u",
.offset= offsetof(struct s3b_config, http_io.timeout),
},
{
.templ= "--directIO",
.offset= offsetof(struct s3b_config, fuse_ops.direct_io),
.value= 1
},
};
static const int num_options = sizeof(option_list) / sizeof(*option_list);
// Default flags we send to FUSE
static const char *const s3backer_fuse_defaults[] = {
"-okernel_cache",
"-oallow_other",
"-ouse_ino",
"-omax_readahead=0",
"-osubtype=s3backer",
"-oentry_timeout=31536000",
"-onegative_timeout=31536000",
"-oattr_timeout=0", // because statistics file length changes
"-odefault_permissions",
#ifndef __FreeBSD__
"-onodev",
#endif
"-onosuid",
#ifdef __APPLE__
"-odaemon_timeout=" FUSE_MAX_DAEMON_TIMEOUT_STRING,
#endif
// "-ointr",
};
// s3backer_store layers
struct s3backer_store *block_cache_store;
struct s3backer_store *zero_cache_store;
struct s3backer_store *ec_protect_store;
struct s3backer_store *http_io_store;
struct s3backer_store *test_io_store;
/****************************************************************************
* PUBLIC FUNCTION DEFINITIONS *
****************************************************************************/
struct s3b_config *
s3backer_get_config(int argc, char **argv, int nbd, int parse_only)
{
return s3backer_get_config2(argc, argv, nbd, parse_only, handle_unknown_option);
}
struct s3b_config *
s3backer_get_config2(int argc, char **argv, int nbd, int parse_only, fuse_opt_proc_t unknown_handler)
{
struct fuse_opt dup_option_list[2 * sizeof(option_list) + 1];
int num_subst = 0;
char buf[1024];
int i;
// NBDKit adjustments
if (nbd)
config.nbd = nbd;
// Remember user creds
config.fuse_ops.uid = getuid();
config.fuse_ops.gid = getgid();
// Set user-agent
snvprintf(user_agent_buf, sizeof(user_agent_buf), "%s/%s/%s", PACKAGE, VERSION, s3backer_version);
// Copy program name
memset(&config.fuse_args, 0, sizeof(config.fuse_args));
if (argc < 1)
errx(1, "missing program name");
append_fuse_arg(argv[0]);
// Add our default FUSE options so they are seen first
if (!nbd) {
for (i = 0; i < sizeof(s3backer_fuse_defaults) / sizeof(*s3backer_fuse_defaults); i++)
append_fuse_arg(s3backer_fuse_defaults[i]);
}
// Disable read-ahead in NBD mode (assume kernel already does that)
if (nbd && !parse_only) {
config.block_cache.read_ahead = 0;
config.block_cache.read_ahead_trigger = 0;
}
// Append command line args
for (i = 1; i < argc; i++)
append_fuse_arg(argv[i]);
// Find and substitute "--configFile=FILE" flags, recursing if necessary
for (i = 1; i < config.fuse_args.argc; ) {
char *optfile;
int num_args;
// Check for "--configFile=FILE" flag and variants
if (strncmp(config.fuse_args.argv[i], "--configFile=", 13) == 0) {
if ((optfile = strdup(config.fuse_args.argv[i] + 13)) == NULL)
err(1, "strdup");
num_args = 1;
} else if (strcmp(config.fuse_args.argv[i], "-F") == 0 && i + 1 < config.fuse_args.argc) {
if ((optfile = strdup(config.fuse_args.argv[i + 1])) == NULL)
err(1, "strdup");
num_args = 2;
} else if (strcmp(config.fuse_args.argv[i], "-o") == 0 && i + 1 < config.fuse_args.argc) {
char *trailing_comma;
char *flag;
// Find "configFile=" among comma-separated option list
if (strncmp(config.fuse_args.argv[i + 1], "configFile=", 11) == 0)
flag = config.fuse_args.argv[i + 1];
else if ((flag = strstr(config.fuse_args.argv[i + 1], ",configFile=")) != NULL)
flag++;
else {
i++;
continue;
}
// Extract filename from list
if ((trailing_comma = strchr(flag + 11, ',')) == NULL) {
if ((optfile = strdup(flag + 11)) == NULL)
err(1, "strdup");
*flag = '\0';
num_args = flag > config.fuse_args.argv[i + 1] ? 0 : 2;
} else {
*trailing_comma = '\0';
if ((optfile = strdup(flag + 11)) == NULL)
err(1, "strdup");
memmove(flag, trailing_comma + 1, strlen(trailing_comma + 1) + 1);
num_args = 0;
}
} else {
i++;
continue;
}
// Check for infinite loops
if (++num_subst > 100)
errx(1, "too many levels of `--configFile' nesting");
// Replace the `--configFile' flag with arguments read from file
read_fuse_args(optfile, i + num_args);
free(optfile);
while (num_args-- > 0)
remove_fuse_arg(i);
}
// Create the equivalent fstab options (without the "--") for each option in the option list
memcpy(dup_option_list, option_list, sizeof(option_list));
memcpy(dup_option_list + num_options, option_list, sizeof(option_list));
for (i = num_options; i < 2 * num_options; i++)
dup_option_list[i].templ += 2;
dup_option_list[2 * num_options].templ = NULL;
// Parse command line flags
if (fuse_opt_parse(&config.fuse_args, &config, dup_option_list, unknown_handler) != 0)
return NULL;
// Validate configuration
if (validate_config(parse_only) != 0)
return NULL;
// Set fsname based on configuration
snvprintf(buf, sizeof(buf), "-ofsname=%s", config.description);
insert_fuse_arg(1, buf);
// Set up fuse_ops callbacks
config.fuse_ops.print_stats = s3b_config_print_stats;
config.fuse_ops.clear_stats = s3b_config_clear_stats;
config.fuse_ops.s3bconf = &config;
// Debug
if (!parse_only && config.debug)
dump_config(&config);
// Done
return &config;
}
// Determine if flag (without the double dashes) is a valid flag
// Returns 0 if not, 1 if so and a boolean flag, 2 if so and a name=value flag, 3 if can be either
int
is_valid_s3b_flag(const char *flag)
{
const size_t flag_len = strlen(flag);
int result = 0;
int i;
if (strcmp(flag, "configFile") == 0) // this flag is handled specially and not in the table
return 2;
for (i = 0; i < num_options; i++) {
const char *const opt = option_list[i].templ;
if (strncmp(opt, "--", 2) == 0 && strncmp(opt + 2, flag, flag_len) == 0) {
if (opt[2 + flag_len] == '\0')
result |= 1;
if (opt[2 + flag_len] == '=')
result |= 2;
}
}
return result;
}
/*
* Create the s3backer_store used at runtime.
*/
struct s3backer_store *
s3backer_create_store(struct s3b_config *conf)
{
struct s3backer_store *store;
int32_t old_mount_token;
int32_t new_mount_token;
int r;
// Sanity check
if (http_io_store != NULL || test_io_store != NULL) {
errno = EINVAL;
return NULL;
}
// Create HTTP (or test) layer
if (conf->test) {
if ((test_io_store = test_io_create(&conf->test_io)) == NULL)
return NULL;
store = test_io_store;
} else {
if ((http_io_store = http_io_create(&conf->http_io)) == NULL)
return NULL;
store = http_io_store;
}
// Create eventual consistency protection layer (if desired)
if (conf->ec_protect.cache_size > 0) {
if ((ec_protect_store = ec_protect_create(&conf->ec_protect, store)) == NULL)
goto fail_with_errno;
store = ec_protect_store;
}
// Create block cache layer (if desired)
if (conf->block_cache.cache_size > 0) {
if ((block_cache_store = block_cache_create(&conf->block_cache, store)) == NULL)
goto fail_with_errno;
store = block_cache_store;
}
// Create zero block cache
if ((zero_cache_store = zero_cache_create(&conf->zero_cache, store)) == NULL)
goto fail_with_errno;
store = zero_cache_store;
// Set mount token and check previous value one last time
new_mount_token = -1;
if (!conf->fuse_ops.read_only) {
srandom((long)time(NULL) ^ (long)&old_mount_token);
do
new_mount_token = random();
while (new_mount_token <= 0);
}
if ((r = (*store->set_mount_token)(store, &old_mount_token, new_mount_token)) != 0) {
(*conf->log)(LOG_ERR, "error reading mount token on %s: %s", conf->description, strerror(r));
goto fail;
}
if (old_mount_token != 0) {
if (!conf->force && !conf->block_cache.perform_flush) {
(*conf->log)(LOG_ERR, "%s appears to be mounted by another s3backer process (using mount token 0x%08x)",
config.description, (int)old_mount_token);
r = EBUSY;
goto fail;
}
}
if (new_mount_token != -1)
(*conf->log)(LOG_INFO, "established new mount token 0x%08x", (int)new_mount_token);
// Done
return store;
fail_with_errno:
r = errno;
fail:
if (store != NULL) {
(*store->shutdown)(store);
(*store->destroy)(store);
}
block_cache_store = NULL;
zero_cache_store = NULL;
ec_protect_store = NULL;
http_io_store = NULL;
test_io_store = NULL;
errno = r;
return NULL;
}
#define FORCE_FREE2(p, def) do { \
if ((p) != NULL && (p) != (def)) { \
free((void *)(intptr_t)(p)); \
(p) = NULL; \
} \
} while (0)
#define FORCE_FREE(p) FORCE_FREE2(p, NULL)
// Free memory prior to unload/exit. This is mainly to make valgrind happy.
void
s3b_cleanup(void)
{
// Config flags
FORCE_FREE(config.accessFile);
FORCE_FREE(config.http_io.accessId);
FORCE_FREE(config.http_io.accessKey);
FORCE_FREE(config.accessKeyEnv);
FORCE_FREE2(config.http_io.accessType, S3BACKER_DEFAULT_ACCESS_TYPE);
FORCE_FREE(config.http_io.ec2iam_role);
FORCE_FREE2(config.http_io.authVersion, S3BACKER_DEFAULT_AUTH_VERSION);
FORCE_FREE(config.http_io.baseURL);
FORCE_FREE2(config.http_io.region, S3BACKER_DEFAULT_REGION);
FORCE_FREE(config.http_io.sse);
FORCE_FREE(config.http_io.sse_key_id);
FORCE_FREE(config.block_cache.cache_file);
FORCE_FREE(config.block_size_str);
FORCE_FREE(config.max_speed_str[HTTP_UPLOAD]);
FORCE_FREE(config.max_speed_str[HTTP_DOWNLOAD]);
FORCE_FREE2(config.prefix, S3BACKER_DEFAULT_PREFIX);
FORCE_FREE(config.http_io.default_ce);
FORCE_FREE(config.http_io.vhostURL);
FORCE_FREE(config.file_size_str);
FORCE_FREE2(config.fuse_ops.filename, S3BACKER_DEFAULT_FILENAME);
FORCE_FREE2(config.fuse_ops.stats_filename, S3BACKER_DEFAULT_STATS_FILENAME);
FORCE_FREE(config.http_io.storage_class);
FORCE_FREE(config.http_io.cacert);
FORCE_FREE2(config.compress_alg, S3BACKER_DEFAULT_COMPRESSION);
FORCE_FREE(config.compress_level);
FORCE_FREE(config.http_io.encryption);
FORCE_FREE(config.http_io.password);
FORCE_FREE(config.password_file);
// Config params
FORCE_FREE(config.bucket);
FORCE_FREE(config.mount);
// Misc
FORCE_FREE(zero_block);
fuse_opt_free_args(&config.fuse_args);
if (config.http_io.compress_alg != NULL) {
(*config.http_io.compress_alg->lfree)(config.http_io.compress_level);
config.http_io.compress_level = NULL;
}
// Done
memset(&config, 0, sizeof(config));
}
/****************************************************************************
* INTERNAL FUNCTION DEFINITIONS *
****************************************************************************/
static void
s3b_config_print_stats(void *prarg, printer_t *printer)
{
struct http_io_stats http_io_stats;
struct ec_protect_stats ec_protect_stats;
struct zero_cache_stats zero_cache_stats;
struct block_cache_stats block_cache_stats;
double curl_reuse_ratio = 0.0;
u_int total_oom = 0;
u_int total_curls;
// Get HTTP stats
if (http_io_store != NULL)
http_io_get_stats(http_io_store, &http_io_stats);
// Get zero cache stats
if (zero_cache_store != NULL)
zero_cache_get_stats(zero_cache_store, &zero_cache_stats);
// Get EC protection stats
if (ec_protect_store != NULL)
ec_protect_get_stats(ec_protect_store, &ec_protect_stats);
// Get block cache stats
if (block_cache_store != NULL)
block_cache_get_stats(block_cache_store, &block_cache_stats);
// Print stats in human-readable form
if (http_io_store != NULL) {
(*printer)(prarg, "%-28s %u\n", "http_normal_blocks_read", http_io_stats.normal_blocks_read);
(*printer)(prarg, "%-28s %u\n", "http_normal_blocks_written", http_io_stats.normal_blocks_written);
(*printer)(prarg, "%-28s %u\n", "http_zero_blocks_read", http_io_stats.zero_blocks_read);
(*printer)(prarg, "%-28s %u\n", "http_zero_blocks_written", http_io_stats.zero_blocks_written);
if (config.list_blocks) {
(*printer)(prarg, "%-28s %u\n", "http_empty_blocks_read", http_io_stats.empty_blocks_read);
(*printer)(prarg, "%-28s %u\n", "http_empty_blocks_written", http_io_stats.empty_blocks_written);
}
(*printer)(prarg, "%-28s %u\n", "http_gets", http_io_stats.http_gets.count);
(*printer)(prarg, "%-28s %u\n", "http_puts", http_io_stats.http_puts.count);
(*printer)(prarg, "%-28s %u\n", "http_deletes", http_io_stats.http_deletes.count);
(*printer)(prarg, "%-28s %.3f sec\n", "http_avg_get_time", http_io_stats.http_gets.count > 0 ?
http_io_stats.http_gets.time / http_io_stats.http_gets.count : 0.0);
(*printer)(prarg, "%-28s %.3f sec\n", "http_avg_put_time", http_io_stats.http_puts.count > 0 ?
http_io_stats.http_puts.time / http_io_stats.http_puts.count : 0.0);
(*printer)(prarg, "%-28s %.3f sec\n", "http_avg_delete_time", http_io_stats.http_deletes.count > 0 ?
http_io_stats.http_deletes.time / http_io_stats.http_deletes.count : 0.0);
(*printer)(prarg, "%-28s %u\n", "http_unauthorized", http_io_stats.http_unauthorized);
(*printer)(prarg, "%-28s %u\n", "http_forbidden", http_io_stats.http_forbidden);
(*printer)(prarg, "%-28s %u\n", "http_stale", http_io_stats.http_stale);
(*printer)(prarg, "%-28s %u\n", "http_redirect", http_io_stats.http_redirect);
(*printer)(prarg, "%-28s %u\n", "http_verified", http_io_stats.http_verified);
(*printer)(prarg, "%-28s %u\n", "http_mismatch", http_io_stats.http_mismatch);
(*printer)(prarg, "%-28s %u\n", "http_5xx_error", http_io_stats.http_5xx_error);
(*printer)(prarg, "%-28s %u\n", "http_4xx_error", http_io_stats.http_4xx_error);
(*printer)(prarg, "%-28s %u\n", "http_3xx_error", http_io_stats.http_3xx_error);
(*printer)(prarg, "%-28s %u\n", "http_other_error", http_io_stats.http_other_error);
(*printer)(prarg, "%-28s %u\n", "http_canceled_writes", http_io_stats.http_canceled_writes);
(*printer)(prarg, "%-28s %u\n", "http_num_retries", http_io_stats.num_retries);
(*printer)(prarg, "%-28s %ju.%03u sec\n", "http_total_retry_delay",
(uintmax_t)(http_io_stats.retry_delay / 1000), (u_int)(http_io_stats.retry_delay % 1000));
total_curls = http_io_stats.curl_handles_created + http_io_stats.curl_handles_reused;
if (total_curls > 0)
curl_reuse_ratio = (double)http_io_stats.curl_handles_reused / (double)total_curls;
(*printer)(prarg, "%-28s %.4f\n", "curl_handle_reuse_ratio", curl_reuse_ratio);
(*printer)(prarg, "%-28s %u\n", "curl_timeouts", http_io_stats.curl_timeouts);
(*printer)(prarg, "%-28s %u\n", "curl_connect_failed", http_io_stats.curl_connect_failed);
(*printer)(prarg, "%-28s %u\n", "curl_host_unknown", http_io_stats.curl_host_unknown);
(*printer)(prarg, "%-28s %u\n", "curl_out_of_memory", http_io_stats.curl_out_of_memory);
(*printer)(prarg, "%-28s %u\n", "curl_other_error", http_io_stats.curl_other_error);
total_oom += http_io_stats.out_of_memory_errors;
}
if (block_cache_store != NULL) {
double read_hit_ratio = 0.0;
double write_hit_ratio = 0.0;
u_int total_reads;
u_int total_writes;
total_reads = block_cache_stats.read_hits + block_cache_stats.read_misses;
if (total_reads != 0)
read_hit_ratio = (double)block_cache_stats.read_hits / (double)total_reads;
total_writes = block_cache_stats.write_hits + block_cache_stats.write_misses;
if (total_writes != 0)
write_hit_ratio = (double)block_cache_stats.write_hits / (double)total_writes;
(*printer)(prarg, "%-28s %u blocks\n", "block_cache_current_size", block_cache_stats.current_size);
(*printer)(prarg, "%-28s %u blocks\n", "block_cache_initial_size", block_cache_stats.initial_size);
(*printer)(prarg, "%-28s %.8f\n", "block_cache_dirty_ratio", block_cache_stats.dirty_ratio);
(*printer)(prarg, "%-28s %u\n", "block_cache_read_hits", block_cache_stats.read_hits);
(*printer)(prarg, "%-28s %u\n", "block_cache_read_misses", block_cache_stats.read_misses);
(*printer)(prarg, "%-28s %.8f\n", "block_cache_read_hit_ratio", read_hit_ratio);
(*printer)(prarg, "%-28s %u\n", "block_cache_write_hits", block_cache_stats.write_hits);
(*printer)(prarg, "%-28s %u\n", "block_cache_write_misses", block_cache_stats.write_misses);
(*printer)(prarg, "%-28s %.8f\n", "block_cache_write_hit_ratio", write_hit_ratio);
(*printer)(prarg, "%-28s %u\n", "block_cache_verified", block_cache_stats.verified);
(*printer)(prarg, "%-28s %u\n", "block_cache_mismatch", block_cache_stats.mismatch);
total_oom += block_cache_stats.out_of_memory_errors;
}
if (zero_cache_store != NULL) {
(*printer)(prarg, "%-28s %ju blocks\n", "zero_block_cache_size", (uintmax_t)zero_cache_stats.current_cache_size);
(*printer)(prarg, "%-28s %u\n", "zero_block_cache_read_hits", zero_cache_stats.read_hits);
(*printer)(prarg, "%-28s %u\n", "zero_block_cache_write_hits", zero_cache_stats.write_hits);
}
if (ec_protect_store != NULL) {
(*printer)(prarg, "%-28s %u blocks\n", "md5_cache_current_size", ec_protect_stats.current_cache_size);
(*printer)(prarg, "%-28s %u\n", "md5_cache_data_hits", ec_protect_stats.cache_data_hits);
(*printer)(prarg, "%-28s %ju.%03u sec\n", "md5_cache_full_delays",
(uintmax_t)(ec_protect_stats.cache_full_delay / 1000), (u_int)(ec_protect_stats.cache_full_delay % 1000));
(*printer)(prarg, "%-28s %ju.%03u sec\n", "md5_cache_write_delays",
(uintmax_t)(ec_protect_stats.repeated_write_delay / 1000), (u_int)(ec_protect_stats.repeated_write_delay % 1000));
total_oom += ec_protect_stats.out_of_memory_errors;
}
(*printer)(prarg, "%-28s %u\n", "out_of_memory_errors", total_oom);
}
static void
s3b_config_clear_stats(void)
{
// Clear HTTP stats
if (http_io_store != NULL)
http_io_clear_stats(http_io_store);
// Clear EC protection stats
if (ec_protect_store != NULL)
ec_protect_clear_stats(ec_protect_store);
// Clear zero block cache stats
if (zero_cache_store != NULL)
zero_cache_clear_stats(zero_cache_store);
// Clear block cache stats
if (block_cache_store != NULL)