Commit f4d05259 authored by Martin KaFai Lau's avatar Martin KaFai Lau Committed by Daniel Borkmann
Browse files

bpf: Add map_meta_equal map ops 

Some properties of the inner map is used in the verification time.
When an inner map is inserted to an outer map at runtime,
bpf_map_meta_equal() is currently used to ensure those properties
of the inserting inner map stays the same as the verification
time.

In particular, the current bpf_map_meta_equal() checks max_entries which
turns out to be too restrictive for most of the maps which do not use
max_entries during the verification time.  It limits the use case that
wants to replace a smaller inner map with a larger inner map.  There are
some maps do use max_entries during verification though.  For example,
the map_gen_lookup in array_map_ops uses the max_entries to generate
the inline lookup code.

To accommodate differences between maps, the map_meta_equal is added
to bpf_map_ops.  Each map-type can decide what to check when its
map is used as an inner map during runtime.

Also, some map types cannot be used as an inner map and they are
currently black listed in bpf_map_meta_alloc() in map_in_map.c.
It is not unusual that the new map types may not aware that such
blacklist exists.  This patch enforces an explicit opt-in
and only allows a map to be used as an inner map if it has
implemented the map_meta_equal ops.  It is based on the
discussion in [1].

All maps that support inner map has its map_meta_equal points
to bpf_map_meta_equal in this patch.  A later patch will
relax the max_entries check for most maps.  bpf_types.h
counts 28 map types.  This patch adds 23 ".map_meta_equal"
by using coccinelle.  -5 for
	BPF_MAP_TYPE_PROG_ARRAY
	BPF_MAP_TYPE_(PERCPU)_CGROUP_STORAGE
	BPF_MAP_TYPE_STRUCT_OPS
	BPF_MAP_TYPE_ARRAY_OF_MAPS
	BPF_MAP_TYPE_HASH_OF_MAPS

The "if (inner_map->inner_map_meta)" check in bpf_map_meta_alloc()
is moved such that the same error is returned.

[1]: https://lore.kernel.org/bpf/20200522022342.899756-1-kafai@fb.com/



Signed-off-by: default avatarMartin KaFai Lau <kafai@fb.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200828011806.1970400-1-kafai@fb.com
parent b0c9eb37

include/linux/bpf.h

+16 −0
Original line number Diff line number Diff line
@@ -112,6 +112,19 @@ struct bpf_map_ops { 
	void (*map_local_storage_uncharge)(struct bpf_local_storage_map *smap,

					   void *owner, u32 size);

	struct bpf_local_storage __rcu ** (*map_owner_storage_ptr)(void *owner);



	/* map_meta_equal must be implemented for maps that can be

	 * used as an inner map.  It is a runtime check to ensure

	 * an inner map can be inserted to an outer map.

	 *

	 * Some properties of the inner map has been used during the

	 * verification time.  When inserting an inner map at the runtime,

	 * map_meta_equal has to ensure the inserting map has the same

	 * properties that the verifier has used earlier.

	 */

	bool (*map_meta_equal)(const struct bpf_map *meta0,

			       const struct bpf_map *meta1);



	/* BTF name and id of struct allocated by map_alloc */

	const char * const map_btf_name;

	int *map_btf_id;
@@ -235,6 +248,9 @@ int map_check_no_btf(const struct bpf_map *map, 
		     const struct btf_type *key_type,

		     const struct btf_type *value_type);



bool bpf_map_meta_equal(const struct bpf_map *meta0,

			const struct bpf_map *meta1);



extern const struct bpf_map_ops bpf_map_offload_ops;



/* function argument constraints */

kernel/bpf/arraymap.c

+9 −0
Original line number Diff line number Diff line
@@ -625,6 +625,7 @@ static const struct bpf_iter_seq_info iter_seq_info = { 


static int array_map_btf_id;

const struct bpf_map_ops array_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc_check = array_map_alloc_check,

	.map_alloc = array_map_alloc,

	.map_free = array_map_free,
@@ -647,6 +648,7 @@ const struct bpf_map_ops array_map_ops = { 


static int percpu_array_map_btf_id;

const struct bpf_map_ops percpu_array_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc_check = array_map_alloc_check,

	.map_alloc = array_map_alloc,

	.map_free = array_map_free,
@@ -1003,6 +1005,11 @@ static void prog_array_map_free(struct bpf_map *map) 
	fd_array_map_free(map);

}



/* prog_array->aux->{type,jited} is a runtime binding.

 * Doing static check alone in the verifier is not enough.

 * Thus, prog_array_map cannot be used as an inner_map

 * and map_meta_equal is not implemented.

 */

static int prog_array_map_btf_id;

const struct bpf_map_ops prog_array_map_ops = {

	.map_alloc_check = fd_array_map_alloc_check,
@@ -1101,6 +1108,7 @@ static void perf_event_fd_array_release(struct bpf_map *map, 


static int perf_event_array_map_btf_id;

const struct bpf_map_ops perf_event_array_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc_check = fd_array_map_alloc_check,

	.map_alloc = array_map_alloc,

	.map_free = fd_array_map_free,
@@ -1137,6 +1145,7 @@ static void cgroup_fd_array_free(struct bpf_map *map) 


static int cgroup_array_map_btf_id;

const struct bpf_map_ops cgroup_array_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc_check = fd_array_map_alloc_check,

	.map_alloc = array_map_alloc,

	.map_free = cgroup_fd_array_free,

kernel/bpf/bpf_inode_storage.c

+1 −0
Original line number Diff line number Diff line
@@ -235,6 +235,7 @@ static void inode_storage_map_free(struct bpf_map *map) 


static int inode_storage_map_btf_id;

const struct bpf_map_ops inode_storage_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc_check = bpf_local_storage_map_alloc_check,

	.map_alloc = inode_storage_map_alloc,

	.map_free = inode_storage_map_free,

kernel/bpf/cpumap.c

+1 −0
Original line number Diff line number Diff line
@@ -658,6 +658,7 @@ static int cpu_map_get_next_key(struct bpf_map *map, void *key, void *next_key) 


static int cpu_map_btf_id;

const struct bpf_map_ops cpu_map_ops = {

	.map_meta_equal		= bpf_map_meta_equal,

	.map_alloc		= cpu_map_alloc,

	.map_free		= cpu_map_free,

	.map_delete_elem	= cpu_map_delete_elem,

kernel/bpf/devmap.c

+2 −0
Original line number Diff line number Diff line
@@ -751,6 +751,7 @@ static int dev_map_hash_update_elem(struct bpf_map *map, void *key, void *value, 


static int dev_map_btf_id;

const struct bpf_map_ops dev_map_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc = dev_map_alloc,

	.map_free = dev_map_free,

	.map_get_next_key = dev_map_get_next_key,
@@ -764,6 +765,7 @@ const struct bpf_map_ops dev_map_ops = { 


static int dev_map_hash_map_btf_id;

const struct bpf_map_ops dev_map_hash_ops = {

	.map_meta_equal = bpf_map_meta_equal,

	.map_alloc = dev_map_alloc,

	.map_free = dev_map_free,

	.map_get_next_key = dev_map_hash_get_next_key,

CRA Git | Maintained and supported by SUSTech CRA and CCSE