[[!template id=project

title="Socket option to timestamp UDP packets in the kernel"

contact="""
[tech-kern](mailto:tech-kern@NetBSD.org)
"""

mentors="""
[Christos Zoulas](mailto:christos@NetBSD.org)
"""

category="kernel"
difficulty="easy"
duration="3 months"
done_by="Vlad Balan"

description="""
Many applications that use UDP unicast or multicast to receive data, need to store the data together with its reception time, or time the arrival time of packets as precisely as possible. This is required for example in order to be able to replay the data in simulated real-time to be able to do further performance analysis or quality control. Right now the only way to do this is to call [[!template id=man name="recv" section="2" collection="NetBSD-5.1"]]/[[!template id=man name="recvmsg" section="2" collection="NetBSD-5.1"]]/[[!template id=man name="recvfrom" section="2" collection="NetBSD-5.1"]] to grab the data, followed by [[!template id=man name="gettimeofday" section="2" collection="NetBSD-5.1"]]/[[!template id=man name="clock_gettime" section="2" collection="NetBSD-5.1"]]. This is undesirable because:

* It doubles the number of system calls limiting the effective maximum reception rate.
* The timing of the packet is imprecise because there non-deterministic delay from the time that the packet hit the network adapter till the time userland received it.

Linux provides a socket control message to add timestamp ancillary data to the the socket, which can be controlled by 2 different socket options SO_TIMESTAMP and SO_TIMESTAMPNS, using [[!template id=man name="setsockopt" section="2" collection="NetBSD-5.1"]]. Recently linux added more [SO_TIMESTAMPING_*](http://lwn.net/Articles/325929/) options to provide even more precise timestamps from NIC cards that support them. This project is about implementing those options on NetBSD. Their implementation should be done as close to the code that does reception as possible to minimize timestamp delay. The SO_TIMESTAMP option is already done in the kernel (perhaps only partially): [kern](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/kern/uipc_socket.c), [ip](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/netinet/ip_input.c), [raw](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/netinet/raw_ip.c), [udp](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/netinet/udp_usrreq.c), [ip6](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/netinet6/ip6_input.c), [sys](http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/sys/socket.h). A good reading would also be [timestamping.c](http://alinux.tv/Kernel-2.6.34/networking/timestamping/timestamping.c)

This project is to finish implementing SO_TIMESTAMP in the kernel, test it, add SO_TIMESTAMPNS (both very easy, should be a few hours of work), and then design and implement the SO_TIMESTAMPING_* options, get at least one driver working with them and test them.

"""
]]

[[!tag gsoc]]