Page MenuHomeFreeBSD
Differential D21619

Update SIFTR man page, and minor trailing whitespace nit.
ClosedPublic
Actions

Authored by rscheff on Sep 12 2019, 3:17 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Apr 20, 12:15 AM
Unknown Object (File)
Mon, Apr 14, 10:51 AM
Unknown Object (File)
Mon, Apr 14, 4:49 AM
Unknown Object (File)
Mon, Apr 14, 3:00 AM
Unknown Object (File)
Mon, Apr 14, 2:59 AM
Unknown Object (File)
Mon, Apr 14, 2:59 AM
Unknown Object (File)
Mon, Apr 14, 12:35 AM
Unknown Object (File)
Sun, Apr 13, 10:11 PM
View All 99 Files
Subscribers
imp

Details

Reviewers
cc
brooks
bcr
Group Reviewers
manpages
Commits
rS353412: MFS r353402:
rS353402: MFC r353290:
rS353290: In r343587 a simple port filter as sysctl tunable was added to siftr.
Summary

D18897 added a simple port filter as sysctl tunable to siftr.

The new sysctl was not added to the siftr.4 man page at the time.

This updates the man page, and removes one left over trailing whitespace.

Diff Detail

Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 26907
Build 25217: arc lint + arc unit

Event Timeline

rscheff created this revision.Sep 12 2019, 3:17 PM
Harbormaster completed remote builds in B26426: Diff 61979.Sep 12 2019, 3:17 PM
rscheff added a reviewer: bcr.Sep 12 2019, 3:20 PM
bcr added a comment.Sep 12 2019, 3:41 PM

Two fixes for the man page.

share/man/man4/siftr.4
138

s/elegible/eligible/

139

s/only/other/

or

s/only//

or even

s/any//

?

rscheff updated this revision to Diff 61983.Sep 12 2019, 3:46 PM
  • man page typos
Harbormaster completed remote builds in B26428: Diff 61983.Sep 12 2019, 3:46 PM
rscheff marked 2 inline comments as done.Sep 12 2019, 3:47 PM
bcr accepted this revision.Sep 12 2019, 3:48 PM

OK, thanks for the quick fixes.
The .Dd needs to be bumped when the change is committed, but I leave that to others.

This revision is now accepted and ready to land.Sep 12 2019, 3:48 PM
rscheff updated this revision to Diff 61986.Sep 12 2019, 4:09 PM
  • bumping .Dd date
This revision now requires review to proceed.Sep 12 2019, 4:09 PM
Harbormaster completed remote builds in B26431: Diff 61986.Sep 12 2019, 4:09 PM
rscheff updated this revision to Diff 62982.Oct 7 2019, 9:18 AM
  • update siftr man page timestamp and fix trailing whitespace
Harbormaster completed remote builds in B26907: Diff 62982.Oct 7 2019, 9:18 AM
rscheff retitled this revision from Update SIFTR man page, and make siftr port_filter work as intended to Update SIFTR man page, and minor trailing whitespace nit..Oct 7 2019, 9:22 AM
rscheff edited the summary of this revision. (Show Details)
rscheff added a comment.Oct 7 2019, 9:24 AM

Removed the filter logic changes as they were logically equivalent with the already implemented logic - could not figure out why I though this may not work properly (possibly not clearing the siftr logs properly when checking).

This Diff is therefore only the man page update, complete with bcr's comments to improve the original wording, and is ready to land.

bcr accepted this revision.Oct 7 2019, 9:30 AM

OK, thanks for the man page fixes. It can be committed with the source change now.

This revision is now accepted and ready to land.Oct 7 2019, 9:30 AM
Closed by commit rS353290: In r343587 a simple port filter as sysctl tunable was added to siftr. (authored by tuexen). · Explain WhyOct 7 2019, 8:35 PM
This revision was automatically updated to reflect the committed changes.
tuexen added a commit: rS353290: In r343587 a simple port filter as sysctl tunable was added to siftr..
Herald added a reviewer: manpages. · View Herald TranscriptOct 7 2019, 8:35 PM
Herald added a subscriber: imp. · View Herald Transcript
tuexen added a commit: rS353402: MFC r353290:.Oct 10 2019, 2:54 PM
tuexen added a commit: rS353412: MFS r353402:.Oct 10 2019, 6:39 PM

Revision Contents
Changeset List

PathSize
share/
man/
man4/
10 lines
sys/
netinet/
2 lines

Diff 62982

View Options

share/man/man4/siftr.4

.\" .\"
.Dd September 28, 2023 .Dd December 14, 2023
.Dt IPFW 8 .Dt IPFW 8
.Os .Os
.Sh NAME .Sh NAME
.Nm ipfw , dnctl .Nm ipfw , dnctl
.Nd User interface for firewall, traffic shaper, packet scheduler, .Nd User interface for firewall, traffic shaper, packet scheduler,
in-kernel NAT. in-kernel NAT.
.Sh SYNOPSIS .Sh SYNOPSIS
.Ss FIREWALL CONFIGURATION .Ss FIREWALL CONFIGURATION
▲ Show 20 Lines • Show All 3,023 Lines • ▼ Show 20 Lines
is normally reported to the caller routine in the kernel, in the is normally reported to the caller routine in the kernel, in the
same way as it happens when a device queue fills up. same way as it happens when a device queue fills up.
Setting this Setting this
option reports the packet as successfully delivered, which can be option reports the packet as successfully delivered, which can be
needed for some experimental setups where you want to simulate needed for some experimental setups where you want to simulate
loss or congestion at a remote router. loss or congestion at a remote router.
.Pp .Pp
.It Cm plr Ar packet-loss-rate .It Cm plr Ar packet-loss-rate
.It Cm plr Ar K,p,H,r
Packet loss rate. Packet loss rate.
Argument Argument
.Ar packet-loss-rate .Ar packet-loss-rate
is a floating-point number between 0 and 1, with 0 meaning no is a floating-point number between 0 and 1, with 0 meaning no
loss, 1 meaning 100% loss. loss, 1 meaning 100% loss.
The loss rate is internally represented on 31 bits. .Pp
When invoked with four arguments, the simple Gilbert-Elliott
channel model with two states (Good and Bad) is used.
.Bd -literal -offset indent
r
.----------------.
v |
.------------. .------------.
| G | | B |
| drop (K) | | drop (H) |
'------------' '------------'
| ^
'----------------'
p
.Ed
This has the associated probabilities
.Po Ar K
and
.Ar H Pc
for the loss probability. This is different from the literature,
where this model is described with probabilities of successful
transmission k and h. However, converting from literature is
easy:
.Pp
K = 1 - k ; H = 1 - h
.Pp
This is to retain consistency within the interface and allow the
quick re-use of loss probability when giving only a single argument.
In addition the state change probabilities
.Po Ar p
and
.Ar r Pc
are given.
All of the above probabilities are internally represented on 31 bits.
.Pp .Pp
.It Cm queue Brq Ar slots | size Ns Cm Kbytes .It Cm queue Brq Ar slots | size Ns Cm Kbytes
pauamma_gundo.comUnsubmitted
Done
Inline Actions

Worth being explicit that these arguments are comma-separated and mention their internal representation if relevant?

pauamma_gundo.com: Worth being explicit that these arguments are comma-separated and mention their internal…
rscheffAuthorUnsubmitted
Done
Inline Actions

Ideally, I wanted to have the parameters in loss probabilities; the literature of the gilbert-elliott model give these (k, h) as transmission probabilities - the inverse of what the simple PLR loss probability is;
Adjusted the code accordingly.
Alternatively, I could call these parameters K and H, with K = (1-k) and H = (1-h), keep the code more streamlined and the probabilities would align nicely with the simple PLR loss model...

Any opinions?

rscheff: Ideally, I wanted to have the parameters in loss probabilities; the literature of the gilbert…
pauamma_gundo.comUnsubmitted
Not Done
Inline Actions

I have no basis for an informed opinion on that point myself.

pauamma_gundo.com: I have no basis for an informed opinion on that point myself.
Queue size, in Queue size, in
.Ar slots .Ar slots
or or
.Cm KBytes . .Cm KBytes .
Default value is 50 slots, which Default value is 50 slots, which
is the typical queue size for Ethernet devices. is the typical queue size for Ethernet devices.
Note that for slow speed links you should keep the queue Note that for slow speed links you should keep the queue
size short or your traffic might be affected by a significant size short or your traffic might be affected by a significant
queueing delay. queueing delay.
pauamma_gundo.comUnsubmitted
Done
Inline Actions
.Po Ar change-to-B
and
- .Ar change-to-A Pc
+ .Ar change-to-G Pc
.
.Pp
.It Cm queue Brq Ar slots | size Ns Cm Kbytes

Or explain what A is.

pauamma_gundo.com: Or explain what A is.
E.g., 50 max-sized Ethernet packets (1500 bytes) mean 600Kbit E.g., 50 max-sized Ethernet packets (1500 bytes) mean 600Kbit
or 20s of queue on a 30Kbit/s pipe. or 20s of queue on a 30Kbit/s pipe.
Even worse effects can result if you get packets from an Even worse effects can result if you get packets from an
interface with a much larger MTU, e.g.\& the loopback interface interface with a much larger MTU, e.g.\& the loopback interface
with its 16KB packets. with its 16KB packets.
The The
.Xr sysctl 8 .Xr sysctl 8
variables variables
▲ Show 20 Lines • Show All 1,890 Lines • Show Last 20 Lines
View Options

sys/netinet/siftr.c

.\" .\"
.Dd September 28, 2023 .Dd December 14, 2023
.Dt IPFW 8 .Dt IPFW 8
.Os .Os
.Sh NAME .Sh NAME
.Nm ipfw , dnctl .Nm ipfw , dnctl
.Nd User interface for firewall, traffic shaper, packet scheduler, .Nd User interface for firewall, traffic shaper, packet scheduler,
in-kernel NAT. in-kernel NAT.
.Sh SYNOPSIS .Sh SYNOPSIS
.Ss FIREWALL CONFIGURATION .Ss FIREWALL CONFIGURATION
▲ Show 20 Lines • Show All 3,023 Lines • ▼ Show 20 Lines
is normally reported to the caller routine in the kernel, in the is normally reported to the caller routine in the kernel, in the
same way as it happens when a device queue fills up. same way as it happens when a device queue fills up.
Setting this Setting this
option reports the packet as successfully delivered, which can be option reports the packet as successfully delivered, which can be
needed for some experimental setups where you want to simulate needed for some experimental setups where you want to simulate
loss or congestion at a remote router. loss or congestion at a remote router.
.Pp .Pp
.It Cm plr Ar packet-loss-rate .It Cm plr Ar packet-loss-rate
.It Cm plr Ar K,p,H,r
Packet loss rate. Packet loss rate.
Argument Argument
.Ar packet-loss-rate .Ar packet-loss-rate
is a floating-point number between 0 and 1, with 0 meaning no is a floating-point number between 0 and 1, with 0 meaning no
loss, 1 meaning 100% loss. loss, 1 meaning 100% loss.
The loss rate is internally represented on 31 bits. .Pp
When invoked with four arguments, the simple Gilbert-Elliott
channel model with two states (Good and Bad) is used.
.Bd -literal -offset indent
r
.----------------.
v |
.------------. .------------.
| G | | B |
| drop (K) | | drop (H) |
'------------' '------------'
| ^
'----------------'
p
.Ed
This has the associated probabilities
.Po Ar K
and
.Ar H Pc
for the loss probability. This is different from the literature,
where this model is described with probabilities of successful
transmission k and h. However, converting from literature is
easy:
.Pp
K = 1 - k ; H = 1 - h
.Pp
This is to retain consistency within the interface and allow the
quick re-use of loss probability when giving only a single argument.
In addition the state change probabilities
.Po Ar p
and
.Ar r Pc
are given.
All of the above probabilities are internally represented on 31 bits.
.Pp .Pp
.It Cm queue Brq Ar slots | size Ns Cm Kbytes .It Cm queue Brq Ar slots | size Ns Cm Kbytes
pauamma_gundo.comUnsubmitted
Done
Inline Actions

Worth being explicit that these arguments are comma-separated and mention their internal representation if relevant?

pauamma_gundo.com: Worth being explicit that these arguments are comma-separated and mention their internal…
rscheffAuthorUnsubmitted
Done
Inline Actions

Ideally, I wanted to have the parameters in loss probabilities; the literature of the gilbert-elliott model give these (k, h) as transmission probabilities - the inverse of what the simple PLR loss probability is;
Adjusted the code accordingly.
Alternatively, I could call these parameters K and H, with K = (1-k) and H = (1-h), keep the code more streamlined and the probabilities would align nicely with the simple PLR loss model...

Any opinions?

rscheff: Ideally, I wanted to have the parameters in loss probabilities; the literature of the gilbert…
pauamma_gundo.comUnsubmitted
Not Done
Inline Actions

I have no basis for an informed opinion on that point myself.

pauamma_gundo.com: I have no basis for an informed opinion on that point myself.
Queue size, in Queue size, in
.Ar slots .Ar slots
or or
.Cm KBytes . .Cm KBytes .
Default value is 50 slots, which Default value is 50 slots, which
is the typical queue size for Ethernet devices. is the typical queue size for Ethernet devices.
Note that for slow speed links you should keep the queue Note that for slow speed links you should keep the queue
size short or your traffic might be affected by a significant size short or your traffic might be affected by a significant
queueing delay. queueing delay.
pauamma_gundo.comUnsubmitted
Done
Inline Actions
.Po Ar change-to-B
and
- .Ar change-to-A Pc
+ .Ar change-to-G Pc
.
.Pp
.It Cm queue Brq Ar slots | size Ns Cm Kbytes

Or explain what A is.

pauamma_gundo.com: Or explain what A is.
E.g., 50 max-sized Ethernet packets (1500 bytes) mean 600Kbit E.g., 50 max-sized Ethernet packets (1500 bytes) mean 600Kbit
or 20s of queue on a 30Kbit/s pipe. or 20s of queue on a 30Kbit/s pipe.
Even worse effects can result if you get packets from an Even worse effects can result if you get packets from an
interface with a much larger MTU, e.g.\& the loopback interface interface with a much larger MTU, e.g.\& the loopback interface
with its 16KB packets. with its 16KB packets.
The The
.Xr sysctl 8 .Xr sysctl 8
variables variables
▲ Show 20 Lines • Show All 1,890 Lines • Show Last 20 Lines