summaryrefslogtreecommitdiffstats
path: root/man/stapprobes.nfs.3stap.in
blob: 14404b96b28e9691735af28a2fed5b8ec99b8359 (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
.\" -*- nroff -*-
.TH STAPPROBES.NFS 3stap @DATE@ "IBM"
.SH NAME
stapprobes.nfs \- systemtap NFS client side probe points

.\" macros
.de SAMPLE
.br
.RS
.nf
.nh
..
.de ESAMPLE
.hy
.fi
.RE
..

.SH DESCRIPTION

This family of probe points is used to probe NFS activities on 
client side.
It contains the following probe points:

.P
.TP
.B nfs.fop.llseek 

Fires whenever doing a llseek operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I maxbyte
  Maximum size of the files

.I offset
  the offset of file to be repositioned 

.I origin
  the original position. The possible value could be:
          SEEK_SET
                The offset is set to offset bytes.
          SEEK_CUR
                The offset is set to its current location 
                plus offset bytes.
          SEEK_END
                The offset is set to the size of the file 
                plus offset bytes.

.P
.TP
.B nfs.fop.llseek.return

Fires whenever nfs llseek operation is done

.B Arguments:

.I retstr 
   resulting offset location 

.P
.TP
.B nfs.fop.read

Fires whenever doing a read operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I len,size
  number of bytes to be read

.I pos 
  current file offset 	

.I buf 
  the buf address 

.P
.TP
.B nfs.fop.read.return

Fires whenever nfs read operation is done

.B Arguments:

.I size 
  number of bytes read

.P
.TP
.B nfs.fop.write

Fires whenever doing a write operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I len,size
  number of bytes to written

.I pos 
  current file offset 	

.I buf 
  the buf address 

.P
.TP
.B nfs.fop.write.return

Fires whenever nfs write operation is done

.B Arguments:

.I size 
  number of bytes written 

.P
.TP
.B nfs.fop.aio_read

Fires whenever doing an aio_read operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I count,size
  number of bytes to be read 

.I pos 
  current file offset 	

.I buf 
  the buf address

.I parent_name 
  parent dir name

.I file_name
  file name

.I cache_valid 
  cache related bit mask flag

.I cache_time 
  when we started read-caching this inode

.I attrtimeo 
  how long the cached information is assumed to be valid.

  The cached attrs for this inode needed to be revalidated if
     jiffies \- read_cache_jiffies > attrtime

.P
.TP
.B nfs.fop.aio_read.return

Fires whenever nfs aio_read operation is done

.B Arguments:

.I size 
  number of bytes read 

.P
.TP
.B nfs.fop.aio_write

Fires whenever doing an aio_write operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I count,size
  number of bytes to written

.I pos 
  current file offset 	

.I buf 
  the buf address

.I parent_name 
  parent dir name

.I file_name
  file name

.P
.TP
.B nfs.fop.aio_write.return

Fires whenever nfs aio_write operation is done

.B Arguments:

.I size 
  number of bytes written 

.P
.TP
.B nfs.fop.mmap

Fires whenever doing an mmap operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I vm_start
  start address within vm_mm 

.I vm_end
  the first byte after end address within vm_mm

.I vm_flag  
  vm flags

.I parent_name 
  parent dir name

.I file_name
  file name

.I cache_valid 
  cache related bit mask flag

.I cache_time 
  when we started read-caching this inode

.I attrtimeo 
  how long the cached information is assumed to be valid.

  The cached attrs for this inode needed to be revalidated if
     jiffies \- read_cache_jiffies > attrtime

.P
.TP
.B nfs.fop.open

Fires whenever doing an open operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I file_name
  file name

.I flag
  file flag

.I i_size
  file length in bytes

.P
.TP
.B nfs.fop.flush

Fires whenever doing an flush operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I mode  
  file mode 

.I ndirty 
  number of dirty page to be flushed

.P
.TP
.B nfs.fop.release

Fires whenever doing a release page operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I mode  
  file mode 

.P
.TP
.B nfs.fop.fsync

Fires whenever doing a fsync operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I ndirty 
  number of dirty page to be flushed

.P
.TP
.B nfs.fop.lock

Fires whenever doing a file lock operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I i_mode 
  file type and access rights

.I cmd 
  cmd arguments

.I fl_type 
  lock type

.I fl_flag 
  lock flags

.I fl_start 
  starting offset of locked region 

.I fl_end   
  ending offset of locked region
 
.P
.TP
.B nfs.fop.sendfile

Fires whenever doing a send file operation on nfs client side

.B Arguments:

.I dev 
  device identifier 

.I ino 
  inode number

.I s_id
  the pointer to s_id

.I devname 
  the combination of server ip and the name of block device 
  on server

.I count,size
  number of bytes to sent 

.I ppos 
  current file offset 	

.I cache_valid 
  cache related bit mask flag

.I cache_time 
  when we started read-caching this inode

.I attrtimeo 
  how long the cached information is assumed to be valid.

  The cached attrs for this inode needed to be revalidated if
     jiffies \- read_cache_jiffies > attrtime

.P
.TP
.B nfs.fop.sendfile.return

Fires whenever nfs sendfile operation is done

.B Arguments:

.I size 
  number of bytes sent

.P
.TP
.B nfs.fop.check_flags

Fires whenever doing a check flag operation on nfs client side

.B Arguments:

.I flags
  file flag

.P
.TP
.B nfs.aop.readpage

Fires when a previous async read operation failed

.B Arguments:

.I __page 
  the address of page

.I dev 
  device identifier

.I ino 
  inode number    

.I i_flag 
  file flags

.I i_size 
  file length in bytes

.I sb_flag 
  super block flags

.I file 
  file argument

.I page_index 
  offset within mapping

.I rsize 
   read size  (in bytes)

.P
.TP
.B nfs.aop.readpages

Fires when in readahead way, read several pages once

.B Arguments:

.I dev 
  device identifier

.I ino 
  inode number    

.I nr_pages ,size 
  number of pages attempted to read in this execution 

.I file 
  filp argument

.I rpages 
  read size (in pages) 

.I rsize  
  read size (in bytes)

.P
.TP
.B nfs.aop.readpages.return

Fires whenever a nfs read pages operation is done

.B Arguments:

.I size 
  number of pages read

.P
.TP
.B nfs.aop.set_page_dirty

Fires whenever set page dirty on nfs client side

.B Arguments:

.I __page
  the address of page

.I page_flag
  page flags

.P
.TP
.B nfs.aop.writepage

Fires whenever writing an mapped page to the server from nfs client side

.B Arguments:

.I __page 
  the address of page

.I dev 
  device identifier

.I ino 
  inode number  

.I for_reclaim 
  a flag of writeback_control, indicates if it's invoked from the page allocator 

.I for_kupdate 
  a flag of writeback_control, indicates if it's a kupdate writeback
  The priority of wb is decided by above two flags

.I i_flag 
  file flags

.I i_size 
  file length in bytes

.I i_state 
  inode state flags

.I sb_flag 
  super block flags

.I page_index 
  offset within mapping

.I wsize 
  write size

.P
.TP
.B nfs.aop.writepages

Fires whenever writing several dirty pages to the server from nfs client sides

.B Arguments:

.I dev 
  device identifier

.I ino 
  inode number  

.I for_reclaim 
  a flag of writeback_control, indicates if it's invoked from the page allocator 

.I for_kupdate 
  a flag of writeback_control, indicates if it's a kupdate writeback
  The priority of wb is decided by above two flags

.I wpages 
   write size (in pages)

.I wsize 
  write size

.I nr_to_write ,size
  number of pages attempted to be written in this execution  

.P
.TP
.B nfs.aop.prepare_write

Fires whenever prepare a page for writing on nfs client sides

.B Arguments:

.I __page
  the address of page

.I dev 
  device identifier

.I ino 
  inode number  

.I offset
  start address of this write operation 

.I to     
  end address of this write operation 

.I page_index 
  offset within mapping 

.I size   
  read bytes

.P
.TP
.B nfs.aop.commit_write

Fires often after prepare write operation

.B Arguments:

.I __page
  the address of page

.I dev 
  device identifier

.I ino 
  inode number  

.I offset
  start address of this write operation 

.I to     
  end address of this write operation 

.I i_flag 
  file flags

.I i_size 
  file length in bytes

.I sb_flag 
  super block flag

.I page_index 
  offset within mapping 

.I size   
  read bytes

.P
.TP
.B nfs.aop.release_page

.B Arguments:

.I __page 
  the address of page

.I dev 
  device identifier

.I ino 
  inode number

.I page_index 
  offset within mapping 

.P
.TP
.B nfs.proc.lookup

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I filename 
  the name of  file which client opens/searches on server

.I name_len 
  the length of file name

.I bitmask0, bitmask1 
  V4 bitmask representing the set of attributes 
  supported on this filesystem (only in probe nfs.proc4.lookup)

.P
.TP
.B nfs.proc.read

Fires when client synchronously reads file from server

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I flags  
  used to set task\->tk_flags in rpc_init_task function

.I size,count 
  number of bytes to be read in this execution

.I offset 
  the file offset

.P
.TP
.B nfs.proc.read.return

Fires when synchronously reading file from server is done

.B Arguments:

.I size 
  number of bytes read

.P
.TP
.B nfs.proc.write

Fires when client synchronously writes file to server

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I flags  
  used to set task\->tk_flags in rpc_init_task function

.I size,count 
  number of  bytes to be written in this execution

.I offset 
  the file offset

.I bitmask0, bitmask1 
  V4 bitmask representing the set of attributes 
  supported on this filesystem (only in probe nfs.proc4.lookup)

.P
.TP
.B nfs.proc.write.return

Fires when synchronously writing file from server is done

.B Arguments:

.I size 
  number of bytes written 

.P
.TP
.B nfs.proc.commit

Fires when client writes the buffered data to disk, the buffered 
data is asynchronously written by client before(not exist in NFSV2)

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I size,count 
  number of  bytes to be written in this execution

.I offset 
  the file offset

.I bitmask0, bitmask1 
  V4 bitmask representing the set of attributes 
  supported on this filesystem (only in probe nfs.proc4.lookup)

.P
.TP
.B nfs.proc.commit.return

Fires when committing operation is done

.B Arguments:

.I size 
  number of bytes written 

.P
.TP
.B nfs.proc.read_setup

Fires when client asynchronously reads file from server,
this function is used to setup a read rpc task, not do
a real read operation.

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I size,count 
  number of  bytes to be read in this execution

.I offset 
  the file offset

.P
.TP
.B nfs.proc.read_done

Fires when a read reply is received or some read error occur
(timeout or socket shutdown)

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I status 
  result of last async read operation 

.I count 
  number of bytes read 

.I timestamp
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

.P
.TP
.B nfs.proc.write_setup

Fires when client asynchronously write data to server,
this function is used to setup a write rpc task, not do
a write read operation.

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I size,count 
  number of  bytes to be written in this execution

.I offset 
  the file offset

.I how
  used to set args.stable, The possible value could be:
          NFS_UNSTABLE,
          NFS_DATA_SYNC,
          NFS_FILE_SYNC
          (only in nfs.proc3.write_setup and nfs.proc4.write_setup)

.I bitmask0, bitmask1 
   V4 bitmask representing the set of attributes supported 
   on this filesystem (only in probe nfs.proc4.write_setup)

.P
.TP
.B nfs.proc.write_done

Fires when a write reply is received or some write error occur
(timeout or socket shutdown)

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I status 
  result of last async write operation 

.I valid  
  fattr\->valid, indicates which fields are valid

.I count 
  number of bytes written 

.I timestamp
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

.P
.TP
.B nfs.proc.commit_setup

Fires when client asynchronously do a commit operation,
this function is used to setup a commit rpc task, not do
a commit read operation.

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I size,count 
  number of  bytes to be written in this execution

.I offset 
  the file offset

.I bitmask0, bitmask1 
   V4 bitmask representing the set of attributes supported 
   on this filesystem (only in probe nfs.proc4.commit_setup)

.P
.TP
.B nfs.proc.commit_done

Fires when a commit reply is received or some commit error occur
(timeout or socket shutdown)

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I status 
  result of last async write operation 

.I valid  
  fattr\->valid, indicates which fields are valid

.I count 
  number of bytes written 

.I timestamp
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

.P
.TP
.B nfs.proc.open

Fires whenever doing a open operation on nfs client side,
the nfs_open function is used to allocate file read/write
context information 

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I filename
  file name

.I flag
  file flag

.I mode
  file mode

.P
.TP
.B nfs.proc.release

Fires whenever doing a release operation on nfs client side,

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I filename
  file name

.I flag
  file flag

.I mode
  file mode

.P
.TP
.B nfs.proc4.handle_exception

Fires whenever doing the error handling, only exist in NFSV4  

.I errorcode 
  error code 

.P
.TP
.B nfs.proc.create

Fires whenever nfs client creates a file on server 

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I fh 
  file handler of parent dir

.I filename 
  file name 

.I filelen 
  length of file name

.I flag 
  indicates create mode(only for NFSV3 and NFSV4)

.P
.TP
.B nfs.proc.remove

Fires whenever nfs client removes a file from server 

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I fh 
  file handler of parent dir

.I filename 
  file name 

.I filelen 
  length of file name

.P
.TP
.B nfs.proc.rename

Fires whenever nfs client renames a file on server 

.B Arguments:

.I server_ip 
  ip address of server

.I prot  
  transfer protocol

.I version 
  nfs version

.I old_fh 
  file handler of old parent dir

.I old_name 
  old file name 

.I old_filelen 
  length of old file name

.I new_fh 
  file handler of new parent dir

.I new_name 
  new file name 

.I new_filelen 
  length of new file name

.SH SEE ALSO
.IR stap (1),
.IR stapprobes (3stap)