title | description |
---|---|
Helper Function 'bpf_map_delete_elem' |
This page documents the 'bpf_map_delete_elem' eBPF helper function, including its defintion, usage, program types that can use it, and examples. |
The delete map element helper call is used to delete values from maps.
Copyright (c) 2015 The Libbpf Authors. All rights reserved.
Delete entry with key from map.
0 on success, or a negative error in case of failure.
#!c static long (* const bpf_map_delete_elem)(void *map, const void *key) = (void *) 3;
The map
argument must be a pointer to a map definition and key
must be a pointer to the key you
wish to delete.
The return value will be 0
on success or a negative valued error number indicating a failure.
This helper call can be used in the following program types:
- BPF_PROG_TYPE_CGROUP_DEVICE
- BPF_PROG_TYPE_CGROUP_SKB
- BPF_PROG_TYPE_CGROUP_SOCK
- BPF_PROG_TYPE_CGROUP_SOCKOPT
- BPF_PROG_TYPE_CGROUP_SOCK_ADDR
- BPF_PROG_TYPE_CGROUP_SYSCTL
- BPF_PROG_TYPE_FLOW_DISSECTOR
- BPF_PROG_TYPE_KPROBE
- BPF_PROG_TYPE_LIRC_MODE2
- BPF_PROG_TYPE_LSM
- BPF_PROG_TYPE_LWT_IN
- BPF_PROG_TYPE_LWT_OUT
- BPF_PROG_TYPE_LWT_SEG6LOCAL
- BPF_PROG_TYPE_LWT_XMIT
- BPF_PROG_TYPE_PERF_EVENT
- BPF_PROG_TYPE_RAW_TRACEPOINT
- BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE
- BPF_PROG_TYPE_SCHED_ACT
- BPF_PROG_TYPE_SCHED_CLS
- BPF_PROG_TYPE_SK_LOOKUP
- BPF_PROG_TYPE_SK_MSG
- BPF_PROG_TYPE_SK_REUSEPORT
- BPF_PROG_TYPE_SK_SKB
- BPF_PROG_TYPE_SOCKET_FILTER
- BPF_PROG_TYPE_SOCK_OPS
- BPF_PROG_TYPE_STRUCT_OPS
- BPF_PROG_TYPE_SYSCALL
- BPF_PROG_TYPE_TRACEPOINT
- BPF_PROG_TYPE_TRACING
- BPF_PROG_TYPE_XDP
This helper call can be used with the following map types:
- BPF_MAP_TYPE_ARRAY
- BPF_MAP_TYPE_HASH
- BPF_MAP_TYPE_LPM_TRIE
- BPF_MAP_TYPE_LRU_HASH
- BPF_MAP_TYPE_LRU_PERCPU_HASH
- BPF_MAP_TYPE_PERCPU_ARRAY
- BPF_MAP_TYPE_PERCPU_HASH
- BPF_MAP_TYPE_SOCKHASH
- BPF_MAP_TYPE_SOCKMAP
int key, result;
key = 1;
result = bpf_map_delete_element(&my_map, &key);
if (result == 0)
bpf_printk("Element deleted from the map\n");
else
bpf_printk("Failed to delete element from the map: %d\n",result);