Page MenuHomeFreeBSD

siftr: add documentation to man page

Authored by tuexen on Jun 30 2023, 12:20 PM.
Referenced Files
Unknown Object (File)
Thu, Nov 23, 8:51 AM
Unknown Object (File)
Thu, Nov 23, 8:29 AM
Unknown Object (File)
Tue, Nov 14, 9:00 AM
Unknown Object (File)
Thu, Nov 9, 6:48 PM
Unknown Object (File)
Thu, Nov 9, 12:10 AM
Unknown Object (File)
Oct 8 2023, 5:37 PM
Unknown Object (File)
Sep 13 2023, 11:54 PM
Unknown Object (File)
Aug 15 2023, 2:24 AM



The man page of the dtrace TCP provider was missing the description of the siftr probe. This patch add this for the current version in the siftr.d file. This is not working on head, but in stable/13. So this patch can be MFCed to stable/13. Upcoming fixes to siftr.d to get it working again in head will update this man page again, but changes mit not be MFCed.

Diff Detail

rG FreeBSD src repository
Lint Not Applicable
Tests Not Applicable

Event Timeline

cc requested changes to this revision.Jun 30 2023, 2:44 PM
cc added inline comments.

This "ipver" does not seem to be the field in siftr from fbsd13. Also it looks, for example, the timestamp, local/foreign ip address fields are missing, based on

Also slow start threshold field should be ahead of congestion window field, etc. There are more fields missing or not in the same order.

Please check and sync with the siftr Field descriptions in the link mentioned above.


"RPORT" shall be "FPORT"?

This revision now requires changes to proceed.Jun 30 2023, 2:44 PM

I'm documenting struct siftrinfo from siftr.d. I'm documenting the fields in the order they are contained in the structure. These fields are not in the order of the output of the siftr module. I just document what is there. In particular the local/remote addresses are missing and I'm planning to add them in a later commit and then document them. But right now, there are not there and therefore can't be documented.

The only field I'm no documenting is the tval field, since there is no translator for it and dtrace has its own way of time stamping.


The other probes of the tcp provider use local/remote. I have a cleanup patch which will change to that convention. But If you prefer, I can change it to FPORT, MFC that to stable/13 and than change it to local/remote instead of local/foreign. This is of course only for the dtrace probe.

Thanks for the explanation.


OK. This is the dtrace style of naming it "RPORT". Then, it is not necessary to change it.

This revision is now accepted and ready to land.Jun 30 2023, 9:47 PM