summaryrefslogtreecommitdiffstats
path: root/man/stapprobes.nfsd.5.in
blob: 8d30b38be25660dc635d1ddb15f2b0a1468f8bfd (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
.\" -*- nroff -*-
.TH STAPPROBES.NFSD 5 @DATE@ "IBM"
.SH NAME
stapprobes.nfsd \- systemtap NFS server 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 
server side.  Because there is only one function, i.e., nfsd4_proc_compound
in proc level for NFSv4, all the following nfsd.proc probe points except 
nfsd.proc.compound are only for NFSv2 and NFSv3.

It contains the following probe points:

.P
.TP
.B nfsd.proc.lookup

Fires whenever client opens/searchs file on server 

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of parent dir

.I filename
  file name

.I filelen
  the length of file name 

.P
.TP
.B nfsd.proc.read

Fires whenever client reads file on server 

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of file 

.I count,size 
  number of bytes to be read

.I offset 
  the offset of file

.I vec
  struct kvec ,includes buf address in kernel address
  and the length of each buffer

.I vlen 
  number of blocks to be read 

.P
.TP
.B nfsd.proc.write

Fires whenever client writes data to file on server 

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of file 

.I count,size 
  number of bytes to written 

.I offset 
  the offset of file

.I vec
  struct kvec ,includes buf address in kernel address
  and the length of each buffer

.I vlen 
  number of blocks to written 

.I stable 
   argp\->stable(only for nfs.proc3.write)

.P
.TP
.B nfsd.proc.commit

Fires whenever client does a commit operation 

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of file 

.I count,size 
  number of bytes to written 

.I offset 
  the offset of file

.P
.TP
.B nfsd.proc.create

Fires whenever client creates a file on server

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of parent dir 

.I filename
  file name

.I filelen
  the length of file name 

.P
.TP
.B nfsd.proc.remove

Fires whenever client removes a file on server

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of file 

.I filename
  file name

.I filelen
  the length of file name 

.P
.TP
.B nfsd.proc.rename

Fires whenever client renames a file on server

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I fh 
  the pointer to file handler of old path

.I tfh 
  the pointer to file handler of new path

.I filename
  old file name

.I tname
  new file name

.I filelen
  the length of old file name 

.I tlen
  the length of new file name 

.P
.TP
.B nfsd.proc.compound

Fires whenever server receives a NFSV4 operation from client

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I num
  number of file operation  

.I op
  head of operation list

.P
.TP
.B nfsd.open

Fires whenever server opens file

.B Arguments:

.I fh
   file handle (the first part is the length of the file handle)

.I access
  type of open (read/write/commit/readdir...)

.I type
  type of file(regular file or dir)

.P
.TP
.B nfsd.read

Fires whenever server reads file

.B Arguments:

.I fh
   file handle (the first part is the length of the file handle)

.I file
   argument :file, indicates if the file has been opened.

.I count,size 
  number of bytes to be read

.I offset 
  the offset of file

.I vec
  struct kvec ,includes buf address in kernel address
  and the length of each buffer

.I vlen 
  number of blocks to be read 

.P
.TP
.B nfsd.write

Fires whenever server writes file

.B Arguments:

.I fh
   file handle (the first part is the length of the file handle)

.I file
   argument :file, indicates if the file has been opened.

.I count,size 
  number of bytes to be read

.I offset 
  the offset of file

.I vec
  struct kvec ,includes buf address in kernel address
  and the length of each buffer

.I vlen 
  number of blocks to be written 

.P
.TP
.B nfsd.commit

Fires when server commits all pending writes to stable storage

.B Arguments:

.I fh
  file handle (the first part is the length of the file handle)

.I count,size 
  number of bytes to be read

.I offset 
  the offset of file

.P
.TP
.B nfsd.lookup

Fires whenever client opens/searchs file on server

.B Arguments:

.I fh
  file handle (the first part is the length of the file handle)

.I filename
  file name

.I filelen
  the length of file name

.P
.TP
.B nfsd.create

 Fires when client creates a file(regular,dir,device,fifo) on
 server side, sometimes nfsd will call nfsd_create_v3 instead 
 of this function

.B Arguments:

.I  fh  
  file handle (the first part is the length of the file handle)

.I  filename 
  file name 

.I  filelen  
  the length of file name

.I  type 
  file type(regular,dir,device,fifo ...)

.I  iap_valid
  Attribute flags

.I  iap_mode 
  file access mod

.P
.TP
.B nfsd.createv3

Fires when client creates a regular file or set file attributes
on server side,only called by nfsd3_proc_create and nfsd4_open
(op_claim_type is NFS4_OPEN_CLAIM_NULL)

.B Arguments:

.I  fh  
  file handle (the first part is the length of the file handle)

.I  filename 
  file name 

.I  filelen  
  the length of file name

.I  iap_valid 
  Attribute flags

.I  iap_mode 
  file access mode

.I  createmode 
  create mode .The possible values could be:
    NFS3_CREATE_EXCLUSIVE,NFS3_CREATE_UNCHECKED,NFS3_CREATE_GUARDED

.I  truncp 
  trunp arguments, indicates if the file shouldbe truncate

.I  verfier 
  file attributes (atime,mtime,mode).It's used to reset file
  attributes for CREATE_EXCLUSIVE

.P
.TP
.B nfsd.unlink

Fires when client removes a file or a dir  on server side,

.B Arguments:

.I  fh  
  file handle (the first part is the length of the file handle)

.I  filename 
  file name 

.I  filelen  
  the length of file name

.I  type 
  file type(file or dir)

.P
.TP
.B nfsd.rename
Fires when clients rename a file on server side

.B Arguments:

.I fh 
  file handler of old path

.I tfh 
  file handler of new path

.I filename 
  old file name 

.I tname 
  new file name

.I flen 
  length of old file name 

.I tlen 
  length of new file name

.P
.TP
.B nfsd.close

Fires whenever server closes file

.B Arguments:

.I filename
  file name

.P
.TP
.B nfsd.dispatch

Fires whenever server receives NFS operation from client 

.B Arguments:

.I client_ip 
  the ip address of client

.I proto 
  transfer protocol

.I version 
  nfs version

.I xid 
  transmission id

.I prog 
  program number

.I proc 
  procedure number

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