Source Code Guide

Work in progress, collects names used throughout the source code and gives some added meaning

Ouroboros index of commonly used variable names

name	Long name	Description
du	data unit	packet, but stems from RINA that took the OSI SDU (service data unit) and PDU (protocol data unit) - will be renamed
sdb		the ouroboros 'flavored' skb, see e.g.
fd	flow descriptor
shm	shared memory	see e.g. /dev/shm in Linux
rbuff	ring buffer	rbuff are small ring buffers, they are used to move packets through the local pipeline. Instead of passing packets, it passes the index in the rdrbuff to the next process
rdrbuff	random deletion ring buffer	it's our quick and dirty packet buffer. It contains actual packet data
idx	index	index in the packet buffer (rdrbuff) is used to calculate the location of the packet in reference to this base pointer
shm_du_buff		packet (metadata?) with head and tail (todo: have a look at the code)