Skip to contentSkip to conversation

bpf: check max_entries before allocating memory

PATCH Superseded Florian Lehner 2 participants 3 messages Oct 26, 2022

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bpf: check max_entries before allocating memory

For maps of type BPF_MAP_TYPE_CPUMAP memory is allocated first before checking the max_entries argument. If then max_entries is greater than NR_CPUS additional work needs to be done to free allocated memory before an error is returned.
This changes moves the check on max_entries before the allocation happens.

---
 kernel/bpf/cpumap.c | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)
kernel/bpf/cpumap.c +8 -11
index b5ba34ddd4b6..87e9f89a8140 100644
@@ -97,29 +97,26 @@ static struct bpf_map *cpu_map_alloc(union bpf_attr *attr)
 	    attr->map_flags & ~BPF_F_NUMA_NODE)
 		return ERR_PTR(-EINVAL);
 
+	/* Pre-limit array size based on NR_CPUS, not final CPU check */
+	if (attr->max_entries > NR_CPUS)
+		return ERR_PTR(-E2BIG);
+
 	cmap = bpf_map_area_alloc(sizeof(*cmap), NUMA_NO_NODE);
 	if (!cmap)
 		return ERR_PTR(-ENOMEM);
 
 	bpf_map_init_from_attr(&cmap->map, attr);
 
-	/* Pre-limit array size based on NR_CPUS, not final CPU check */
-	if (cmap->map.max_entries > NR_CPUS) {
-		err = -E2BIG;
-		goto free_cmap;
-	}
-
 	/* Alloc array for possible remote "destination" CPUs */
 	cmap->cpu_map = bpf_map_area_alloc(cmap->map.max_entries *
 					   sizeof(struct bpf_cpu_map_entry *),
 					   cmap->map.numa_node);
-	if (!cmap->cpu_map)
-		goto free_cmap;
+	if (!cmap->cpu_map) {
+		bpf_map_area_free(cmap);
+		return ERR_PTR(err);
+	}
 
 	return &cmap->map;
-free_cmap:
-	bpf_map_area_free(cmap);
-	return ERR_PTR(err);
 }
 
 static void get_cpu_map_entry(struct bpf_cpu_map_entry *rcpu)
Signature · 1 line
2.37.3
#1 lore raw
Quoted 8 lines · Florian Lehner

For maps of type BPF_MAP_TYPE_CPUMAP memory is allocated first before checking the max_entries argument. If then max_entries is greater than NR_CPUS additional work needs to be done to free allocated memory before an error is returned.
This changes moves the check on max_entries before the allocation happens.

I did have a look at the failing CI tests:

Running bpftool checks...
Comparing /tmp/work/bpf/bpf/tools/include/uapi/linux/bpf.h (bpf_map_type) and /tmp/work/bpf/bpf/tools/bpf/bpftool/map.c (do_help() TYPE):
{'cgroup_storage', 'cgroup_storage_deprecated'}
Comparing /tmp/work/bpf/bpf/tools/include/uapi/linux/bpf.h (bpf_map_type) and /tmp/work/bpf/bpf/tools/bpf/bpftool/Documentation/bpftool-map.rst (TYPE):
{'cgroup_storage', 'cgroup_storage_deprecated'}
bpftool checks returned 1.

It looks to me these were introduced with commit a48b4bf994296a380f9c79620ad4ee7bad4511e1 and are not related to this proposed change.

#2 lore raw
In reply to Florian Lehner
Quoted 35 lines · Florian Lehner

For maps of type BPF_MAP_TYPE_CPUMAP memory is allocated first before checking the max_entries argument. If then max_entries is greater than NR_CPUS additional work needs to be done to free allocated memory before an error is returned.
This changes moves the check on max_entries before the allocation happens.

---
  kernel/bpf/cpumap.c | 19 ++++++++-----------
  1 file changed, 8 insertions(+), 11 deletions(-)
kernel/bpf/cpumap.c +4 -5
index b5ba34ddd4b6..87e9f89a8140 100644
@@ -97,29 +97,26 @@ static struct bpf_map *cpu_map_alloc(union bpf_attr *attr)
  	    attr->map_flags & ~BPF_F_NUMA_NODE)
  		return ERR_PTR(-EINVAL);
 
+	/* Pre-limit array size based on NR_CPUS, not final CPU check */
+	if (attr->max_entries > NR_CPUS)
+		return ERR_PTR(-E2BIG);
+
  	cmap = bpf_map_area_alloc(sizeof(*cmap), NUMA_NO_NODE);
  	if (!cmap)
  		return ERR_PTR(-ENOMEM);
 
  	bpf_map_init_from_attr(&cmap->map, attr);
 
-	/* Pre-limit array size based on NR_CPUS, not final CPU check */
-	if (cmap->map.max_entries > NR_CPUS) {
-		err = -E2BIG;
-		goto free_cmap;
-	}

kernel/bpf/cpumap.c static struct bpf_map *cpu_map_alloc(union bpf_attr *attr) · line 116

Quoted 10 lines
kernel/bpf/cpumap.c +3 -3
-
  	/* Alloc array for possible remote "destination" CPUs */
  	cmap->cpu_map = bpf_map_area_alloc(cmap->map.max_entries *
  					   sizeof(struct bpf_cpu_map_entry *),
  					   cmap->map.numa_node);
-	if (!cmap->cpu_map)
-		goto free_cmap;
+	if (!cmap->cpu_map) {
+		bpf_map_area_free(cmap);
+		return ERR_PTR(err);

lgtm. May as well take this chance to remove the "err" variable and directly return ERR_PTR(-ENOMEM) instead.

Quoted 9 lines
kernel/bpf/cpumap.c +1 -3
+	}
 
  	return &cmap->map;
-free_cmap:
-	bpf_map_area_free(cmap);
-	return ERR_PTR(err);
  }
 
  static void get_cpu_map_entry(struct bpf_cpu_map_entry *rcpu)