On Tue, Apr 17, 2018 at 03:34:36PM +0100, Quentin Monnet wrote: > Add documentation for eBPF helper functions to bpf.h user header file. > This documentation can be parsed with the Python script provided in > another commit of the patch series, in order to provide a RST document > that can later be converted into a man page. > > The objective is to make the documentation easily understandable and > accessible to all eBPF developers, including beginners. > > This patch contains descriptions for the following helper functions: > > Helper from Kaixu: > - bpf_perf_event_read() > > Helpers from Martin: > - bpf_skb_under_cgroup() > - bpf_xdp_adjust_head() > > Helpers from Sargun: > - bpf_probe_write_user() > - bpf_current_task_under_cgroup() > > Helper from Thomas: > - bpf_skb_change_head() > > Helper from Gianluca: > - bpf_probe_read_str() > > Helpers from Chenbo: > - bpf_get_socket_cookie() > - bpf_get_socket_uid() > > v3: > - bpf_perf_event_read(): Fix time of selection for perf event type in > description. Remove occurences of "cores" to avoid confusion with > "CPU". > > Cc: Kaixu Xia <xiaka...@huawei.com> > Cc: Martin KaFai Lau <ka...@fb.com> > Cc: Sargun Dhillon <sar...@sargun.me> > Cc: Thomas Graf <tg...@suug.ch> > Cc: Gianluca Borello <g.bore...@gmail.com> > Cc: Chenbo Feng <fe...@google.com> > Signed-off-by: Quentin Monnet <quentin.mon...@netronome.com> ... > + * > + * u64 bpf_get_socket_cookie(struct sk_buff *skb) > + * Description > + * Retrieve the socket cookie generated by the kernel from a > + * **struct sk_buff** with a known socket. If none has been set
this bit could use some improvement, since it reads as cookie is generated from sk_buff, whereas it has nothing to do with this particular sk_buff. Cookie belongs to the socket and generated for the socket. Would be good to explain that cookie is stable for the life of the socket. For the rest: Acked-by: Alexei Starovoitov <a...@kernel.org>
