Helper function `bpf_timer_cancel`

This helper cancels a pending timer.

Definition

Copyright (c) 2015 The Libbpf Authors. All rights reserved.

Cancel the timer and wait for callback_fn to finish if it was running.

Returns

0 if the timer was not active. 1 if the timer was active. -EINVAL if timer was not initialized with bpf_timer_init() earlier. -EDEADLK if callback_fn tried to call bpf_timer_cancel() on its own timer which would have led to a deadlock otherwise.

static long (* const bpf_timer_cancel)(struct bpf_timer *timer) = (void *) 172;

Usage

Docs could be improved

This part of the docs is incomplete, contributions are very welcome

Example

#include <linux/bpf.h>
#include <time.h>
#include <stdbool.h>
#include <errno.h>
#include <bpf/bpf_helpers.h>
#include <bpf/bpf_tracing.h>

struct elem {
    struct bpf_timer t;
};

struct {
    __uint(type, BPF_MAP_TYPE_ARRAY);
    __uint(max_entries, 1);
    __type(key, int);
    __type(value, struct elem);
} hmap SEC(".maps");

static int timer_callback(void* hmap, int* key, struct bpf_timer *timer)
{
        bpf_printk("Callback was invoked do something useful");
    return 0;
}

SEC("cgroup_skb/egress")
int bpf_prog1(void *ctx)
{
    struct bpf_timer *timer;
    int err, key = 0;
    struct elem init;
    struct elem* ele;

    __builtin_memset(&init, 0, sizeof(struct elem));
    bpf_map_update_elem(&hmap, &key, &init, BPF_ANY);

    ele = bpf_map_lookup_elem(&hmap, &key);
    if (!ele)
        return 1;

    timer = &ele->t;
    err = bpf_timer_init(timer, &hmap, CLOCK_MONOTONIC);
    if (err && err != -EBUSY)
        return 1;

    bpf_timer_set_callback(timer, timer_callback);
    bpf_timer_start(timer, 0, 0);
    bpf_timer_cancel(timer);

    return 0;
}

char _license[] SEC("license") = "GPL";

Helper function bpf_timer_cancel