bpf: Support replacing cgroup-bpf program in MULTI mode
Subsystems (6)
PATCH v2 2/6 bpf: Remove unused new_flags in hierarchy_allows_attach()
In reply to Andrey Ignatovnew_flags is unused, remove it.
--- kernel/bpf/cgroup.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
kernel/bpf/cgroup.c +2 -3
@@ -103,8 +103,7 @@ static u32 prog_list_length(struct list_head *head)* if parent has overridable or multi-prog, allow attaching */ static bool hierarchy_allows_attach (struct cgroup *cgrp, -enum bpf_attach_type type, -u32 new_flags) +enum bpf_attach_type type) {struct cgroup *p;
@@ -303,7 +302,7 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,/* invalid combination */ return -EINVAL ; -if (!hierarchy_allows_attach (cgrp, type, flags)) +if (!hierarchy_allows_attach (cgrp, type))return -EPERM ;if (!list_empty (progs) && cgrp->bpf.flags[type] != flags)
Signature · 1 line
2.17.1
PATCH v2 4/6 libbpf: Make DECLARE_LIBBPF_OPTS available in bpf.h
In reply to Andrey IgnatovDECLARE_LIBBPF_OPTS is the way to use option structures in a backward compatible and extensible way. It's available only in libbpf.h. Though public interfaces in bpf.h have the same requirement to accept options in a way that can be simply extended w/o introducing new xattr-functions every time.
libbpf.c depends on bpf.h, hence to share the macros a couple of options exist:
* either a common header should be introduced;
* or the macro can be moved to bpf.h and used by libbpf.h from there;
The former seems to be an overkill, so do the latter:
* move DECLARE_LIBBPF_OPTS from libbpf.h to bpf.h;
* move #include "bpf.h" from libbpf.c to libbpf.h not to break users of the macro who already include only libbpf.h.
That makes the macro available to use in bpf.{h,c} and should not break those who already use it.
--- tools/lib/bpf/bpf.h | 22 ++++++++++++++++++++++ tools/lib/bpf/libbpf.c | 1 - tools/lib/bpf/libbpf.h | 24 ++---------------------- 3 files changed, 24 insertions(+), 23 deletions(-)
tools/lib/bpf/bpf.h +22 -0
@@ -36,6 +36,28 @@ extern "C" {#define LIBBPF_API __attribute__((visibility("default")))#endif +/* Helper macro to declare and initialize libbpf options struct +* +* This dance with uninitialized declaration, followed by memset to zero, +* followed by assignment using compound literal syntax is done to preserve +* ability to use a nice struct field initialization syntax and **hopefully** +* have all the padding bytes initialized to zero. It's not guaranteed though, +* when copying literal, that compiler won't copy garbage in literal's padding +* bytes, but that's the best way I've found and it seems to work in practice. +* +* Macro declares opts struct of given type and name, zero-initializes, +* including any extra padding, it with memset() and then assigns initial +* values provided by users in struct initializer-syntax as varargs. +*/ +#define DECLARE_LIBBPF_OPTS (TYPE ,NAME , ...) \ + struct TYPE NAME = ({ \ + memset(&NAME, 0, sizeof(struct TYPE)); \ + (struct TYPE) { \ + .sz = sizeof(struct TYPE), \ + __VA_ARGS__ \ + }; \ + }) +struct bpf_create_map_attr {const char *name;enum bpf_map_type map_type;
tools/lib/bpf/libbpf.c +0 -1
@@ -46,7 +46,6 @@#include <gelf.h> #include "libbpf.h" -#include "bpf.h" #include "btf.h" #include "str_error.h" #include "libbpf_internal.h"
tools/lib/bpf/libbpf.h +2 -22
@@ -17,6 +17,8 @@#include <sys/types.h> // for size_t #include <linux/bpf.h> +#include "bpf.h" +#ifdef __cplusplusextern "C" {#endif
@@ -67,28 +69,6 @@ struct bpf_object_open_attr {enum bpf_prog_type prog_type; }; -/* Helper macro to declare and initialize libbpf options struct -* -* This dance with uninitialized declaration, followed by memset to zero, -* followed by assignment using compound literal syntax is done to preserve -* ability to use a nice struct field initialization syntax and **hopefully** -* have all the padding bytes initialized to zero. It's not guaranteed though, -* when copying literal, that compiler won't copy garbage in literal's padding -* bytes, but that's the best way I've found and it seems to work in practice. -* -* Macro declares opts struct of given type and name, zero-initializes, -* including any extra padding, it with memset() and then assigns initial -* values provided by users in struct initializer-syntax as varargs. -*/ -#define DECLARE_LIBBPF_OPTS (TYPE ,NAME , ...) \ - struct TYPE NAME = ({ \ - memset(&NAME, 0, sizeof(struct TYPE)); \ - (struct TYPE) { \ - .sz = sizeof(struct TYPE), \ - __VA_ARGS__ \ - }; \ - }) -struct bpf_object_open_opts {/* size of this struct, for forward/backward compatiblity */ size_t sz;
Signature · 1 line
2.17.1
v2 cover bpf: Support replacing cgroup-bpf program in MULTI mode
v1->v2:
- move DECLARE_LIBBPF_OPTS from libbpf.h to bpf.h (patch 4);
- switch new libbpf API to OPTS framework;
- switch selftest to libbpf OPTS framework.
This patch set adds support for replacing cgroup-bpf programs attached with BPF_F_ALLOW_MULTI flag so that any program in a list can be updated to a new version without service interruption and order of programs can be preserved.
Please see patch 3 for details on the use-case and API changes.
Other patches:
Patch 1 is preliminary refactoring of __cgroup_bpf_attach to simplify it. Patch 2 is minor cleanup of hierarchy_allows_attach.
Patch 4 moves DECLARE_LIBBPF_OPTS from libbpf.h to bpf.h Patch 5 extends libbpf API to support new set of attach attributes. Patch 6 adds selftest coverage for the new API.
Andrey Ignatov (6):
bpf: Simplify __cgroup_bpf_attach
bpf: Remove unused new_flags in hierarchy_allows_attach()
bpf: Support replacing cgroup-bpf program in MULTI mode
libbpf: Make DECLARE_LIBBPF_OPTS available in bpf.h
libbpf: Introduce bpf_prog_attach_xattr selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
include/linux/bpf-cgroup.h | 4 +- include/uapi/linux/bpf.h | 10 ++ kernel/bpf/cgroup.c | 97 ++++++++++--------- kernel/bpf/syscall.c | 4 +- kernel/cgroup/cgroup.c | 5 +- tools/include/uapi/linux/bpf.h | 10 ++ tools/lib/bpf/bpf.c | 21 +++- tools/lib/bpf/bpf.h | 34 +++++++ tools/lib/bpf/libbpf.c | 1 - tools/lib/bpf/libbpf.h | 24 +---- tools/lib/bpf/libbpf.map | 2 + .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++- 12 files changed, 191 insertions(+), 83 deletions(-)
Signature · 1 line
2.17.1
PATCH v2 3/6 bpf: Support replacing cgroup-bpf program in MULTI mode
The common use-case in production is to have multiple cgroup-bpf programs per attach type that cover multiple use-cases. Such programs are attached with BPF_F_ALLOW_MULTI and can be maintained by different people.
Order of programs usually matters, for example imagine two egress
programs: the first one drops packets and the second one counts packets. If they're swapped the result of counting program will be different.
It brings operational challenges with updating cgroup-bpf program(s) attached with BPF_F_ALLOW_MULTI since there is no way to replace a program:
* One way to update is to detach all programs first and then attach the new version(s) again in the right order. This introduces an interruption in the work a program is doing and may not be acceptable (e.g. if it's egress firewall);
* Another way is attach the new version of a program first and only then detach the old version. This introduces the time interval when two versions of same program are working, what may not be acceptable if a program is not idempotent. It also imposes additional burden on program developers to make sure that two versions of their program can co-exist.
Solve the problem by introducing a "replace" mode in BPF_PROG_ATTACH command for cgroup-bpf programs being attached with BPF_F_ALLOW_MULTI flag. This mode is enabled by newly introduced BPF_F_REPLACE attach flag and bpf_attr.replace_bpf_fd attribute to pass fd of the old program to replace
That way user can replace any program among those attached with BPF_F_ALLOW_MULTI flag without the problems described above.
Details of the new API:
* If BPF_F_REPLACE is set but replace_bpf_fd doesn't have valid descriptor of BPF program, BPF_PROG_ATTACH will return corresponding error (EINVAL or EBADF).
* If replace_bpf_fd has valid descriptor of BPF program but such a program is not attached to specified cgroup, BPF_PROG_ATTACH will return ENOENT.
BPF_F_REPLACE is introduced to make the user intent clear, since replace_bpf_fd alone can't be used for this (its default value, 0, is a valid fd). BPF_F_REPLACE also makes it possible to extend the API in the future (e.g. add BPF_F_BEFORE and BPF_F_AFTER if needed).
--- include/linux/bpf-cgroup.h | 4 +++- include/uapi/linux/bpf.h | 10 ++++++++++ kernel/bpf/cgroup.c | 30 ++++++++++++++++++++++++++---- kernel/bpf/syscall.c | 4 ++-- kernel/cgroup/cgroup.c | 5 +++-- tools/include/uapi/linux/bpf.h | 10 ++++++++++ 6 files changed, 54 insertions(+), 9 deletions(-)
include/linux/bpf-cgroup.h +3 -1
@@ -85,6 +85,7 @@ int cgroup_bpf_inherit(struct cgroup *cgrp);void cgroup_bpf_offline (struct cgroup *cgrp);int __cgroup_bpf_attach (struct cgroup *cgrp,struct bpf_prog *prog, +struct bpf_prog *replace_prog,enum bpf_attach_type type,u32 flags);int __cgroup_bpf_detach (struct cgroup *cgrp,struct bpf_prog *prog,enum bpf_attach_type type);
@@ -93,7 +94,8 @@ int __cgroup_bpf_query(struct cgroup *cgrp, const union bpf_attr *attr,/* Wrapper for __cgroup_bpf_*() protected by cgroup_mutex */ int cgroup_bpf_attach (struct cgroup *cgrp,struct bpf_prog *prog, -enum bpf_attach_type type,u32 flags); +struct bpf_prog *replace_prog,enum bpf_attach_type type, +u32 flags);int cgroup_bpf_detach (struct cgroup *cgrp,struct bpf_prog *prog,enum bpf_attach_type type,u32 flags); int cgroup_bpf_query(struct cgroup *cgrp, const union bpf_attr *attr,
include/uapi/linux/bpf.h +10 -0
@@ -231,6 +231,11 @@ enum bpf_attach_type {* When children program makes decision (like picking TCP CA or sock bind) * parent program has a chance to override it. * +* With BPF_F_ALLOW_MULTI a new program is added to the end of the list of +* programs for a cgroup. Though it's possible to replace an old program at +* any position by also specifying BPF_F_REPLACE flag and position itself in +* replace_bpf_fd attribute. Old program at this position will be released. +* * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups. * A cgroup with NONE doesn't allow any programs in sub-cgroups. * Ex1:
@@ -249,6 +254,7 @@ enum bpf_attach_type {*/ #define BPF_F_ALLOW_OVERRIDE (1U << 0)#define BPF_F_ALLOW_MULTI (1U << 1) +#define BPF_F_REPLACE (1U << 2)/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the * verifier will perform strict alignment checking as if the kernel
@@ -442,6 +448,10 @@ union bpf_attr {__u32 attach_bpf_fd;/* eBPF program to attach */ __u32 attach_type;__u32 attach_flags; +__u32 replace_bpf_fd;/* previously attached eBPF +* program to replace if +* BPF_F_REPLACE is used +*/ };struct {/* anonymous struct used by BPF_PROG_TEST_RUN command */
kernel/bpf/cgroup.c +26 -4
@@ -282,14 +282,17 @@ static int update_effective_progs(struct cgroup *cgrp,* propagate the change to descendants * @cgrp: The cgroup which descendants to traverse * @prog: A program to attach +* @replace_prog: Previously attached program to replace if BPF_F_REPLACE is set * @type: Type of attach operation * @flags: Option flags * * Must be called with cgroup_mutex held. */ int __cgroup_bpf_attach (struct cgroup *cgrp,struct bpf_prog *prog, +struct bpf_prog *replace_prog,enum bpf_attach_type type,u32 flags) { +u32 saved_flags = (flags & (BPF_F_ALLOW_OVERRIDE |BPF_F_ALLOW_MULTI ));struct list_head *progs = &cgrp->bpf.progs[type];struct bpf_prog *old_prog =NULL ; struct bpf_cgroup_storage *storage[MAX_BPF_CGROUP_STORAGE_TYPE],
@@ -298,14 +301,15 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,enum bpf_cgroup_storage_type stype;int err; -if ((flags &BPF_F_ALLOW_OVERRIDE ) && (flags &BPF_F_ALLOW_MULTI )) +if (((flags &BPF_F_ALLOW_OVERRIDE ) && (flags &BPF_F_ALLOW_MULTI )) || + ((flags &BPF_F_REPLACE ) && !(flags &BPF_F_ALLOW_MULTI )))/* invalid combination */ return -EINVAL ;if (!hierarchy_allows_attach (cgrp, type))return -EPERM ; -if (!list_empty (progs) && cgrp->bpf.flags[type] != flags) +if (!list_empty (progs) && cgrp->bpf.flags[type] != saved_flags)/* Disallow attaching non-overridable on top * of existing overridable in this cgroup. * Disallow attaching multi-prog if overridable or none
@@ -320,7 +324,12 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,if (pl->prog == prog)/* disallow attaching the same prog twice */ return -EINVAL ; +if (pl->prog == replace_prog) + replace_pl = pl; } +if ((flags &BPF_F_REPLACE ) && !replace_pl) +/* prog to replace not found for cgroup */ +return -ENOENT ; }else if (!list_empty (progs)) { replace_pl =list_first_entry (progs,typeof (*pl), node); }
@@ -356,7 +365,7 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,for_each_cgroup_storage_type (stype) pl->storage[stype] = storage[stype]; - cgrp->bpf.flags[type] = flags; + cgrp->bpf.flags[type] = saved_flags; err =update_effective_progs (cgrp, type);if (err)
@@ -522,6 +531,7 @@ int __cgroup_bpf_query(struct cgroup *cgrp, const union bpf_attr *attr,int cgroup_bpf_prog_attach (const union bpf_attr *attr,enum bpf_prog_type ptype,struct bpf_prog *prog) { +struct bpf_prog *replace_prog =NULL ;struct cgroup *cgrp;int ret;
@@ -529,8 +539,20 @@ int cgroup_bpf_prog_attach(const union bpf_attr *attr,if (IS_ERR (cgrp))return PTR_ERR (cgrp); - ret =cgroup_bpf_attach (cgrp, prog, attr->attach_type, +if ((attr->attach_flags &BPF_F_ALLOW_MULTI ) && + (attr->attach_flags &BPF_F_REPLACE )) { + replace_prog =bpf_prog_get_type (attr->replace_bpf_fd, ptype); +if (IS_ERR (replace_prog)) { +cgroup_put (cgrp); +return PTR_ERR (replace_prog); + } + } + + ret =cgroup_bpf_attach (cgrp, prog, replace_prog, attr->attach_type, attr->attach_flags); + +if (replace_prog) +bpf_prog_put (replace_prog);cgroup_put (cgrp);return ret; }
kernel/bpf/syscall.c +2 -2
@@ -2073,10 +2073,10 @@ static int bpf_prog_attach_check_attach_type(const struct bpf_prog *prog, } } -#define BPF_PROG_ATTACH_LAST_FIELD attach_flags +#define BPF_PROG_ATTACH_LAST_FIELD replace_bpf_fd#define BPF_F_ATTACH_MASK \ - (BPF_F_ALLOW_OVERRIDE | BPF_F_ALLOW_MULTI) + (BPF_F_ALLOW_OVERRIDE | BPF_F_ALLOW_MULTI | BPF_F_REPLACE)static int bpf_prog_attach (const union bpf_attr *attr) {
kernel/cgroup/cgroup.c +3 -2
@@ -6288,12 +6288,13 @@ void cgroup_sk_free(struct sock_cgroup_data *skcd)#ifdef CONFIG_CGROUP_BPF int cgroup_bpf_attach (struct cgroup *cgrp,struct bpf_prog *prog, -enum bpf_attach_type type,u32 flags) +struct bpf_prog *replace_prog,enum bpf_attach_type type, +u32 flags) {int ret;mutex_lock (&cgroup_mutex); - ret =__cgroup_bpf_attach (cgrp, prog, type, flags); + ret =__cgroup_bpf_attach (cgrp, prog, replace_prog, type, flags);mutex_unlock (&cgroup_mutex);return ret; }
tools/include/uapi/linux/bpf.h +10 -0
@@ -231,6 +231,11 @@ enum bpf_attach_type {* When children program makes decision (like picking TCP CA or sock bind) * parent program has a chance to override it. * +* With BPF_F_ALLOW_MULTI a new program is added to the end of the list of +* programs for a cgroup. Though it's possible to replace an old program at +* any position by also specifying BPF_F_REPLACE flag and position itself in +* replace_bpf_fd attribute. Old program at this position will be released. +* * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups. * A cgroup with NONE doesn't allow any programs in sub-cgroups. * Ex1:
@@ -249,6 +254,7 @@ enum bpf_attach_type {*/ #define BPF_F_ALLOW_OVERRIDE (1U << 0)#define BPF_F_ALLOW_MULTI (1U << 1) +#define BPF_F_REPLACE (1U << 2)/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the * verifier will perform strict alignment checking as if the kernel
@@ -442,6 +448,10 @@ union bpf_attr {__u32 attach_bpf_fd;/* eBPF program to attach */ __u32 attach_type;__u32 attach_flags; +__u32 replace_bpf_fd;/* previously attached eBPF +* program to replace if +* BPF_F_REPLACE is used +*/ };struct {/* anonymous struct used by BPF_PROG_TEST_RUN command */
Signature · 1 line
2.17.1
PATCH v2 5/6 libbpf: Introduce bpf_prog_attach_xattr
In reply to Andrey IgnatovIntroduce a new bpf_prog_attach_xattr function that accepts an extendable struct bpf_prog_attach_opts and supports passing a new attribute to BPF_PROG_ATTACH command: replace_prog_fd that is fd of previously attached cgroup-bpf program to replace if recently introduced BPF_F_REPLACE flag is used.
The new function is named to be consistent with other xattr-functions (bpf_prog_test_run_xattr, bpf_create_map_xattr, bpf_load_program_xattr).
The struct bpf_prog_attach_opts is supposed to be used with DECLARE_LIBBPF_OPTS framework.
The opts argument is used directly in bpf_prog_attach_xattr implementation since at the time of adding all fields already exist in the kernel. New fields, if added, will need to be used via OPTS_* macros from libbpf_internal.h.
--- tools/lib/bpf/bpf.c | 21 +++++++++++++++++---- tools/lib/bpf/bpf.h | 12 ++++++++++++ tools/lib/bpf/libbpf.map | 2 ++ 3 files changed, 31 insertions(+), 4 deletions(-)
tools/lib/bpf/bpf.c +17 -4
@@ -466,14 +466,27 @@ int bpf_obj_get(const char *pathname)int bpf_prog_attach (int prog_fd,int target_fd,enum bpf_attach_type type,unsigned int flags) +{ +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, opts, + .target_fd = target_fd, + .prog_fd = prog_fd, + .type = type, + .flags = flags, + ); + +return bpf_prog_attach_xattr (&opts); +} + +int bpf_prog_attach_xattr (const struct bpf_prog_attach_opts *opts) {union bpf_attr attr;memset (&attr,0 ,sizeof (attr)); - attr.target_fd = target_fd; - attr.attach_bpf_fd = prog_fd; - attr.attach_type = type; - attr.attach_flags = flags; + attr.target_fd = opts->target_fd; + attr.attach_bpf_fd = opts->prog_fd; + attr.attach_type = opts->type; + attr.attach_flags = opts->flags; + attr.replace_bpf_fd = opts->replace_prog_fd;return sys_bpf (BPF_PROG_ATTACH , &attr,sizeof (attr)); }
tools/lib/bpf/bpf.h +12 -0
@@ -150,8 +150,20 @@ LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); LIBBPF_API int bpf_map_freeze(int fd); LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); LIBBPF_API int bpf_obj_get(const char *pathname); + +struct bpf_prog_attach_opts { +size_t sz;/* size of this struct for forward/backward compatibility */ +int target_fd; +int prog_fd; +enum bpf_attach_type type; +unsigned int flags; +int replace_prog_fd; +}; +#define bpf_prog_attach_opts__last_field replace_prog_fd + LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,enum bpf_attach_type type,unsigned int flags); +LIBBPF_API int bpf_prog_attach_xattr(const struct bpf_prog_attach_opts *opts); LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,enum bpf_attach_type type);
tools/lib/bpf/libbpf.map +2 -0
@@ -210,4 +210,6 @@ LIBBPF_0.0.6 { } LIBBPF_0.0.5; LIBBPF_0.0.7 { + global: + bpf_prog_attach_xattr; } LIBBPF_0.0.6;
Signature · 1 line
2.17.1
PATCH v2 1/6 bpf: Simplify __cgroup_bpf_attach
In reply to Andrey Ignatov__cgroup_bpf_attach has a lot of identical code to handle two scenarios:BPF_F_ALLOW_MULTI is set and unset.
Simplify it by splitting the two main steps:
* First, the decision is made whether a new bpf_prog_list entry should be allocated or existing entry should be reused for the new program. This decision is saved in replace_pl pointer;
* Next, replace_pl pointer is used to handle both possible states of BPF_F_ALLOW_MULTI flag (set / unset) instead of doing similar work for them separately.
This splitting, in turn, allows to make further simplifications:
* The check for attaching same program twice in BPF_F_ALLOW_MULTI mode can be done before allocating cgroup storage, so that if user tries to attach same program twice no alloc/free happens as it was before;
* pl_was_allocated becomes redundant so it's removed.
--- kernel/bpf/cgroup.c | 62 +++++++++++++++++---------------------------- 1 file changed, 23 insertions(+), 39 deletions(-)
kernel/bpf/cgroup.c +23 -39
@@ -295,9 +295,8 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,struct bpf_prog *old_prog =NULL ;struct bpf_cgroup_storage *storage[MAX_BPF_CGROUP_STORAGE_TYPE ], *old_storage[MAX_BPF_CGROUP_STORAGE_TYPE ] = {NULL }; +struct bpf_prog_list *pl, *replace_pl =NULL ;enum bpf_cgroup_storage_type stype; -struct bpf_prog_list *pl; -bool pl_was_allocated;int err;if ((flags &BPF_F_ALLOW_OVERRIDE ) && (flags &BPF_F_ALLOW_MULTI ))
@@ -317,6 +316,16 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog,if (prog_list_length (progs) >=BPF_CGROUP_MAX_PROGS )return -E2BIG ; +if (flags &BPF_F_ALLOW_MULTI ) { +list_for_each_entry (pl, progs, node) { +if (pl->prog == prog) +/* disallow attaching the same prog twice */ +return -EINVAL ; + } + }else if (!list_empty (progs)) { + replace_pl =list_first_entry (progs,typeof (*pl), node); + } +for_each_cgroup_storage_type (stype) { storage[stype] =bpf_cgroup_storage_alloc (prog, stype);if (IS_ERR (storage[stype])) {
@@ -327,52 +336,27 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog, } } -if (flags &BPF_F_ALLOW_MULTI ) { -list_for_each_entry (pl, progs, node) { -if (pl->prog == prog) { -/* disallow attaching the same prog twice */ -for_each_cgroup_storage_type (stype) -bpf_cgroup_storage_free (storage[stype]); -return -EINVAL ; - } +if (replace_pl) { + pl = replace_pl; + old_prog = pl->prog; +for_each_cgroup_storage_type (stype) { + old_storage[stype] = pl->storage[stype]; +bpf_cgroup_storage_unlink (old_storage[stype]); } - + }else { pl =kmalloc (sizeof (*pl),GFP_KERNEL );if (!pl) {for_each_cgroup_storage_type (stype)bpf_cgroup_storage_free (storage[stype]);return -ENOMEM ; } - - pl_was_allocated = true; - pl->prog = prog; -for_each_cgroup_storage_type (stype) - pl->storage[stype] = storage[stype];list_add_tail (&pl->node, progs); - }else { -if (list_empty (progs)) { - pl =kmalloc (sizeof (*pl),GFP_KERNEL ); -if (!pl) { -for_each_cgroup_storage_type (stype) -bpf_cgroup_storage_free (storage[stype]); -return -ENOMEM ; - } - pl_was_allocated = true; -list_add_tail (&pl->node, progs); - }else { - pl =list_first_entry (progs,typeof (*pl), node); - old_prog = pl->prog; -for_each_cgroup_storage_type (stype) { - old_storage[stype] = pl->storage[stype]; -bpf_cgroup_storage_unlink (old_storage[stype]); - } - pl_was_allocated = false; - } - pl->prog = prog; -for_each_cgroup_storage_type (stype) - pl->storage[stype] = storage[stype]; } + pl->prog = prog; +for_each_cgroup_storage_type (stype) + pl->storage[stype] = storage[stype]; + cgrp->bpf.flags[type] = flags; err =update_effective_progs (cgrp, type);
@@ -401,7 +385,7 @@ int __cgroup_bpf_attach(struct cgroup *cgrp, struct bpf_prog *prog, pl->storage[stype] = old_storage[stype];bpf_cgroup_storage_link (old_storage[stype], cgrp, type); } -if (pl_was_allocated) { +if (!replace_pl) {list_del (&pl->node);kfree (pl); }
Signature · 1 line
2.17.1
PATCH v2 6/6 selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
In reply to Andrey IgnatovTest replacement of a cgroup-bpf program attached with BPF_F_ALLOW_MULTI and possible failure modes: invalid combination of flags, invalid replace_bpf_fd, replacing a non-attachd to specified cgroup program.
Example of program replacing:
# gdb -q ./test_cgroup_attach Reading symbols from /data/users/rdna/bin/test_cgroup_attach...done. ... Breakpoint 1, test_multiprog () at test_cgroup_attach.c:443 443 test_cgroup_attach.c: No such file or directory. (gdb) [2]+ Stopped gdb -q ./test_cgroup_attach # bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 35 egress multi 36 egress multi # fg gdb -q ./test_cgroup_attach c Continuing. Detaching after fork from child process 361.
Breakpoint 2, test_multiprog () at test_cgroup_attach.c:454
454 in test_cgroup_attach.c
(gdb)
[2]+ Stopped gdb -q ./test_cgroup_attach
# bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 41 egress multi 36 egress multi
--- .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++++++++-- 1 file changed, 57 insertions(+), 5 deletions(-)
tools/testing/selftests/bpf/test_cgroup_attach.c +57 -5
@@ -250,7 +250,7 @@ static int prog_load_cnt(int verdict, int val)BPF_LD_MAP_FD (BPF_REG_1 , map_fd),BPF_RAW_INSN (BPF_JMP |BPF_CALL ,0 ,0 ,0 , BPF_FUNC_map_lookup_elem),BPF_JMP_IMM (BPF_JEQ ,BPF_REG_0 ,0 ,2 ), -BPF_MOV64_IMM (BPF_REG_1 , val),/* r1 = 1 */ +BPF_MOV64_IMM (BPF_REG_1 , val),/* r1 = val */ BPF_RAW_INSN (BPF_STX |BPF_XADD |BPF_DW ,BPF_REG_0 ,BPF_REG_1 ,0 ,0 ),/* xadd r0 += r1 */ BPF_LD_MAP_FD(BPF_REG_1, cgroup_storage_fd),
@@ -290,11 +290,11 @@ static int test_multiprog(void) {__u32 prog_ids[4 ], prog_cnt =0 , attach_flags, saved_prog_id;int cg1 =0 , cg2 =0 , cg3 =0 , cg4 =0 , cg5 =0 , key =0 ; -int drop_prog, allow_prog[6 ] = {}, rc =0 ; +int drop_prog, allow_prog[7 ] = {}, rc =0 ;unsigned long long value;int i =0 ; -for (i =0 ; i <6 ; i++) { +for (i =0 ; i <ARRAY_SIZE (allow_prog); i++) { allow_prog[i] =prog_load_cnt (1 ,1 << i);if (!allow_prog[i]) goto err;
@@ -400,6 +400,58 @@ static int test_multiprog(void)assert (bpf_map_lookup_elem (map_fd, &key, &value) ==0 );assert (value ==1 +2 +8 +16 ); +/* invalid input */ + +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, attach_opts, + .target_fd = cg1, + .prog_fd = allow_prog[6], + .replace_prog_fd = allow_prog[0], + .type = BPF_CGROUP_INET_EGRESS, + .flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE, + ); + + attach_opts.flags =BPF_F_ALLOW_OVERRIDE |BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with OVERRIDE | REPLACE" ); + goto err; + } +assert (errno ==EINVAL ); + + attach_opts.flags =BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with REPLACE alone" ); + goto err; + } +assert (errno ==EINVAL ); + attach_opts.flags =BPF_F_ALLOW_MULTI |BPF_F_REPLACE ; + + attach_opts.replace_prog_fd =-1 ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with bad replace fd" ); + goto err; + } +assert (errno ==EBADF ); + +/* replacing a program that is not attached to cgroup should fail */ + attach_opts.replace_prog_fd = allow_prog[3 ]; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success: replace not-attached prog on cg1" ); + goto err; + } +assert (errno ==ENOENT ); + attach_opts.replace_prog_fd = allow_prog[0 ]; + +/* replace 1st from the top program */ +if (bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Replace prog1 with prog7 on cg1" ); + goto err; + } + value =0 ; +assert (bpf_map_update_elem (map_fd, &key, &value,0 ) ==0 ); +assert (system (PING_CMD ) ==0 ); +assert (bpf_map_lookup_elem (map_fd, &key, &value) ==0 ); +assert (value ==64 +2 +8 +16 ); +/* detach 3rd from bottom program and ping again */ errno =0 ;if (!bpf_prog_detach2 (0 , cg3,BPF_CGROUP_INET_EGRESS )) {
@@ -414,7 +466,7 @@ static int test_multiprog(void)assert (bpf_map_update_elem (map_fd, &key, &value,0 ) ==0 );assert (system (PING_CMD ) ==0 );assert (bpf_map_lookup_elem (map_fd, &key, &value) ==0 ); -assert (value ==1 +2 +16 ); +assert (value ==64 +2 +16 );/* detach 2nd from bottom program and ping again */ if (bpf_prog_detach2 (-1 , cg4,BPF_CGROUP_INET_EGRESS )) {
@@ -425,7 +477,7 @@ static int test_multiprog(void)assert (bpf_map_update_elem (map_fd, &key, &value,0 ) ==0 );assert (system (PING_CMD ) ==0 );assert (bpf_map_lookup_elem (map_fd, &key, &value) ==0 ); -assert (value ==1 +2 +4 ); +assert (value ==64 +2 +4 ); prog_cnt =4 ; assert(bpf_prog_query(cg5, BPF_CGROUP_INET_EGRESS, BPF_F_QUERY_EFFECTIVE,
Signature · 1 line
2.17.1
Quoted 9 lines · Andrey Ignatov
v1->v2:
- moveDECLARE_LIBBPF_OPTSfromlibbpf.htobpf.h(patch 4);
- switch new libbpf API to OPTS framework;
- switch selftest to libbpf OPTS framework.This patch set adds support for replacing cgroup-bpf programs attached with
BPF_F_ALLOW_MULTIflag so that any program in a list can be updated to a new version without service interruption and order of programs can be preserved.
Quoted 8 lines
Please see patch 3 for details on the use-case and API changes.
Other patches:
Patch 1 is preliminary refactoring of__cgroup_bpf_attachto simplify it. Patch 2 is minor cleanup ofhierarchy_allows_attach.
Patch 4 movesDECLARE_LIBBPF_OPTSfromlibbpf.htobpf.hPatch 5 extends libbpf API to support new set of attach attributes. Patch 6 adds selftest coverage for the new API.
lgtm.
Andrii, please review patches 4 and 5.
I think patch 6 is ok for now, but please consider converting it to test_progs in the future.
Re: [PATCH v2 bpf-next 4/6] libbpf: Make DECLARE_LIBBPF_OPTS available in bpf.h
In reply to Andrey IgnatovQuoted 17 lines · Andrey Ignatov
DECLARE_LIBBPF_OPTSis the way to use option structures in a backward compatible and extensible way. It's available only inlibbpf.h. Though public interfaces inbpf.hhave the same requirement to accept options in a way that can be simply extended w/o introducing new xattr-functions every time.
libbpf.cdepends onbpf.h, hence to share the macros a couple of options exist:
* either a common header should be introduced;
* or the macro can be moved tobpf.hand used bylibbpf.hfrom there;The former seems to be an overkill, so do the latter:
* moveDECLARE_LIBBPF_OPTSfromlibbpf.htobpf.h;
* move#include "bpf.h"fromlibbpf.ctolibbpf.hnot to break users of the macro who already include onlylibbpf.h.
Quoted 5 lines
That makes the macro available to use in bpf.{h,c} and should not break those who already use it.
Signed-off-by Andrey Ignatov <[email protected]>---
LGTM.
Quoted 5 lines
tools/lib/bpf/bpf.h | 22 ++++++++++++++++++++++ tools/lib/bpf/libbpf.c | 1 - tools/lib/bpf/libbpf.h | 24 ++---------------------- 3 files changed, 24 insertions(+), 23 deletions(-)
[...]
Re: [PATCH v2 bpf-next 5/6] libbpf: Introduce bpf_prog_attach_xattr
In reply to Andrey IgnatovQuoted 35 lines · Andrey Ignatov
Introduce a new
bpf_prog_attach_xattrfunction that accepts an extendable structbpf_prog_attach_optsand supports passing a new attribute toBPF_PROG_ATTACHcommand:replace_prog_fdthat is fd of previously attached cgroup-bpf program to replace if recently introducedBPF_F_REPLACEflag is used.The new function is named to be consistent with other xattr-functions (
bpf_prog_test_run_xattr,bpf_create_map_xattr,bpf_load_program_xattr).The struct
bpf_prog_attach_optsis supposed to be used withDECLARE_LIBBPF_OPTSframework.The opts argument is used directly in
bpf_prog_attach_xattrimplementation since at the time of adding all fields already exist in the kernel. New fields, if added, will need to be used via OPTS_* macros fromlibbpf_internal.h.Signed-off-by Andrey Ignatov <[email protected]>--- tools/lib/bpf/bpf.c | 21 +++++++++++++++++---- tools/lib/bpf/bpf.h | 12 ++++++++++++ tools/lib/bpf/libbpf.map | 2 ++ 3 files changed, 31 insertions(+), 4 deletions(-)tools/lib/bpf/bpf.c +2
-0@@ -466,14 +466,27 @@ int bpf_obj_get(const char *pathname)int bpf_prog_attach (int prog_fd,int target_fd,enum bpf_attach_type type,unsigned int flags) +{ + DECLARE_LIBBPF_OPTS(bpf_prog_attach_opts, opts,
tools/lib/bpf/bpf.c int bpf_obj_get(const char *pathname) · line 480
Quoted 10 lines
tools/lib/bpf/bpf.c +10
-0+ .target_fd = target_fd, + .prog_fd = prog_fd, + .type = type, + .flags = flags, + ); + +return bpf_prog_attach_xattr (&opts); +} + +int bpf_prog_attach_xattr (const struct bpf_prog_attach_opts *opts)
When we discussed this whole OPTS idea, we agreed that specifying mandatory arguments as is makes for better usability. All the optional stuff then is moved into opts (and then extended indefinitely, because all the newly added stuff has to be optional, at least for some subset of arguments).
So if we were to follow those unofficial "guidelines", bpf_prog_attach_xattr would be defined as:
int bpf_prog_attach_xattr(int prog_fd, int target_fd, enum bpf_attach_type type,
const struct bpf_prog_attach_opts *opts);
, where opts has flags and replace_bpf_fd right now.
Naming wise, it's quite departure from xattr approach, so I'd probably would go with bpf_prog_attach_opts, but I won't insist.
WDYT?
Quoted 55 lines
tools/lib/bpf/bpf.c +5
-4{union bpf_attr attr;memset (&attr,0 ,sizeof (attr)); - attr.target_fd = target_fd; - attr.attach_bpf_fd = prog_fd; - attr.attach_type = type; - attr.attach_flags = flags; + attr.target_fd = opts->target_fd; + attr.attach_bpf_fd = opts->prog_fd; + attr.attach_type = opts->type; + attr.attach_flags = opts->flags; + attr.replace_bpf_fd = opts->replace_prog_fd;return sys_bpf (BPF_PROG_ATTACH , &attr,sizeof (attr)); }tools/lib/bpf/bpf.h +12
-0@@ -150,8 +150,20 @@ LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); LIBBPF_API int bpf_map_freeze(int fd); LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); LIBBPF_API int bpf_obj_get(const char *pathname); + +struct bpf_prog_attach_opts { +size_t sz;/* size of this struct for forward/backward compatibility */ +int target_fd; +int prog_fd; +enum bpf_attach_type type; +unsigned int flags; +int replace_prog_fd; +}; +#define bpf_prog_attach_opts__last_field replace_prog_fd + LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,enum bpf_attach_type type,unsigned int flags); +LIBBPF_API int bpf_prog_attach_xattr(const struct bpf_prog_attach_opts *opts); LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,enum bpf_attach_type type);tools/lib/bpf/libbpf.map +2
-1@@ -210,4 +210,6 @@ LIBBPF_0.0.6 { } LIBBPF_0.0.5; LIBBPF_0.0.7 { + global: + bpf_prog_attach_xattr; } LIBBPF_0.0.6; --2.17.1
Re: [PATCH v2 bpf-next 6/6] selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
In reply to Andrey IgnatovQuoted 32 lines · Andrey Ignatov
Test replacement of a cgroup-bpf program attached with
BPF_F_ALLOW_MULTIand possible failure modes: invalid combination of flags, invalidreplace_bpf_fd, replacing a non-attachd to specified cgroup program.Example of program replacing:
# gdb -q ./test_cgroup_attach Reading symbols from /data/users/rdna/bin/test_cgroup_attach...done. ... Breakpoint 1, test_multiprog () at test_cgroup_attach.c:443 443 test_cgroup_attach.c: No such file or directory. (gdb) [2]+ Stopped gdb -q ./test_cgroup_attach # bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 35 egress multi 36 egress multi # fg gdb -q ./test_cgroup_attach c Continuing. Detaching after fork from child process 361.Breakpoint 2,
test_multiprog() at test_cgroup_attach.c:454
454 intest_cgroup_attach.c
(gdb)
[2]+ Stopped gdb -q ./test_cgroup_attach# bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 41 egress multi 36 egress multi
Quoted 5 lines
Signed-off-by Andrey Ignatov <[email protected]>--- .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++++++++-- 1 file changed, 57 insertions(+), 5 deletions(-)
I second Alexei's sentiment. Having this as part of test_progs would certainly be better in terms of ensuring this doesn't accidentally breaks.
[...]
tools/testing/selftests/bpf/test_cgroup_attach.c static int test_multiprog(void) · line 411
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +9
-0+/* invalid input */ + +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, attach_opts, + .target_fd = cg1, + .prog_fd = allow_prog[6], + .replace_prog_fd = allow_prog[0], + .type = BPF_CGROUP_INET_EGRESS, + .flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE, + );
This might cause compiler warnings (depending on compiler settings, of course). DECLARE_LIBBPF_OPTS does declare variable, so this is a situation of mixing code and variable declarations, which under C89 (or whatever it's named, the older standard that kernel is trying to stick to for the most part) is not allowed.
Quoted 8 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +8
-0+ + attach_opts.flags =BPF_F_ALLOW_OVERRIDE |BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with OVERRIDE | REPLACE" ); + goto err; + } +assert (errno ==EINVAL ); +
Re: [PATCH v2 bpf-next 5/6] libbpf: Introduce bpf_prog_attach_xattr
In reply to Andrii NakryikoAndrii Nakryiko <[email protected]> [Thu, 2019-12-12 22:58 -0800]:
Quoted 53 lines · Andrey Ignatov
Quoted 35 lines
Introduce a new
bpf_prog_attach_xattrfunction that accepts an extendable structbpf_prog_attach_optsand supports passing a new attribute toBPF_PROG_ATTACHcommand:replace_prog_fdthat is fd of previously attached cgroup-bpf program to replace if recently introducedBPF_F_REPLACEflag is used.The new function is named to be consistent with other xattr-functions (
bpf_prog_test_run_xattr,bpf_create_map_xattr,bpf_load_program_xattr).The struct
bpf_prog_attach_optsis supposed to be used withDECLARE_LIBBPF_OPTSframework.The opts argument is used directly in
bpf_prog_attach_xattrimplementation since at the time of adding all fields already exist in the kernel. New fields, if added, will need to be used via OPTS_* macros fromlibbpf_internal.h.Signed-off-by Andrey Ignatov <[email protected]>--- tools/lib/bpf/bpf.c | 21 +++++++++++++++++---- tools/lib/bpf/bpf.h | 12 ++++++++++++ tools/lib/bpf/libbpf.map | 2 ++ 3 files changed, 31 insertions(+), 4 deletions(-)tools/lib/bpf/bpf.c +2
-0@@ -466,14 +466,27 @@ int bpf_obj_get(const char *pathname)int bpf_prog_attach (int prog_fd,int target_fd,enum bpf_attach_type type,unsigned int flags) +{ + DECLARE_LIBBPF_OPTS(bpf_prog_attach_opts, opts,tools/lib/bpf/bpf.c int bpf_obj_get(const char *pathname) · line 480
Quoted 10 lines
tools/lib/bpf/bpf.c +10
-0+ .target_fd = target_fd, + .prog_fd = prog_fd, + .type = type, + .flags = flags, + ); + +return bpf_prog_attach_xattr (&opts); +} + +int bpf_prog_attach_xattr (const struct bpf_prog_attach_opts *opts)When we discussed this whole OPTS idea, we agreed that specifying mandatory arguments as is makes for better usability. All the optional stuff then is moved into opts (and then extended indefinitely, because all the newly added stuff has to be optional, at least for some subset of arguments).
Quoted 7 lines
So if we were to follow those unofficial "guidelines",
bpf_prog_attach_xattrwould be defined as:int bpf_prog_attach_xattr(int
prog_fd, inttarget_fd, enumbpf_attach_typetype,const struct bpf_prog_attach_opts *opts);, where opts has flags and
replace_bpf_fdright now.
Oh, I see, I think I missed the "mandatory vs optional" part of your comment and took only the "switching to options" as the main idea, but now I see it. Sorry.
Though thinking more about it, I'm not sure it'd buy us much in this specific case. "Required" arguments are set in stone and can't be changed, but the API already has a version of function with this same list of required arguments:
LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
enum bpf_attach_type type, unsigned int flags);
As a user, I'd rather use bpf_prog_attach() if I don't need optional arguments (what, also, has shorted name).
Adding another very similar one with same list of arguments + optional ones would make it so that it'd never be used in the case when no optional arguments are needed.
Yeah, I saw you comment on the flags, but flags are needed quite often (not BPF_F_REPLACE, but BPF_F_ALLOW_OVERRIDE and BPF_F_ALLOW_MULTI), so I'm not sure about moving flags to optional.
The last point brings another point that such a separation, "required" / "optional", may be quite biased according to use-cases users mostly deal with and may start making less sense over time when more arguments are added to optional that are "highly recommended to use".
On the other hand if we just do one single struct argument, there won't be this problem how to separate required and optional wht both the current set of arguments and whatever is added in the future.
Quoted 2 lines
Naming wise, it's quite departure from xattr approach, so I'd probably would go with
bpf_prog_attach_opts, but I won't insist.
Yeah, agree that it's not quite "xattr". I don't have strong preferences here, just used the prefix that is already used in the API. I can't rename it to bpf_prog_attach_opts though, because there is a structure with the same name :) but if there is a better name, happy to rename it. I had an option bpf_prog_attach2 (similar to existing bpf_prog_detach2) but IMO it's worse.
Quoted 57 lines
WDYT?
Quoted 55 lines
tools/lib/bpf/bpf.c +5
-4{union bpf_attr attr;memset (&attr,0 ,sizeof (attr)); - attr.target_fd = target_fd; - attr.attach_bpf_fd = prog_fd; - attr.attach_type = type; - attr.attach_flags = flags; + attr.target_fd = opts->target_fd; + attr.attach_bpf_fd = opts->prog_fd; + attr.attach_type = opts->type; + attr.attach_flags = opts->flags; + attr.replace_bpf_fd = opts->replace_prog_fd;return sys_bpf (BPF_PROG_ATTACH , &attr,sizeof (attr)); }tools/lib/bpf/bpf.h +12
-0@@ -150,8 +150,20 @@ LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); LIBBPF_API int bpf_map_freeze(int fd); LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); LIBBPF_API int bpf_obj_get(const char *pathname); + +struct bpf_prog_attach_opts { +size_t sz;/* size of this struct for forward/backward compatibility */ +int target_fd; +int prog_fd; +enum bpf_attach_type type; +unsigned int flags; +int replace_prog_fd; +}; +#define bpf_prog_attach_opts__last_field replace_prog_fd + LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,enum bpf_attach_type type,unsigned int flags); +LIBBPF_API int bpf_prog_attach_xattr(const struct bpf_prog_attach_opts *opts); LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,enum bpf_attach_type type);tools/lib/bpf/libbpf.map +2
-1@@ -210,4 +210,6 @@ LIBBPF_0.0.6 { } LIBBPF_0.0.5; LIBBPF_0.0.7 { + global: + bpf_prog_attach_xattr; } LIBBPF_0.0.6; --2.17.1
Signature · 1 line
Andrey Ignatov
Re: [PATCH v2 bpf-next 5/6] libbpf: Introduce bpf_prog_attach_xattr
Quoted 73 lines · Andrey Ignatov
Andrii Nakryiko <[email protected]> [Thu, 2019-12-12 22:58 -0800]:
Quoted 53 lines · Andrey Ignatov
Quoted 35 lines
Introduce a new
bpf_prog_attach_xattrfunction that accepts an extendable structbpf_prog_attach_optsand supports passing a new attribute toBPF_PROG_ATTACHcommand:replace_prog_fdthat is fd of previously attached cgroup-bpf program to replace if recently introducedBPF_F_REPLACEflag is used.The new function is named to be consistent with other xattr-functions (
bpf_prog_test_run_xattr,bpf_create_map_xattr,bpf_load_program_xattr).The struct
bpf_prog_attach_optsis supposed to be used withDECLARE_LIBBPF_OPTSframework.The opts argument is used directly in
bpf_prog_attach_xattrimplementation since at the time of adding all fields already exist in the kernel. New fields, if added, will need to be used via OPTS_* macros fromlibbpf_internal.h.Signed-off-by Andrey Ignatov <[email protected]>--- tools/lib/bpf/bpf.c | 21 +++++++++++++++++---- tools/lib/bpf/bpf.h | 12 ++++++++++++ tools/lib/bpf/libbpf.map | 2 ++ 3 files changed, 31 insertions(+), 4 deletions(-)tools/lib/bpf/bpf.c +2
-0@@ -466,14 +466,27 @@ int bpf_obj_get(const char *pathname)int bpf_prog_attach (int prog_fd,int target_fd,enum bpf_attach_type type,unsigned int flags) +{ + DECLARE_LIBBPF_OPTS(bpf_prog_attach_opts, opts,tools/lib/bpf/bpf.c int bpf_obj_get(const char *pathname) · line 480
Quoted 10 lines
tools/lib/bpf/bpf.c +10
-0+ .target_fd = target_fd, + .prog_fd = prog_fd, + .type = type, + .flags = flags, + ); + +return bpf_prog_attach_xattr (&opts); +} + +int bpf_prog_attach_xattr (const struct bpf_prog_attach_opts *opts)When we discussed this whole OPTS idea, we agreed that specifying mandatory arguments as is makes for better usability. All the optional stuff then is moved into opts (and then extended indefinitely, because all the newly added stuff has to be optional, at least for some subset of arguments).
Quoted 7 lines
So if we were to follow those unofficial "guidelines",
bpf_prog_attach_xattrwould be defined as:int bpf_prog_attach_xattr(int
prog_fd, inttarget_fd, enumbpf_attach_typetype,const struct bpf_prog_attach_opts *opts);, where opts has flags and
replace_bpf_fdright now.Oh, I see, I think I missed the "mandatory vs optional" part of your comment and took only the "switching to options" as the main idea, but now I see it. Sorry.
Though thinking more about it, I'm not sure it'd buy us much in this specific case. "Required" arguments are set in stone and can't be changed, but the API already has a version of function with this same list of required arguments:
LIBBPF_APIint bpf_prog_attach(intprog_fd, intattachable_fd,
Quoted 8 lines
enum bpf_attach_type type, unsigned int flags);As a user, I'd rather use
bpf_prog_attach()if I don't need optional arguments (what, also, has shorted name).Adding another very similar one with same list of arguments + optional ones would make it so that it'd never be used in the case when no optional arguments are needed.
Yeah, no problem with that, it's not changing or going anywhere, so I don't see why not. It's not like we have to force all the users to switch to _opts() variants, if old ones work just fine.
Quoted 4 lines
Yeah, I saw you comment on the flags, but flags are needed quite often (not
BPF_F_REPLACE, butBPF_F_ALLOW_OVERRIDEandBPF_F_ALLOW_MULTI), so I'm not sure about moving flags to optional.
if it's used often in practice, I'd leave it as explicit argument then.
Quoted 9 lines
The last point brings another point that such a separation, "required" / "optional", may be quite biased according to use-cases users mostly deal with and may start making less sense over time when more arguments are added to optional that are "highly recommended to use".
On the other hand if we just do one single struct argument, there won't be this problem how to separate required and optional wht both the current set of arguments and whatever is added in the future.
Well, it's not a black and white thing. Take bpf_prog_load_xattr() as an example. The fact that I'm specifying file path as part of xattr is super confusing to me, so I'd rather have it as file path + options instead. The benefit of listing those mandatory arguments explicitly is that it's very clear which parts user cannot forget to specify. Surely, some of the added "optional" ones might be mandatory under some conditions (e.g., when some specific flags are specified), but that's a bit different (they are conditionally mandatory ;) ). So having explicit args before options serves double purpose of extra documentation and making common use cases more succinct.
Quoted 9 lines
Quoted 4 lines
Naming wise, it's quite departure from xattr approach, so I'd probably would go with
bpf_prog_attach_opts, but I won't insist.Yeah, agree that it's not quite "xattr". I don't have strong preferences here, just used the prefix that is already used in the API. I can't rename it to
bpf_prog_attach_optsthough, because there is a structure with the same name :) but if there is a better name, happy to rename it.
You sure that's a problem? struct names are in separate namespace from typedefs and functions, so it will work. But sticking to xattr for low-level stuff is fine by me as well.
Quoted 64 lines
I had an option
bpf_prog_attach2(similar to existingbpf_prog_detach2) but IMO it's worse.Quoted 50 lines
WDYT?
Quoted 48 lines
tools/lib/bpf/bpf.c +5
-4{union bpf_attr attr;memset (&attr,0 ,sizeof (attr)); - attr.target_fd = target_fd; - attr.attach_bpf_fd = prog_fd; - attr.attach_type = type; - attr.attach_flags = flags; + attr.target_fd = opts->target_fd; + attr.attach_bpf_fd = opts->prog_fd; + attr.attach_type = opts->type; + attr.attach_flags = opts->flags; + attr.replace_bpf_fd = opts->replace_prog_fd;return sys_bpf (BPF_PROG_ATTACH , &attr,sizeof (attr)); }tools/lib/bpf/bpf.h +12
-0@@ -150,8 +150,20 @@ LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); LIBBPF_API int bpf_map_freeze(int fd); LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); LIBBPF_API int bpf_obj_get(const char *pathname); + +struct bpf_prog_attach_opts { +size_t sz;/* size of this struct for forward/backward compatibility */ +int target_fd; +int prog_fd; +enum bpf_attach_type type; +unsigned int flags; +int replace_prog_fd; +}; +#define bpf_prog_attach_opts__last_field replace_prog_fd + LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,enum bpf_attach_type type,unsigned int flags); +LIBBPF_API int bpf_prog_attach_xattr(const struct bpf_prog_attach_opts *opts); LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,enum bpf_attach_type type);tools/lib/bpf/libbpf.map +0
-0@@ -210,4 +210,6 @@ LIBBPF_0.0.6 { } LIBBPF_0.0.5;Quoted 7 lines
Quoted 7 lines
tools/lib/bpf/libbpf.map +2
-1LIBBPF_0.0.7 { + global: + bpf_prog_attach_xattr; } LIBBPF_0.0.6; --2.17.1
--
Andrey Ignatov
Re: [PATCH v2 bpf-next 6/6] selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
In reply to Andrii NakryikoAndrii Nakryiko <[email protected]> [Thu, 2019-12-12 23:01 -0800]:
Quoted 39 lines · Andrey Ignatov
Quoted 32 lines
Test replacement of a cgroup-bpf program attached with
BPF_F_ALLOW_MULTIand possible failure modes: invalid combination of flags, invalidreplace_bpf_fd, replacing a non-attachd to specified cgroup program.Example of program replacing:
# gdb -q ./test_cgroup_attach Reading symbols from /data/users/rdna/bin/test_cgroup_attach...done. ... Breakpoint 1, test_multiprog () at test_cgroup_attach.c:443 443 test_cgroup_attach.c: No such file or directory. (gdb) [2]+ Stopped gdb -q ./test_cgroup_attach # bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 35 egress multi 36 egress multi # fg gdb -q ./test_cgroup_attach c Continuing. Detaching after fork from child process 361.Breakpoint 2,
test_multiprog() at test_cgroup_attach.c:454
454 intest_cgroup_attach.c
(gdb)
[2]+ Stopped gdb -q ./test_cgroup_attach# bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 41 egress multi 36 egress multiQuoted 5 lines
Signed-off-by Andrey Ignatov <[email protected]>--- .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++++++++-- 1 file changed, 57 insertions(+), 5 deletions(-)
Quoted 3 lines
I second Alexei's sentiment. Having this as part of
test_progswould certainly be better in terms of ensuring this doesn't accidentally breaks.
OK, I converted both existing test_cgroup_attach and my test for BPF_F_REPLACE to test_progs and will send v3 with this change.
Quoted 13 lines
[...]
tools/testing/selftests/bpf/test_cgroup_attach.c static int test_multiprog(void) · line 411
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +9
-0+/* invalid input */ + +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, attach_opts, + .target_fd = cg1, + .prog_fd = allow_prog[6], + .replace_prog_fd = allow_prog[0], + .type = BPF_CGROUP_INET_EGRESS, + .flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE, + );
Quoted 5 lines
This might cause compiler warnings (depending on compiler settings, of course).
DECLARE_LIBBPF_OPTSdoes declare variable, so this is a situation of mixing code and variable declarations, which under C89 (or whatever it's named, the older standard that kernel is trying to stick to for the most part) is not allowed.
Yeah, I know about such a warning and expected it but didn't get it with the current setup (what surprised me btw) and decided to keep it.
The main reason I kept it is it's not actually clear how to separate declaration and initialization of opts structure when DECLARE_LIBBPF_OPTS is used since the macro does both things at once. In selftests I can just switch to direct initialization (w/o the macro) since libbpf and selftests are in sync, but for real use-cases there should be smth else (e.g. INIT_LIBBPF_OPTS macro that does only initialization of already declared struct).
Quoted 8 lines
Quoted 8 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +8
-0+ + attach_opts.flags =BPF_F_ALLOW_OVERRIDE |BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with OVERRIDE | REPLACE" ); + goto err; + } +assert (errno ==EINVAL ); +
Signature · 1 line
Andrey Ignatov
Re: [PATCH v2 bpf-next 6/6] selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
Quoted 41 lines · Andrey Ignatov
Andrii Nakryiko <[email protected]> [Thu, 2019-12-12 23:01 -0800]:
Quoted 39 lines · Andrey Ignatov
Quoted 37 lines
Test replacement of a cgroup-bpf program attached with
BPF_F_ALLOW_MULTIand possible failure modes: invalid combination of flags, invalidreplace_bpf_fd, replacing a non-attachd to specified cgroup program.Example of program replacing:
# gdb -q ./test_cgroup_attach Reading symbols from /data/users/rdna/bin/test_cgroup_attach...done. ... Breakpoint 1, test_multiprog () at test_cgroup_attach.c:443 443 test_cgroup_attach.c: No such file or directory. (gdb) [2]+ Stopped gdb -q ./test_cgroup_attach # bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 35 egress multi 36 egress multi # fg gdb -q ./test_cgroup_attach c Continuing. Detaching after fork from child process 361.Breakpoint 2,
test_multiprog() at test_cgroup_attach.c:454
454 intest_cgroup_attach.c
(gdb)
[2]+ Stopped gdb -q ./test_cgroup_attach# bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 41 egress multi 36 egress multiSigned-off-by Andrey Ignatov <[email protected]>--- .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++++++++-- 1 file changed, 57 insertions(+), 5 deletions(-)
Quoted 7 lines
Quoted 3 lines
I second Alexei's sentiment. Having this as part of
test_progswould certainly be better in terms of ensuring this doesn't accidentally breaks.OK, I converted both existing
test_cgroup_attachand my test forBPF_F_REPLACEtotest_progsand will send v3 with this change.
Great, thanks!
Quoted 14 lines
Quoted 14 lines
[...]
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +9
-0+/* invalid input */ + +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, attach_opts, + .target_fd = cg1, + .prog_fd = allow_prog[6], + .replace_prog_fd = allow_prog[0], + .type = BPF_CGROUP_INET_EGRESS, + .flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE, + );
Quoted 8 lines
Quoted 5 lines
This might cause compiler warnings (depending on compiler settings, of course).
DECLARE_LIBBPF_OPTSdoes declare variable, so this is a situation of mixing code and variable declarations, which under C89 (or whatever it's named, the older standard that kernel is trying to stick to for the most part) is not allowed.Yeah, I know about such a warning and expected it but didn't get it with the current setup (what surprised me btw) and decided to keep it.
yeah, selftests compiler flags must not be as strict as kernel's, I guess?...
Quoted 8 lines
The main reason I kept it is it's not actually clear how to separate declaration and initialization of opts structure when
DECLARE_LIBBPF_OPTSis used since the macro does both things at once. In selftests I can just switch to direct initialization (w/o the macro) since libbpf and selftests are in sync, but for real use-cases there should be smth else (e.g.INIT_LIBBPF_OPTSmacro that does only initialization of already declared struct).
For compiler, DECLARE_LIBBPF_OPTS is purely declaration, in the same sense as struct declaration+initialization is still just declaration. If you need to postpone some of the field initialization, then you can do that by assinging that field explicitly:
DECLARE_LIBBPF_OPTS(bpf_prog_attach_opts, attach_opts,
.target_fd = cgl,
);
... some code here ...
attach_opts.prog_fd = allow_prog[6];
It is just a struct, DECLARE_LIBBPF_OPTS just hides memset to 0 and setting .sz correctly, nothing more.
Quoted 13 lines
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c static int test_multiprog(void) · line 419
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +8
-0+ + attach_opts.flags =BPF_F_ALLOW_OVERRIDE |BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with OVERRIDE | REPLACE" ); + goto err; + } +assert (errno ==EINVAL ); +--
Andrey Ignatov
Re: [PATCH v2 bpf-next 6/6] selftests/bpf: Cover BPF_F_REPLACE in test_cgroup_attach
Andrii Nakryiko <[email protected]> [Wed, 2019-12-18 09:25 -0800]:
Quoted 72 lines · Andrey Ignatov
Quoted 41 lines
Andrii Nakryiko <[email protected]> [Thu, 2019-12-12 23:01 -0800]:
Quoted 39 lines · Andrey Ignatov
Quoted 37 lines
Test replacement of a cgroup-bpf program attached with
BPF_F_ALLOW_MULTIand possible failure modes: invalid combination of flags, invalidreplace_bpf_fd, replacing a non-attachd to specified cgroup program.Example of program replacing:
# gdb -q ./test_cgroup_attach Reading symbols from /data/users/rdna/bin/test_cgroup_attach...done. ... Breakpoint 1, test_multiprog () at test_cgroup_attach.c:443 443 test_cgroup_attach.c: No such file or directory. (gdb) [2]+ Stopped gdb -q ./test_cgroup_attach # bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 35 egress multi 36 egress multi # fg gdb -q ./test_cgroup_attach c Continuing. Detaching after fork from child process 361.Breakpoint 2,
test_multiprog() at test_cgroup_attach.c:454
454 intest_cgroup_attach.c
(gdb)
[2]+ Stopped gdb -q ./test_cgroup_attach# bpftool c s /mnt/cgroup2/cgroup-test-work-dir/cg1 ID AttachType AttachFlags Name 41 egress multi 36 egress multiSigned-off-by Andrey Ignatov <[email protected]>--- .../selftests/bpf/test_cgroup_attach.c | 62 +++++++++++++++++-- 1 file changed, 57 insertions(+), 5 deletions(-)Quoted 7 lines
Quoted 3 lines
I second Alexei's sentiment. Having this as part of
test_progswould certainly be better in terms of ensuring this doesn't accidentally breaks.OK, I converted both existing
test_cgroup_attachand my test forBPF_F_REPLACEtotest_progsand will send v3 with this change.Great, thanks!
Quoted 20 lines
Quoted 19 lines
[...]
tools/testing/selftests/bpf/test_cgroup_attach.c static int test_multiprog(void) · line 411
Quoted 10 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +9
-0+/* invalid input */ + +DECLARE_LIBBPF_OPTS (bpf_prog_attach_opts, attach_opts, + .target_fd = cg1, + .prog_fd = allow_prog[6], + .replace_prog_fd = allow_prog[0], + .type = BPF_CGROUP_INET_EGRESS, + .flags = BPF_F_ALLOW_MULTI | BPF_F_REPLACE, + );This might cause compiler warnings (depending on compiler settings, of course).
DECLARE_LIBBPF_OPTSdoes declare variable, so this is a situation of mixing code and variable declarations, which under C89 (or whatever it's named, the older standard that kernel is trying to stick to for the most part) is not allowed.
Quoted 4 lines
Quoted 2 lines
Yeah, I know about such a warning and expected it but didn't get it with the current setup (what surprised me btw) and decided to keep it.
yeah, selftests compiler flags must not be as strict as kernel's, I guess?...
That I don't know :) I thought they should be similar but apparently it's not the case.
Quoted 18 lines
Quoted 7 lines
The main reason I kept it is it's not actually clear how to separate declaration and initialization of opts structure when
DECLARE_LIBBPF_OPTSis used since the macro does both things at once. In selftests I can just switch to direct initialization (w/o the macro) since libbpf and selftests are in sync, but for real use-cases there should be smth else (e.g.INIT_LIBBPF_OPTSmacro that does only initialization of already declared struct).For compiler,
DECLARE_LIBBPF_OPTSis purely declaration, in the same sense as struct declaration+initialization is still just declaration. If you need to postpone some of the field initialization, then you can do that by assinging that field explicitly:DECLARE_LIBBPF_OPTS(bpf_prog_attach_opts,
attach_opts,
.target_fd = cgl,
);
Quoted 5 lines
... some code here ...
attach_opts.prog_fd = allow_prog[6];It is just a struct,
DECLARE_LIBBPF_OPTSjust hides memset to 0 and setting .sz correctly, nothing more.
Lol that makes sense of course. I'm not sure why I decided that all fields should be specified in DECLARE_LIBBPF_OPTS() at once .. Thanks!
Quoted 11 lines
Quoted 11 lines
Quoted 8 lines
tools/testing/selftests/bpf/test_cgroup_attach.c static int test_multiprog(void) · line 419
Quoted 8 lines
tools/testing/selftests/bpf/test_cgroup_attach.c +8
-0+ + attach_opts.flags =BPF_F_ALLOW_OVERRIDE |BPF_F_REPLACE ; +if (!bpf_prog_attach_xattr (&attach_opts)) { +log_err ("Unexpected success with OVERRIDE | REPLACE" ); + goto err; + } +assert (errno ==EINVAL ); +--
Andrey Ignatov
Signature · 1 line
Andrey Ignatov