1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.net.module.util;
import android.system.ErrnoException;
import androidx.annotation.NonNull;
import java.io.IOException;
import java.util.NoSuchElementException;
/**
* The interface of BpfMap. This could be used to inject for testing.
* So the testing code won't load the JNI and update the entries to kernel.
*
* @param <K> the key of the map.
* @param <V> the value of the map.
*/
public interface IBpfMap<K extends Struct, V extends Struct> extends AutoCloseable {
/** Update an existing or create a new key -> value entry in an eBbpf map. */
void updateEntry(K key, V value) throws ErrnoException;
/** If the key does not exist in the map, insert key -> value entry into eBpf map. */
void insertEntry(K key, V value) throws ErrnoException, IllegalStateException;
/** If the key already exists in the map, replace its value. */
void replaceEntry(K key, V value) throws ErrnoException, NoSuchElementException;
/**
* Update an existing or create a new key -> value entry in an eBbpf map. Returns true if
* inserted, false if replaced. (use updateEntry() if you don't care whether insert or replace
* happened).
*/
boolean insertOrReplaceEntry(K key, V value) throws ErrnoException;
/** Remove existing key from eBpf map. Return true if something was deleted. */
boolean deleteEntry(K key) throws ErrnoException;
/** Returns {@code true} if this map contains no elements. */
boolean isEmpty() throws ErrnoException;
/** Get the key after the passed-in key. */
K getNextKey(@NonNull K key) throws ErrnoException;
/** Get the first key of the eBpf map. */
K getFirstKey() throws ErrnoException;
/** Check whether a key exists in the map. */
boolean containsKey(@NonNull K key) throws ErrnoException;
/** Retrieve a value from the map. */
V getValue(@NonNull K key) throws ErrnoException;
public interface ThrowingBiConsumer<T,U> {
void accept(T t, U u) throws ErrnoException;
}
/**
* Iterate through the map and handle each key -> value retrieved base on the given BiConsumer.
*/
void forEach(ThrowingBiConsumer<K, V> action) throws ErrnoException;
/** Clears the map. */
void clear() throws ErrnoException;
/** Close for AutoCloseable. */
@Override
void close() throws IOException;
}
|
