bloom-filter.bif.zeek¶

GLOBAL¶

Functions to create and manipulate Bloom filters.

Namespace: GLOBAL

Summary¶

Functions¶

`bloomfilter_add`: `function`	Adds an element to a Bloom filter.
`bloomfilter_basic_init`: `function`	Creates a basic Bloom filter.
`bloomfilter_basic_init2`: `function`	Creates a basic Bloom filter.
`bloomfilter_clear`: `function`	Removes all elements from a Bloom filter.
`bloomfilter_counting_init`: `function`	Creates a counting Bloom filter.
`bloomfilter_internal_state`: `function`	Returns a string with a representation of a Bloom filter’s internal state.
`bloomfilter_lookup`: `function`	Retrieves the counter for a given element in a Bloom filter.
`bloomfilter_merge`: `function`	Merges two Bloom filters.

Detailed Interface¶

Functions¶

bloomfilter_add¶

Type: function (bf: opaque of bloomfilter, x: any) : any

Adds an element to a Bloom filter.

Bf: The Bloom filter handle.
X: The element to add.

bloomfilter_basic_init¶

Type: function (fp: double, capacity: count, name: string &default = "" &optional) : opaque of bloomfilter

Creates a basic Bloom filter.

Fp: The desired false-positive rate.
Capacity: the maximum number of elements that guarantees a false-positive rate of fp.
Name: A name that uniquely identifies and seeds the Bloom filter. If empty, the filter will use global_hash_seed if that’s set, and otherwise use a local seed tied to the current Zeek process. Only filters with the same seed can be merged with bloomfilter_merge.
Returns: A Bloom filter handle.

bloomfilter_basic_init2¶

Type: function (k: count, cells: count, name: string &default = "" &optional) : opaque of bloomfilter

Creates a basic Bloom filter. This function serves as a low-level alternative to bloomfilter_basic_init where the user has full control over the number of hash functions and cells in the underlying bit vector.

K: The number of hash functions to use.
Cells: The number of cells of the underlying bit vector.
Name: A name that uniquely identifies and seeds the Bloom filter. If empty, the filter will use global_hash_seed if that’s set, and otherwise use a local seed tied to the current Zeek process. Only filters with the same seed can be merged with bloomfilter_merge.
Returns: A Bloom filter handle.

bloomfilter_clear¶

Type: function (bf: opaque of bloomfilter) : any

Removes all elements from a Bloom filter. This function resets all bits in the underlying bitvector back to 0 but does not change the parameterization of the Bloom filter, such as the element type and the hasher seed.

Bf: The Bloom filter handle.

bloomfilter_counting_init¶

Type: function (k: count, cells: count, max: count, name: string &default = "" &optional) : opaque of bloomfilter

Creates a counting Bloom filter.

K: The number of hash functions to use.
Cells: The number of cells of the underlying counter vector. As there’s no single answer to what’s the best parameterization for a counting Bloom filter, we refer to the Bloom filter literature here for choosing an appropiate value.
Max: The maximum counter value associated with each element described by w = ceil(log_2(max)) bits. Each bit in the underlying counter vector becomes a cell of size w bits.
Name: A name that uniquely identifies and seeds the Bloom filter. If empty, the filter will use global_hash_seed if that’s set, and otherwise use a local seed tied to the current Zeek process. Only filters with the same seed can be merged with bloomfilter_merge.
Returns: A Bloom filter handle.

bloomfilter_internal_state¶

Type: function (bf: opaque of bloomfilter) : string

Returns a string with a representation of a Bloom filter’s internal state. This is for debugging/testing purposes only.

Bf: The Bloom filter handle.
Returns: a string with a representation of a Bloom filter’s internal state.

bloomfilter_lookup¶

Type: function (bf: opaque of bloomfilter, x: any) : count

Retrieves the counter for a given element in a Bloom filter.

Bf: The Bloom filter handle.
X: The element to count.
Returns: the counter associated with x in bf.

bloomfilter_merge¶

Type: function (bf1: opaque of bloomfilter, bf2: opaque of bloomfilter) : opaque of bloomfilter

Merges two Bloom filters.

Note

Currently Bloom filters created by different Zeek instances cannot be merged. In the future, this will be supported as long as both filters are created with the same name.

Bf1: The first Bloom filter handle.
Bf2: The second Bloom filter handle.
Returns: The union of bf1 and bf2.