abbreviations.txt

Some shortcuts used while naming variables and functions through the code:


src = source
dst = destination

in = incoming (Note, not "inner")
out = outgoing (Not "outer")

4to6 = translation from IPv4 to IPv6
6to4 = translation from IPv6 to IPv4
alloc = memory allocation
addr = address
aux = auxiliar function
cb = callback (synonym for "fn")
csum = checksum
comm = common
daddr = destination address
dev = network device (within code) or developer (within documentation)
eam = Explicit Address Mapping (https://tools.ietf.org/html/draft-anderson-v6ops-siit-eam-02)
eamt = EAM table
err = error
est = established session (inherited from RFC 6146.)
fn = function ("this parameter is a pointer to a function.")
frag = fragment
hdr = header
init = initialize
inode = internal node (https://en.wikipedia.org/wiki/Tree_%28data_structure%29)
l2 = layer 2 (link)
l3 = layer 3 (network; IPv4 or IPv6.)
l4 = layer 4 (transport; TCP, UDP. Also ICMP and ICMPv6 for convenience.)
len = length
mod = kernel module
NIC = Network Interface Card
nf = Netfilter (http://www.netfilter.org/)
nl = Netlink (http://en.wikipedia.org/wiki/Netlink)
pkt = packet
pref = prefix
proto = protocol
ptr = pointer
req = request
rm = remove
	-> "remove" stands for "take out of a database".
	   Sometimes, this also means the entry is deleted.
	-> "delete" means to actually erase the entry.
rtrie = radix trie (https://en.wikipedia.org/wiki/Radix_trie)
saddr = source address
skb = socket buffer (To all intents and purposes, a packet. Inherited from the kernel)
taddr = Transport address (A network layer id plus a transport layer id).
trans = transitory session (inherited from RFC 6146.)
ttp = Translating the Packet (Fourth core step of the NAT64 translation algorithm; see RFC 6146)
usr = user[space]
x<n> (where x is anything and n is 4 or 6) = x has something to do with IPv<n>. Examples:
	pool4 = IPv4 pool
	addr6 = IPv6 address
	In particular, the "tuple<n>" names intend to remind you of the correct type of addresses
	you're supposed to extract from their tuples' inner unions. 
xlat = translation


When we say "payload", we mean the layer-4 payload. When we want to say layer-3 payload, we should
prefix it ("l3_payload").


BTW: We're making an effort to follow the kernel's code conventions:
https://www.kernel.org/doc/Documentation/CodingStyle
So please don't freak out when you catch glimpse of those gotos :).