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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfuse: include/fuse.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfuse
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fuse.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="include_2fuse__common_8h_source.html">fuse_common.h</a>"</code><br />
<code>#include <fcntl.h></code><br />
<code>#include <time.h></code><br />
<code>#include <sys/types.h></code><br />
<code>#include <sys/stat.h></code><br />
<code>#include <sys/statvfs.h></code><br />
<code>#include <sys/uio.h></code><br />
</div>
<p><a href="include_2fuse_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfuse__config.html">fuse_config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfuse__operations.html">fuse_operations</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfuse__context.html">fuse_context</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac99b844cee7aaa8fb4e35df5b5488d82"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#ac99b844cee7aaa8fb4e35df5b5488d82">fuse_main</a>(argc, argv, op, private_data)    <a class="el" href="include_2fuse_8h.html#adf072472df42e07a8874b570af8e4aaa">fuse_main_real</a>(argc, argv, op, sizeof(*(op)), private_data)</td></tr>
<tr class="separator:ac99b844cee7aaa8fb4e35df5b5488d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af335784cf29289c7583f3312d98d2bcd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#af335784cf29289c7583f3312d98d2bcd">FUSE_REGISTER_MODULE</a>(name_, factory_)    <a class="el" href="include_2fuse_8h.html#ab92480001ec4f475a082cbd32bee94e2">fuse_module_factory_t</a> fuse_module_ ## name_ ## _factory = factory_</td></tr>
<tr class="separator:af335784cf29289c7583f3312d98d2bcd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7dd132de66a5cc2add2a4eff5d435660"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a7dd132de66a5cc2add2a4eff5d435660">fuse_fill_dir_t</a>) (void *buf, const char *name, const struct stat *stbuf, off_t off, enum <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568">fuse_fill_dir_flags</a> flags)</td></tr>
<tr class="separator:a7dd132de66a5cc2add2a4eff5d435660"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab92480001ec4f475a082cbd32bee94e2"><td class="memItemLeft" align="right" valign="top">typedef struct fuse_fs *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#ab92480001ec4f475a082cbd32bee94e2">fuse_module_factory_t</a>) (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, struct fuse_fs *fs[])</td></tr>
<tr class="separator:ab92480001ec4f475a082cbd32bee94e2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af2bcf2a473b41b3cc8da8c079656a074"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#af2bcf2a473b41b3cc8da8c079656a074">fuse_readdir_flags</a> { <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441">FUSE_READDIR_PLUS</a> = (1 << 0)
, <a class="el" href="fuse-3_813_81_2include_2fuse_8h.html#af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441">FUSE_READDIR_PLUS</a> = (1 << 0)
, <a class="el" href="include_2fuse_8h.html#af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441">FUSE_READDIR_PLUS</a> = (1 << 0)
}</td></tr>
<tr class="separator:af2bcf2a473b41b3cc8da8c079656a074"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1d0194d186240ef6aaf6e9bf8568568"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568">fuse_fill_dir_flags</a> { <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153">FUSE_FILL_DIR_PLUS</a> = (1 << 1)
, <a class="el" href="fuse-3_813_81_2include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153">FUSE_FILL_DIR_PLUS</a> = (1 << 1)
, <a class="el" href="include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153">FUSE_FILL_DIR_PLUS</a> = (1 << 1)
}</td></tr>
<tr class="separator:af1d0194d186240ef6aaf6e9bf8568568"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9cef8443ae22c4bcc800d7c45f1496fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a9cef8443ae22c4bcc800d7c45f1496fe">fuse_lib_help</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args)</td></tr>
<tr class="separator:a9cef8443ae22c4bcc800d7c45f1496fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58735a16d34acab7e0c540e9c1f51403"><td class="memItemLeft" align="right" valign="top">struct fuse * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a58735a16d34acab7e0c540e9c1f51403">fuse_new_31</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> *op, size_t op_size, void *user_data)</td></tr>
<tr class="separator:a58735a16d34acab7e0c540e9c1f51403"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04baffd979b06663ae9590e34a48b55f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a04baffd979b06663ae9590e34a48b55f">fuse_mount</a> (struct fuse *f, const char *mountpoint)</td></tr>
<tr class="separator:a04baffd979b06663ae9590e34a48b55f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aade4d93e323c341fe2859d759e9cb8d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#aade4d93e323c341fe2859d759e9cb8d8">fuse_unmount</a> (struct fuse *f)</td></tr>
<tr class="separator:aade4d93e323c341fe2859d759e9cb8d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d47cac8a295efd5370d7af059e4d14f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a0d47cac8a295efd5370d7af059e4d14f">fuse_destroy</a> (struct fuse *f)</td></tr>
<tr class="separator:a0d47cac8a295efd5370d7af059e4d14f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ea805c47ccc960497dfd64e12081159"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a6ea805c47ccc960497dfd64e12081159">fuse_loop</a> (struct fuse *f)</td></tr>
<tr class="separator:a6ea805c47ccc960497dfd64e12081159"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9024935b211288c1869dc7566895d739"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a9024935b211288c1869dc7566895d739">fuse_exit</a> (struct fuse *f)</td></tr>
<tr class="separator:a9024935b211288c1869dc7566895d739"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a0f2a6603cb1e21f5e4c1aec84a3bcc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structfuse__context.html">fuse_context</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a9a0f2a6603cb1e21f5e4c1aec84a3bcc">fuse_get_context</a> (void)</td></tr>
<tr class="separator:a9a0f2a6603cb1e21f5e4c1aec84a3bcc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04273db088e57d8242caa388193b6958"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a04273db088e57d8242caa388193b6958">fuse_getgroups</a> (int size, gid_t list[])</td></tr>
<tr class="separator:a04273db088e57d8242caa388193b6958"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0514ca828e6a02a330dcf037292c8803"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a0514ca828e6a02a330dcf037292c8803">fuse_interrupted</a> (void)</td></tr>
<tr class="separator:a0514ca828e6a02a330dcf037292c8803"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56c1dfbdfaf10818dbc6c2ca6264f19a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a56c1dfbdfaf10818dbc6c2ca6264f19a">fuse_invalidate_path</a> (struct fuse *f, const char *path)</td></tr>
<tr class="separator:a56c1dfbdfaf10818dbc6c2ca6264f19a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf072472df42e07a8874b570af8e4aaa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#adf072472df42e07a8874b570af8e4aaa">fuse_main_real</a> (int argc, char *argv[], const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> *op, size_t op_size, void *private_data)</td></tr>
<tr class="separator:adf072472df42e07a8874b570af8e4aaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b2246caec521ec4ac84093f8c4b616d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a4b2246caec521ec4ac84093f8c4b616d">fuse_start_cleanup_thread</a> (struct fuse *fuse)</td></tr>
<tr class="separator:a4b2246caec521ec4ac84093f8c4b616d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad37fd69ba40d5c261f16e207e4a5b0ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#ad37fd69ba40d5c261f16e207e4a5b0ed">fuse_stop_cleanup_thread</a> (struct fuse *fuse)</td></tr>
<tr class="separator:ad37fd69ba40d5c261f16e207e4a5b0ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90f104e6d4e01480161a3300bddbecbe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a90f104e6d4e01480161a3300bddbecbe">fuse_clean_cache</a> (struct fuse *fuse)</td></tr>
<tr class="separator:a90f104e6d4e01480161a3300bddbecbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74883ac07b1794da7affbd95251d25d7"><td class="memItemLeft" align="right" valign="top">struct fuse_fs * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a74883ac07b1794da7affbd95251d25d7">fuse_fs_new</a> (const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> *op, size_t op_size, void *private_data)</td></tr>
<tr class="separator:a74883ac07b1794da7affbd95251d25d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03baa193b5bfcbe625afbc62e9b97e91"><td class="memItemLeft" align="right" valign="top">struct fuse_session * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a03baa193b5bfcbe625afbc62e9b97e91">fuse_get_session</a> (struct fuse *f)</td></tr>
<tr class="separator:a03baa193b5bfcbe625afbc62e9b97e91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e8c9af40b22631f9f2636019cd073b6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse_8h.html#a9e8c9af40b22631f9f2636019cd073b6">fuse_open_channel</a> (const char *mountpoint, const char *options)</td></tr>
<tr class="separator:a9e8c9af40b22631f9f2636019cd073b6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the library interface of FUSE</p>
<p>IMPORTANT: you should define FUSE_USE_VERSION before including this header. </p>
<p class="definition">Definition in file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac99b844cee7aaa8fb4e35df5b5488d82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac99b844cee7aaa8fb4e35df5b5488d82">◆ </a></span>fuse_main</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fuse_main</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">argc, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">argv, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">op, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">private_data </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>    <a class="el" href="include_2fuse_8h.html#adf072472df42e07a8874b570af8e4aaa">fuse_main_real</a>(argc, argv, op, sizeof(*(op)), private_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function of FUSE.</p>
<p>This is for the lazy. This is all that has to be called from the main() function.</p>
<p>This function does the following:</p><ul>
<li>parses command line options, and handles –help and –version</li>
<li>installs signal handlers for INT, HUP, TERM and PIPE</li>
<li>registers an exit handler to unmount the filesystem on program exit</li>
<li>creates a fuse handle</li>
<li>registers the operations</li>
<li>calls either the single-threaded or the multi-threaded event loop</li>
</ul>
<p>Most file systems will have to parse some file-system specific arguments before calling this function. It is recommended to do this with <a class="el" href="fuse-3_813_80_2include_2fuse__opt_8h.html#a539ef1f571c34f516c60c4cbe2901c0e">fuse_opt_parse()</a> and a processing function that passes through any unknown options (this can also be achieved by just passing NULL as the processing function). That way, the remaining options can be passed directly to <a class="el" href="include_2fuse_8h.html#ac99b844cee7aaa8fb4e35df5b5488d82">fuse_main()</a>.</p>
<p><a class="el" href="include_2fuse_8h.html#ac99b844cee7aaa8fb4e35df5b5488d82">fuse_main()</a> accepts all options that can be passed to fuse_parse_cmdline(), fuse_new(), or <a class="el" href="fuse-3_813_80_2include_2fuse__lowlevel_8h.html#a9ee52f81d0c63d9bd46b11314ba596cf">fuse_session_new()</a>.</p>
<p>Option parsing skips argv[0], which is assumed to contain the program name. This element must always be present and is used to construct a basic <code>usage:</code> message for the –help output. argv[0] may also be set to the empty string. In this case the usage message is suppressed. This can be used by file systems to print their own usage line first. See hello.c for an example of how to do this.</p>
<p>Note: this is currently implemented as a macro.</p>
<p>The following error codes may be returned from <a class="el" href="include_2fuse_8h.html#ac99b844cee7aaa8fb4e35df5b5488d82">fuse_main()</a>: 1: Invalid option arguments 2: No mount point specified 3: FUSE setup failed 4: Mounting failed 5: Failed to daemonize (detach from session) 6: Failed to set up signal handlers 7: An error occurred during the life of the file system</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">argc</td><td>the argument counter passed to the main() function </td></tr>
<tr><td class="paramname">argv</td><td>the argument vector passed to the main() function </td></tr>
<tr><td class="paramname">op</td><td>the file system operation </td></tr>
<tr><td class="paramname">private_data</td><td>Initial value for the <code>private_data</code> field of <code>struct <a class="el" href="structfuse__context.html">fuse_context</a></code>. May be overridden by the <code>struct <a class="el" href="structfuse__operations.html#a3a1f9562a38871caaf4fc2de7ea5b470">fuse_operations.init</a></code> handler. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, nonzero on failure</dd></dl>
<p>Example usage, see hello.c </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l00899">899</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<a id="af335784cf29289c7583f3312d98d2bcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af335784cf29289c7583f3312d98d2bcd">◆ </a></span>FUSE_REGISTER_MODULE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_REGISTER_MODULE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name_, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">factory_ </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>    <a class="el" href="include_2fuse_8h.html#ab92480001ec4f475a082cbd32bee94e2">fuse_module_factory_t</a> fuse_module_ ## name_ ## _factory = factory_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Register filesystem module</p>
<p>If the "-omodules=*name*_:..." option is present, filesystem objects are created and pushed onto the stack with the <em>factory_</em> function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name_</td><td>the name of this filesystem module </td></tr>
<tr><td class="paramname">factory_</td><td>the factory function for this filesystem module </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l01306">1306</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a7dd132de66a5cc2add2a4eff5d435660"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dd132de66a5cc2add2a4eff5d435660">◆ </a></span>fuse_fill_dir_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* fuse_fill_dir_t) (void *buf, const char *name, const struct stat *stbuf, off_t off, enum <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568">fuse_fill_dir_flags</a> flags)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to add an entry in a readdir() operation</p>
<p>The <em>off</em> parameter can be any non-zero value that enables the filesystem to identify the current point in the directory stream. It does not need to be the actual physical position. A value of zero is reserved to indicate that seeking in directories is not supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>the buffer passed to the readdir() operation </td></tr>
<tr><td class="paramname">name</td><td>the file name of the directory entry </td></tr>
<tr><td class="paramname">stbuf</td><td>file attributes, can be NULL </td></tr>
<tr><td class="paramname">off</td><td>offset of the next entry or zero </td></tr>
<tr><td class="paramname">flags</td><td>fill flags </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if buffer is full, zero otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l00085">85</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<a id="ab92480001ec4f475a082cbd32bee94e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab92480001ec4f475a082cbd32bee94e2">◆ </a></span>fuse_module_factory_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct fuse_fs*(* fuse_module_factory_t) (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, struct fuse_fs *fs[])</td>
</tr>
</table>
</div><div class="memdoc">
<p>Factory for creating filesystem objects</p>
<p>The function may use and remove options from 'args' that belong to this module.</p>
<p>For now the 'fs' vector always contains exactly one filesystem. This is the filesystem which will be below the newly created filesystem in the stack.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>the command line arguments </td></tr>
<tr><td class="paramname">fs</td><td>NULL terminated filesystem object vector </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the new filesystem object </dd></dl>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l01277">1277</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="af1d0194d186240ef6aaf6e9bf8568568"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d0194d186240ef6aaf6e9bf8568568">◆ </a></span>fuse_fill_dir_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af1d0194d186240ef6aaf6e9bf8568568">fuse_fill_dir_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Readdir flags, passed to fuse_fill_dir_t callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153"></a>FUSE_FILL_DIR_PLUS </td><td class="fielddoc"><p>"Plus" mode: all file attributes are valid</p>
<p>The attributes are used by the kernel to prefill the inode cache during a readdir.</p>
<p>It is okay to set FUSE_FILL_DIR_PLUS if FUSE_READDIR_PLUS is not set and vice versa. </p>
</td></tr>
<tr><td class="fieldname"><a id="af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153"></a>FUSE_FILL_DIR_PLUS </td><td class="fielddoc"><p>"Plus" mode: all file attributes are valid</p>
<p>The attributes are used by the kernel to prefill the inode cache during a readdir.</p>
<p>It is okay to set FUSE_FILL_DIR_PLUS if FUSE_READDIR_PLUS is not set and vice versa. </p>
</td></tr>
<tr><td class="fieldname"><a id="af1d0194d186240ef6aaf6e9bf8568568a3f50d11935fe96eb4df6ff0844c4e153"></a>FUSE_FILL_DIR_PLUS </td><td class="fielddoc"><p>"Plus" mode: all file attributes are valid</p>
<p>The attributes are used by the kernel to prefill the inode cache during a readdir.</p>
<p>It is okay to set FUSE_FILL_DIR_PLUS if FUSE_READDIR_PLUS is not set and vice versa. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l00057">57</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<a id="af2bcf2a473b41b3cc8da8c079656a074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2bcf2a473b41b3cc8da8c079656a074">◆ </a></span>fuse_readdir_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#af2bcf2a473b41b3cc8da8c079656a074">fuse_readdir_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Readdir flags, passed to ->readdir() </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441"></a>FUSE_READDIR_PLUS </td><td class="fielddoc"><p>"Plus" mode.</p>
<p>The kernel wants to prefill the inode cache during readdir. The filesystem may honour this by filling in the attributes and setting FUSE_FILL_DIR_FLAGS for the filler function. The filesystem may also just ignore this flag completely. </p>
</td></tr>
<tr><td class="fieldname"><a id="af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441"></a>FUSE_READDIR_PLUS </td><td class="fielddoc"><p>"Plus" mode.</p>
<p>The kernel wants to prefill the inode cache during readdir. The filesystem may honour this by filling in the attributes and setting FUSE_FILL_DIR_FLAGS for the filler function. The filesystem may also just ignore this flag completely. </p>
</td></tr>
<tr><td class="fieldname"><a id="af2bcf2a473b41b3cc8da8c079656a074ad62ab7c23f966a76282921e9187ca441"></a>FUSE_READDIR_PLUS </td><td class="fielddoc"><p>"Plus" mode.</p>
<p>The kernel wants to prefill the inode cache during readdir. The filesystem may honour this by filling in the attributes and setting FUSE_FILL_DIR_FLAGS for the filler function. The filesystem may also just ignore this flag completely. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="include_2fuse_8h_source.html#l00042">42</a> of file <a class="el" href="include_2fuse_8h_source.html">fuse.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a90f104e6d4e01480161a3300bddbecbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90f104e6d4e01480161a3300bddbecbe">◆ </a></span>fuse_clean_cache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_clean_cache </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>fuse</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterate over cache removing stale entries use in conjunction with "-oremember"</p>
<p>NOTE: This is already done for the standard sessions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fuse</td><td>struct fuse pointer for fuse instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of seconds until the next cleanup </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04381">4381</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a0d47cac8a295efd5370d7af059e4d14f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d47cac8a295efd5370d7af059e4d14f">◆ </a></span>fuse_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_destroy </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the FUSE handle.</p>
<p>NOTE: This function does not unmount the filesystem. If this is needed, call <a class="el" href="fuse-3_813_80_2include_2fuse_8h.html#aade4d93e323c341fe2859d759e9cb8d8">fuse_unmount()</a> before calling this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>the FUSE handle </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l05042">5042</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a9024935b211288c1869dc7566895d739"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9024935b211288c1869dc7566895d739">◆ </a></span>fuse_exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_exit </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag session as terminated</p>
<p>This function will cause any running event loops to exit on the next opportunity.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>the FUSE handle </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04587">4587</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a74883ac07b1794da7affbd95251d25d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74883ac07b1794da7affbd95251d25d7">◆ </a></span>fuse_fs_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct fuse_fs* fuse_fs_new </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> * </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>op_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>private_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new fuse filesystem object</p>
<p>This is usually called from the factory of a fuse module to create a new instance of a filesystem.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>the filesystem operations </td></tr>
<tr><td class="paramname">op_size</td><td>the size of the <a class="el" href="structfuse__operations.html">fuse_operations</a> structure </td></tr>
<tr><td class="paramname">private_data</td><td>Initial value for the <code>private_data</code> field of <code>struct <a class="el" href="structfuse__context.html">fuse_context</a></code>. May be overridden by the <code>struct <a class="el" href="structfuse__operations.html#a3a1f9562a38871caaf4fc2de7ea5b470">fuse_operations.init</a></code> handler. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new filesystem object </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04797">4797</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a9a0f2a6603cb1e21f5e4c1aec84a3bcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a0f2a6603cb1e21f5e4c1aec84a3bcc">◆ </a></span>fuse_get_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structfuse__context.html">fuse_context</a>* fuse_get_context </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current context</p>
<p>The context is only valid for the duration of a filesystem operation, and thus must not be stored and used later.</p>
<dl class="section return"><dt>Returns</dt><dd>the context </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04592">4592</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a03baa193b5bfcbe625afbc62e9b97e91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03baa193b5bfcbe625afbc62e9b97e91">◆ </a></span>fuse_get_session()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct fuse_session* fuse_get_session </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get session from fuse object </p>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04468">4468</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a04273db088e57d8242caa388193b6958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04273db088e57d8242caa388193b6958">◆ </a></span>fuse_getgroups()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_getgroups </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gid_t </td>
<td class="paramname"><em>list</em>[] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current supplementary group IDs for the current request</p>
<p>Similar to the getgroups(2) system call, except the return value is always the total number of group IDs, even if it is larger than the specified size.</p>
<p>The current fuse kernel module in linux (as of 2.6.30) doesn't pass the group list to userspace, hence this function needs to parse "/proc/$TID/task/$TID/status" to get the group IDs.</p>
<p>This feature may not be supported on all operating systems. In such a case this function will return -ENOSYS.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>size of given array </td></tr>
<tr><td class="paramname">list</td><td>array of group IDs to be filled in </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the total number of supplementary group IDs or -errno on failure </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04602">4602</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a0514ca828e6a02a330dcf037292c8803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0514ca828e6a02a330dcf037292c8803">◆ </a></span>fuse_interrupted()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_interrupted </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the current request has already been interrupted</p>
<dl class="section return"><dt>Returns</dt><dd>1 if the request has been interrupted, 0 otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04611">4611</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a56c1dfbdfaf10818dbc6c2ca6264f19a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56c1dfbdfaf10818dbc6c2ca6264f19a">◆ </a></span>fuse_invalidate_path()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_invalidate_path </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalidates cache for the given path.</p>
<p>This calls fuse_lowlevel_notify_inval_inode internally.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on successful invalidation, negative error value otherwise. This routine may return -ENOENT to indicate that there was no entry to be invalidated, e.g., because the path has not been seen before or has been forgotten; this should not be considered to be an error. </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04621">4621</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a9cef8443ae22c4bcc800d7c45f1496fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cef8443ae22c4bcc800d7c45f1496fe">◆ </a></span>fuse_lib_help()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_lib_help </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print available options (high- and low-level) to stdout. This is not an exhaustive list, but includes only those options that may be of interest to an end-user of a file system.</p>
<p>The function looks at the argument vector only to determine if there are additional modules to be loaded (module=foo option), and attempts to call their help functions as well.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>the argument vector. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04687">4687</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a6ea805c47ccc960497dfd64e12081159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ea805c47ccc960497dfd64e12081159">◆ </a></span>fuse_loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_loop </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FUSE event loop.</p>
<p>Requests from the kernel are processed, and the appropriate operations are called.</p>
<p>For a description of the return value and the conditions when the event loop exits, refer to the documentation of <a class="el" href="fuse-3_813_80_2include_2fuse__lowlevel_8h.html#a5f1e538aa3287e251afbe985438c4249">fuse_session_loop()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>the FUSE handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>see <a class="el" href="fuse-3_813_80_2include_2fuse__lowlevel_8h.html#a5f1e538aa3287e251afbe985438c4249">fuse_session_loop()</a></dd></dl>
<p>See also: fuse_loop_mt() </p>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04525">4525</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="adf072472df42e07a8874b570af8e4aaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf072472df42e07a8874b570af8e4aaa">◆ </a></span>fuse_main_real()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_main_real </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> * </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>op_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>private_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The real main function</p>
<p>Do not call this directly, use <a class="el" href="include_2fuse_8h.html#ac99b844cee7aaa8fb4e35df5b5488d82">fuse_main()</a> </p>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2helper_8c_source.html#l00308">308</a> of file <a class="el" href="fuse-3_813_80_2lib_2helper_8c_source.html">helper.c</a>.</p>
</div>
</div>
<a id="a04baffd979b06663ae9590e34a48b55f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04baffd979b06663ae9590e34a48b55f">◆ </a></span>fuse_mount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_mount </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mountpoint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mount a FUSE file system.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mountpoint</td><td>the mount point path </td></tr>
<tr><td class="paramname">f</td><td>the FUSE handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on failure. </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l05092">5092</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a58735a16d34acab7e0c540e9c1f51403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58735a16d34acab7e0c540e9c1f51403">◆ </a></span>fuse_new_31()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct fuse* fuse_new_31 </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structfuse__operations.html">fuse_operations</a> * </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>op_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new FUSE filesystem.</p>
<p>This function accepts most file-system independent mount options (like context, nodev, ro - see mount(8)), as well as the FUSE-specific mount options from mount.fuse(8).</p>
<p>If the –help option is specified, the function writes a help text to stdout and returns NULL.</p>
<p>Option parsing skips argv[0], which is assumed to contain the program name. This element must always be present and is used to construct a basic <code>usage:</code> message for the –help output. If argv[0] is set to the empty string, no usage message is included in the –help output.</p>
<p>If an unknown option is passed in, an error message is written to stderr and the function returns NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>argument vector </td></tr>
<tr><td class="paramname">op</td><td>the filesystem operations </td></tr>
<tr><td class="paramname">op_size</td><td>the size of the <a class="el" href="structfuse__operations.html">fuse_operations</a> structure </td></tr>
<tr><td class="paramname">private_data</td><td>Initial value for the <code>private_data</code> field of <code>struct <a class="el" href="structfuse__context.html">fuse_context</a></code>. May be overridden by the <code>struct <a class="el" href="structfuse__operations.html#a3a1f9562a38871caaf4fc2de7ea5b470">fuse_operations.init</a></code> handler. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created FUSE handle </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04865">4865</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="a9e8c9af40b22631f9f2636019cd073b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e8c9af40b22631f9f2636019cd073b6">◆ </a></span>fuse_open_channel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_open_channel </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mountpoint</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a FUSE file descriptor and set up the mount for the given mountpoint and flags.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mountpoint</td><td>reference to the mount in the file system </td></tr>
<tr><td class="paramname">options</td><td>mount options </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the FUSE file descriptor or -1 upon error </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2helper_8c_source.html#l00461">461</a> of file <a class="el" href="fuse-3_813_80_2lib_2helper_8c_source.html">helper.c</a>.</p>
</div>
</div>
<a id="a4b2246caec521ec4ac84093f8c4b616d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2246caec521ec4ac84093f8c4b616d">◆ </a></span>fuse_start_cleanup_thread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_start_cleanup_thread </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>fuse</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the cleanup thread when using option "remember".</p>
<p>This is done automatically by fuse_loop_mt() </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fuse</td><td>struct fuse pointer for fuse instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success and -1 on error </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04845">4845</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="ad37fd69ba40d5c261f16e207e4a5b0ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad37fd69ba40d5c261f16e207e4a5b0ed">◆ </a></span>fuse_stop_cleanup_thread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_stop_cleanup_thread </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>fuse</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop the cleanup thread when using option "remember".</p>
<p>This is done automatically by fuse_loop_mt() </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fuse</td><td>struct fuse pointer for fuse instance </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l04853">4853</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
<a id="aade4d93e323c341fe2859d759e9cb8d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aade4d93e323c341fe2859d759e9cb8d8">◆ </a></span>fuse_unmount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_unmount </td>
<td>(</td>
<td class="paramtype">struct fuse * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unmount a FUSE file system.</p>
<p>See <a class="el" href="fuse-3_813_80_2include_2fuse__lowlevel_8h.html#a6c10d942751ddb214863a8b5e53de5e8">fuse_session_unmount()</a> for additional information.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>the FUSE handle </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html#l05097">5097</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse_8c_source.html">fuse.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
