freeRouter source tree

• forwarding: ipv4, ipv6, ipx, mpls, nsh, layer2, irb, atom, eompls, vpls, evpn
• routing protocols: ospf, isis, bgp, rip, eigrp, rift, babel, olsr, pim, msdp
• lsp support: p2p, p2mp, mp2mp built by bgp, ldp, rsvp-te, sr, sr-te, bier, polka
• crypto: macsec, ipsec, ikev1, ikev2, tls, dtls, ssh, openvpn, wireguard, sgt
• tunnel: gre, ipip, l2tp, pptp, lisp, geneve, nvgre, vxlan, etherip, amt
• encapsulation: ethernet, vlan, qinq, ppp(oe), framerelay, pwether, virtppp, hairpin
• misc: acl, qos, nat, pbr, srv6, vrrp, hsrp, inspect, 6to4, rpl, tunnel, vpdn, pcep

• http://sources.freertr.org/
• http://codeberg.org/mc36/freeRtr
• http://bitbucket.org/mc36mc/freeRtr
• http://gitlab.com/mc36mc/freeRtr
• http://github.com/mc36/freeRtr
• http://gitgud.io/mc36/freertr
• http://gitea.com/mc36/freeRtr
• http://sourceforge.net/p/freertr/code
• http://git.sr.ht/~mc36/freeRtr/tree
• http://src.freertr.org/

• p4bf at http://bitbucket.software.geant.org/projects/RARE/repos/rare/browse
• p4bmv2 at http://github.com/rare-freertr/RARE-bmv2

dependencies

directory structure

• src contains the main sources
• cfg contains the self tests
• misc contains some smaller subprojects, see below

• img vm images used for interop and dataplane testing
• binDwn packages used for demo vm creation
• binDsk rootfs used for demo vm creation
• binImg outcome of demo vm creation
• binOut output of compilation
• binTmp output of testing

directories under misc folder

• native: dpdk, xdp, pcap, xsk, io uring, raw socket, mnl and sai based dataplanes
• p4bf: tofino based dataplane
• p4bmv2: bmv2 based dataplane
• bogon: web based bogon originator
• lookingglass: web based looking glass
• captures: script to stream captures
• sniffer: web based packet capture
• mailer: web based mail reader
• paster: web based pastebin service
• gallery: web based album viewer
• motion: web based alarm/recorder
• player: web based music player/streamer/receiver
• streamer: low latency workers for the above
• temper: web based thermostat/controller
• trackmap: web based monitoring
• position: web based location service
• voice: an answering machine
• snmp: some snmp definitions
• rfcs: rfc series renamer
• consistency: old style check definitions
• tests: some volumentric generators
• check: some check definitions
• sensor: some sensor definitions
• prometheus: some grafana definitions
• netconf: some yang definitions
• image: demo vm iso creator
• img2ova: demo vm ova creator
• service: install script

getting started

• d.sh to clean up
• c.sh to compile
• r.sh to run
• t.sh to selftest

• cd src
• ./c.sh
• ./tw.sh rout-bgp001
• telnet 127.0.0.1 20001
• telnet 127.0.0.1 20002
• telnet 127.0.0.1 20003
• telnet 127.0.0.1 20004

• cd src
• ./c.sh
• ./cn.sh
• ./twd.sh p4lang-rout001
• telnet 127.0.0.1 20001
• telnet 127.0.0.1 20003
• telnet 127.0.0.1 20004
• telnet 127.0.0.1 20005
• telnet 127.0.0.1 20006

contributing

• grep me-the in the sources to see how to add a show command
• grep ifcHdlc to see how to add a new interface encapsulation
• take a look on rtrDownload to see an exmaple routing protocol
• find out how to add a new game to the command line interface
• try to solve a puzzle from the todo.txt in the source tree
• in most of the folders there is a class to extend or implment
• your eyes will bleed because of the mix of c, p4 and java

additional information

• freertr@groups.io
• docs.freertr.org
• demo.freertr.org
• rare.freertr.org
• blog.freertr.org