1STAPPROBES.NFS(5) File Formats Manual STAPPROBES.NFS(5)
2
3
4
6 stapprobes.nfs - systemtap NFS client side probe points
7
8
9
11 This family of probe points is used to probe NFS activities on client
12 side. It contains the following probe points:
13
14
15 nfs.fop.llseek
16
17 Fires whenever doing a llseek operation on nfs client side
18
19 Arguments:
20
21 dev
22 device identifier
23
24 ino
25 inode number
26
27 s_id
28 the pointer to s_id
29
30 devname
31 the combination of server ip and the name of block device
32 on server
33
34 maxbyte
35 Maximum size of the files
36
37 offset
38 the offset of file to be repositioned
39
40 origin
41 the original position. The possible value could be:
42 SEEK_SET
43 The offset is set to offset bytes.
44 SEEK_CUR
45 The offset is set to its current location
46 plus offset bytes.
47 SEEK_END
48 The offset is set to the size of the file
49 plus offset bytes.
50
51
52 nfs.fop.llseek.return
53
54 Fires whenever nfs llseek operation is done
55
56 Arguments:
57
58 retstr
59 resulting offset location
60
61
62 nfs.fop.read
63
64 Fires whenever doing a read operation on nfs client side
65
66 Arguments:
67
68 dev
69 device identifier
70
71 ino
72 inode number
73
74 s_id
75 the pointer to s_id
76
77 devname
78 the combination of server ip and the name of block device
79 on server
80
81 len,size
82 number of bytes to be read
83
84 pos
85 current file offset
86
87 buf
88 the buf address
89
90
91 nfs.fop.read.return
92
93 Fires whenever nfs read operation is done
94
95 Arguments:
96
97 size
98 number of bytes read
99
100
101 nfs.fop.write
102
103 Fires whenever doing a write operation on nfs client side
104
105 Arguments:
106
107 dev
108 device identifier
109
110 ino
111 inode number
112
113 s_id
114 the pointer to s_id
115
116 devname
117 the combination of server ip and the name of block device
118 on server
119
120 len,size
121 number of bytes to written
122
123 pos
124 current file offset
125
126 buf
127 the buf address
128
129
130 nfs.fop.write.return
131
132 Fires whenever nfs write operation is done
133
134 Arguments:
135
136 size
137 number of bytes written
138
139
140 nfs.fop.aio_read
141
142 Fires whenever doing an aio_read operation on nfs client side
143
144 Arguments:
145
146 dev
147 device identifier
148
149 ino
150 inode number
151
152 s_id
153 the pointer to s_id
154
155 devname
156 the combination of server ip and the name of block device
157 on server
158
159 count,size
160 number of bytes to be read
161
162 pos
163 current file offset
164
165 buf
166 the buf address
167
168 parent_name
169 parent dir name
170
171 file_name
172 file name
173
174 cache_valid
175 cache related bit mask flag
176
177 cache_time
178 when we started read-caching this inode
179
180 attrtimeo
181 how long the cached information is assumed to be valid.
182
183 The cached attrs for this inode needed to be revalidated if
184 jiffies - read_cache_jiffies > attrtime
185
186
187 nfs.fop.aio_read.return
188
189 Fires whenever nfs aio_read operation is done
190
191 Arguments:
192
193 size
194 number of bytes read
195
196
197 nfs.fop.aio_write
198
199 Fires whenever doing an aio_write operation on nfs client side
200
201 Arguments:
202
203 dev
204 device identifier
205
206 ino
207 inode number
208
209 s_id
210 the pointer to s_id
211
212 devname
213 the combination of server ip and the name of block device
214 on server
215
216 count,size
217 number of bytes to written
218
219 pos
220 current file offset
221
222 buf
223 the buf address
224
225 parent_name
226 parent dir name
227
228 file_name
229 file name
230
231
232 nfs.fop.aio_write.return
233
234 Fires whenever nfs aio_write operation is done
235
236 Arguments:
237
238 size
239 number of bytes written
240
241
242 nfs.fop.mmap
243
244 Fires whenever doing an mmap operation on nfs client side
245
246 Arguments:
247
248 dev
249 device identifier
250
251 ino
252 inode number
253
254 s_id
255 the pointer to s_id
256
257 devname
258 the combination of server ip and the name of block device
259 on server
260
261 vm_start
262 start address within vm_mm
263
264 vm_end
265 the first byte after end address within vm_mm
266
267 vm_flag
268 vm flags
269
270 parent_name
271 parent dir name
272
273 file_name
274 file name
275
276 cache_valid
277 cache related bit mask flag
278
279 cache_time
280 when we started read-caching this inode
281
282 attrtimeo
283 how long the cached information is assumed to be valid.
284
285 The cached attrs for this inode needed to be revalidated if
286 jiffies - read_cache_jiffies > attrtime
287
288
289 nfs.fop.open
290
291 Fires whenever doing an open operation on nfs client side
292
293 Arguments:
294
295 dev
296 device identifier
297
298 ino
299 inode number
300
301 s_id
302 the pointer to s_id
303
304 devname
305 the combination of server ip and the name of block device
306 on server
307
308 file_name
309 file name
310
311 flag
312 file flag
313
314 i_size
315 file length in bytes
316
317
318 nfs.fop.flush
319
320 Fires whenever doing an flush operation on nfs client side
321
322 Arguments:
323
324 dev
325 device identifier
326
327 ino
328 inode number
329
330 s_id
331 the pointer to s_id
332
333 devname
334 the combination of server ip and the name of block device
335 on server
336
337 mode
338 file mode
339
340 ndirty
341 number of dirty page to be flushed
342
343
344 nfs.fop.release
345
346 Fires whenever doing a release page operation on nfs client side
347
348 Arguments:
349
350 dev
351 device identifier
352
353 ino
354 inode number
355
356 s_id
357 the pointer to s_id
358
359 devname
360 the combination of server ip and the name of block device
361 on server
362
363 mode
364 file mode
365
366
367 nfs.fop.fsync
368
369 Fires whenever doing a fsync operation on nfs client side
370
371 Arguments:
372
373 dev
374 device identifier
375
376 ino
377 inode number
378
379 s_id
380 the pointer to s_id
381
382 devname
383 the combination of server ip and the name of block device
384 on server
385
386 ndirty
387 number of dirty page to be flushed
388
389
390 nfs.fop.lock
391
392 Fires whenever doing a file lock operation on nfs client side
393
394 Arguments:
395
396 dev
397 device identifier
398
399 ino
400 inode number
401
402 s_id
403 the pointer to s_id
404
405 devname
406 the combination of server ip and the name of block device
407 on server
408
409 i_mode
410 file type and access rights
411
412 cmd
413 cmd arguments
414
415 fl_type
416 lock type
417
418 fl_flag
419 lock flags
420
421 fl_start
422 starting offset of locked region
423
424 fl_end
425 ending offset of locked region
426
427
428 nfs.fop.sendfile
429
430 Fires whenever doing a send file operation on nfs client side
431
432 Arguments:
433
434 dev
435 device identifier
436
437 ino
438 inode number
439
440 s_id
441 the pointer to s_id
442
443 devname
444 the combination of server ip and the name of block device
445 on server
446
447 count,size
448 number of bytes to sent
449
450 ppos
451 current file offset
452
453 cache_valid
454 cache related bit mask flag
455
456 cache_time
457 when we started read-caching this inode
458
459 attrtimeo
460 how long the cached information is assumed to be valid.
461
462 The cached attrs for this inode needed to be revalidated if
463 jiffies - read_cache_jiffies > attrtime
464
465
466 nfs.fop.sendfile.return
467
468 Fires whenever nfs sendfile operation is done
469
470 Arguments:
471
472 size
473 number of bytes sent
474
475
476 nfs.fop.check_flags
477
478 Fires whenever doing a check flag operation on nfs client side
479
480 Arguments:
481
482 flags
483 file flag
484
485
486 nfs.aop.readpage
487
488 Fires when a previous async read operation failed
489
490 Arguments:
491
492 __page
493 the address of page
494
495 dev
496 device identifier
497
498 ino
499 inode number
500
501 i_flag
502 file flags
503
504 i_size
505 file length in bytes
506
507 sb_flag
508 super block flags
509
510 file
511 file argument
512
513 page_index
514 offset within mapping
515
516 rsize
517 read size (in bytes)
518
519
520 nfs.aop.readpages
521
522 Fies when in readahead way,read several pages once
523
524 Arguments:
525
526 dev
527 device identifier
528
529 ino
530 inode number
531
532 nr_pages ,size
533 number of pages attempted to read in this execution
534
535 file
536 filp argument
537
538 rpages
539 read size (in pages)
540
541 rsize
542 read size (in bytes)
543
544
545 nfs.aop.readpages.return
546
547 Fies whenever a nfs read pages operation is done
548
549 Arguments:
550
551 size
552 number of pages read
553
554
555 nfs.aop.set_page_dirty
556
557 Fies whenever set page dirty on nfs client side
558
559 Arguments:
560
561 __page
562 the address of page
563
564 page_flag
565 page flags
566
567
568 nfs.aop.writepage
569
570 Fies whenever writing an mapped page to the server from nfs
571 client side
572
573 Arguments:
574
575 __page
576 the address of page
577
578 dev
579 device identifier
580
581 ino
582 inode number
583
584 for_reclaim
585 a flag of writeback_control, indicates if it's invoked from
586 the page allocator
587
588 for_kupdate
589 a flag of writeback_control, indicates if it's a kupdate
590 writeback
591 The priority of wb is decided by above two flags
592
593 i_flag
594 file flags
595
596 i_size
597 file length in bytes
598
599 i_state
600 inode state flags
601
602 sb_flag
603 super block flags
604
605 page_index
606 offset within mapping
607
608 wsize
609 write size
610
611
612 nfs.aop.writepages
613
614 Fies whenever writing several dirty pages to the server from nfs
615 client sides
616
617 Arguments:
618
619 dev
620 device identifier
621
622 ino
623 inode number
624
625 for_reclaim
626 a flag of writeback_control, indicates if it's invoked from
627 the page allocator
628
629 for_kupdate
630 a flag of writeback_control, indicates if it's a kupdate
631 writeback
632 The priority of wb is decided by above two flags
633
634 wpages
635 write size (in pages)
636
637 wsize
638 write size
639
640 nr_to_write ,size
641 number of pages attempted to be written in this execution
642
643
644 nfs.aop.prepare_write
645
646 Fies whenever prepare a page for writting on nfs client sides
647
648 Arguments:
649
650 __page
651 the address of page
652
653 dev
654 device identifier
655
656 ino
657 inode number
658
659 offset
660 start address of this write operation
661
662 to
663 end address of this write operation
664
665 page_index
666 offset within mapping
667
668 size
669 read bytes
670
671
672 nfs.aop.commit_write
673
674 Fies often after prepare write operation
675
676 Arguments:
677
678 __page
679 the address of page
680
681 dev
682 device identifier
683
684 ino
685 inode number
686
687 offset
688 start address of this write operation
689
690 to
691 end address of this write operation
692
693 i_flag
694 file flags
695
696 i_size
697 file length in bytes
698
699 sb_flag
700 super block flag
701
702 page_index
703 offset within mapping
704
705 size
706 read bytes
707
708
709 nfs.aop.release_page
710
711 Arguments:
712
713 __page
714 the address of page
715
716 dev
717 device identifier
718
719 ino
720 inode number
721
722 page_index
723 offset within mapping
724
725
726 nfs.proc.lookup
727
728 Arguments:
729
730 server_ip
731 ip address of server
732
733 prot
734 transfer protocol
735
736 version
737 nfs version
738
739 filename
740 the name of file which client opens/searchs on server
741
742 name_len
743 the length of file name
744
745 bitmask0, bitmask1
746 V4 bitmask representing the set of attributes
747 supported on this filesystem (only in probe nfs.proc4.lookup)
748
749
750 nfs.proc.read
751
752 Fires when client synchronously reads file from server
753
754 Arguments:
755
756 server_ip
757 ip address of server
758
759 prot
760 transfer protocol
761
762 version
763 nfs version
764
765 flags
766 used to set task->tk_flags in rpc_init_task function
767
768 size,count
769 number of bytes to be read in this execution
770
771 offset
772 the file offset
773
774
775 nfs.proc.read.return
776
777 Fires when synchronously reading file from server is done
778
779 Arguments:
780
781 size
782 number of bytes read
783
784
785 nfs.proc.write
786
787 Fires when client synchronously writes file to server
788
789 Arguments:
790
791 server_ip
792 ip address of server
793
794 prot
795 transfer protocol
796
797 version
798 nfs version
799
800 flags
801 used to set task->tk_flags in rpc_init_task function
802
803 size,count
804 number of bytes to be written in this execution
805
806 offset
807 the file offset
808
809 bitmask0, bitmask1
810 V4 bitmask representing the set of attributes
811 supported on this filesystem (only in probe nfs.proc4.lookup)
812
813
814 nfs.proc.write.return
815
816 Fires when synchronously writting file from server is done
817
818 Arguments:
819
820 size
821 number of bytes written
822
823
824 nfs.proc.commit
825
826 Fires when client writes the buffered data to disk,the buffered
827 data is asynchronously written by client before(not exist in
828 NFSV2)
829
830 Arguments:
831
832 server_ip
833 ip address of server
834
835 prot
836 transfer protocol
837
838 version
839 nfs version
840
841 size,count
842 number of bytes to be written in this execution
843
844 offset
845 the file offset
846
847 bitmask0, bitmask1
848 V4 bitmask representing the set of attributes
849 supported on this filesystem (only in probe nfs.proc4.lookup)
850
851
852 nfs.proc.commit.return
853
854 Fires when committing operation is done
855
856 Arguments:
857
858 size
859 number of bytes written
860
861
862 nfs.proc.read_setup
863
864 Fires when client asynchronously reads file from server, this
865 function is used to setup a read rpc task,not do a real read
866 operation.
867
868 Arguments:
869
870 server_ip
871 ip address of server
872
873 prot
874 transfer protocol
875
876 version
877 nfs version
878
879 size,count
880 number of bytes to be read in this execution
881
882 offset
883 the file offset
884
885
886 nfs.proc.read_done
887
888 Fires when a read reply is received or some read error occur
889 (timeout or socket shutdown)
890
891 Arguments:
892
893 server_ip
894 ip address of server
895
896 prot
897 transfer protocol
898
899 version
900 nfs version
901
902 status
903 result of last async read operation
904
905 count
906 number of bytes read
907
908 timestamp
909 time stamp ,which is used for lease renewal (only
910 in nfs.proc4.read_done)
911
912
913 nfs.proc.write_setup
914
915 Fires when client asynchronously write data to server, this
916 function is used to setup a write rpc task,not do a write read
917 operation.
918
919 Arguments:
920
921 server_ip
922 ip address of server
923
924 prot
925 transfer protocol
926
927 version
928 nfs version
929
930 size,count
931 number of bytes to be written in this execution
932
933 offset
934 the file offset
935
936 how
937 used to set args.stable,The possible value could be:
938 NFS_UNSTABLE,
939 NFS_DATA_SYNC,
940 NFS_FILE_SYNC
941 (only in nfs.proc3.write_setup and
942 nfs.proc4.write_setup)
943
944 bitmask0, bitmask1
945 V4 bitmask representing the set of attributes supported
946 on this filesystem (only in probe nfs.proc4.write_setup)
947
948
949 nfs.proc.write_done
950
951 Fires when a write reply is received or some write error occur
952 (timeout or socket shutdown)
953
954 Arguments:
955
956 server_ip
957 ip address of server
958
959 prot
960 transfer protocol
961
962 version
963 nfs version
964
965 status
966 result of last async write operation
967
968 valid
969 fattr->valid ,indicates which fields are valid
970
971 count
972 number of bytes written
973
974 timestamp
975 time stamp ,which is used for lease renewal (only
976 in nfs.proc4.read_done)
977
978
979 nfs.proc.commit_setup
980
981 Fires when client asynchronously do a commit operation, this
982 function is used to setup a commit rpc task,not do a commit read
983 operation.
984
985 Arguments:
986
987 server_ip
988 ip address of server
989
990 prot
991 transfer protocol
992
993 version
994 nfs version
995
996 size,count
997 number of bytes to be written in this execution
998
999 offset
1000 the file offset
1001
1002 bitmask0, bitmask1
1003 V4 bitmask representing the set of attributes supported
1004 on this filesystem (only in probe nfs.proc4.commit_setup)
1005
1006
1007 nfs.proc.commit_done
1008
1009 Fires when a commit reply is received or some commit error occur
1010 (timeout or socket shutdown)
1011
1012 Arguments:
1013
1014 server_ip
1015 ip address of server
1016
1017 prot
1018 transfer protocol
1019
1020 version
1021 nfs version
1022
1023 status
1024 result of last async write operation
1025
1026 valid
1027 fattr->valid ,indicates which fields are valid
1028
1029 count
1030 number of bytes written
1031
1032 timestamp
1033 time stamp ,which is used for lease renewal (only
1034 in nfs.proc4.read_done)
1035
1036
1037 nfs.proc.open
1038
1039 Fires whenever doing a open operation on nfs client side, the
1040 nfs_open function is used to allocate file read/write context
1041 information
1042
1043 Arguments:
1044
1045 server_ip
1046 ip address of server
1047
1048 prot
1049 transfer protocol
1050
1051 version
1052 nfs version
1053
1054 filename
1055 file name
1056
1057 flag
1058 file flag
1059
1060 mode
1061 file mode
1062
1063
1064 nfs.proc.release
1065
1066 Fires whenever doing a release operation on nfs client side,
1067
1068 Arguments:
1069
1070 server_ip
1071 ip address of server
1072
1073 prot
1074 transfer protocol
1075
1076 version
1077 nfs version
1078
1079 filename
1080 file name
1081
1082 flag
1083 file flag
1084
1085 mode
1086 file mode
1087
1088
1089 nfs.proc4.handle_exception
1090
1091 Fires whenever doing the error handling, only exist in NFSV4
1092
1093 errorcode
1094 error code
1095
1096
1097 nfs.proc.create
1098
1099 Fires whenever nfs client creates a file on server
1100
1101 Arguments:
1102
1103 server_ip
1104 ip address of server
1105
1106 prot
1107 transfer protocol
1108
1109 version
1110 nfs version
1111
1112 fh
1113 file handler of parent dir
1114
1115 filename
1116 file name
1117
1118 filelen
1119 length of file name
1120
1121 flag
1122 indicates create mode(only for NFSV3 and NFSV4)
1123
1124
1125 nfs.proc.remove
1126
1127 Fires whenever nfs client removes a file from server
1128
1129 Arguments:
1130
1131 server_ip
1132 ip address of server
1133
1134 prot
1135 transfer protocol
1136
1137 version
1138 nfs version
1139
1140 fh
1141 file handler of parent dir
1142
1143 filename
1144 file name
1145
1146 filelen
1147 length of file name
1148
1149
1150 nfs.proc.rename
1151
1152 Fires whenever nfs client renames a file on server
1153
1154 Arguments:
1155
1156 server_ip
1157 ip address of server
1158
1159 prot
1160 transfer protocol
1161
1162 version
1163 nfs version
1164
1165 old_fh
1166 file handler of old parent dir
1167
1168 old_name
1169 old file name
1170
1171 old_filelen
1172 length of old file name
1173
1174 new_fh
1175 file handler of new parent dir
1176
1177 new_name
1178 new file name
1179
1180 new_filelen
1181 length of new file name
1182
1183
1185 stap(1), stapprobes(5),
1186
1187
1188
1189
1190IBM 2008-03-27 STAPPROBES.NFS(5)