diff options
author | Jamal Hadi Salim <hadi@cyberus.ca> | 2007-10-26 05:49:09 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2007-10-26 05:49:09 -0400 |
commit | d892afe2ca905ddb00a4f16927c8b465cdd31b20 (patch) | |
tree | c15295f448a19046423bbb480fcfefe319f91928 /Documentation/networking/tc-actions-env-rules.txt | |
parent | a057ae3c104dd2c661e55d2af37e70d168c65e00 (diff) |
[NET]: Document some simple rules for actions
This patch adds documentation on what is expected of an
action which branches away from the action-graph or when it
needs to trample on actins. It also describes what is expected of
users of such actions.
Signed-off-by: Jamal Hadi Salim <hadi@cyberus.ca>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/tc-actions-env-rules.txt')
-rw-r--r-- | Documentation/networking/tc-actions-env-rules.txt | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/Documentation/networking/tc-actions-env-rules.txt b/Documentation/networking/tc-actions-env-rules.txt new file mode 100644 index 000000000000..01e716d185f4 --- /dev/null +++ b/Documentation/networking/tc-actions-env-rules.txt | |||
@@ -0,0 +1,29 @@ | |||
1 | |||
2 | The "enviromental" rules for authors of any new tc actions are: | ||
3 | |||
4 | 1) If you stealeth or borroweth any packet thou shalt be branching | ||
5 | from the righteous path and thou shalt cloneth. | ||
6 | |||
7 | For example if your action queues a packet to be processed later | ||
8 | or intentionaly branches by redirecting a packet then you need to | ||
9 | clone the packet. | ||
10 | There are certain fields in the skb tc_verd that need to be reset so we | ||
11 | avoid loops etc. A few are generic enough so much so that skb_act_clone() | ||
12 | resets them for you. So invoke skb_act_clone() rather than skb_clone() | ||
13 | |||
14 | 2) If you munge any packet thou shalt call pskb_expand_head in the case | ||
15 | someone else is referencing the skb. After that you "own" the skb. | ||
16 | You must also tell us if it is ok to munge the packet (TC_OK2MUNGE), | ||
17 | this way any action downstream can stomp on the packet. | ||
18 | |||
19 | 3) dropping packets you dont own is a nono. You simply return | ||
20 | TC_ACT_SHOT to the caller and they will drop it. | ||
21 | |||
22 | The "enviromental" rules for callers of actions (qdiscs etc) are: | ||
23 | |||
24 | *) thou art responsible for freeing anything returned as being | ||
25 | TC_ACT_SHOT/STOLEN/QUEUED. If none of TC_ACT_SHOT/STOLEN/QUEUED is | ||
26 | returned then all is great and you dont need to do anything. | ||
27 | |||
28 | Post on netdev if something is unclear. | ||
29 | |||