filter_info.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 The University of Manchester
 *
 * 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
 *
 *     https://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.
 */
 
#ifndef __FILTER_INFO_H__
#define __FILTER_INFO_H__
 
#include <bit_field.h>
 
typedef struct filter_info_t {
    uint32_t key;
    uint32_t merged: 1;
    uint32_t all_ones: 1;
    uint32_t n_atoms: 30;
    uint32_t core_shift: 5;
    uint32_t n_atoms_per_core:27;
    bit_field_t data;
} filter_info_t;
 
typedef struct filter_region_t {
    uint32_t n_filters;
    filter_info_t filters[];
} filter_region_t;
 
struct core_atom {
    uint32_t core;
    uint32_t atom;
};
 
static inline void next_core_atom(filter_info_t *filter, struct core_atom *core_atom) {
    core_atom->atom++;
    // If n_atoms_per_core is 0 (i.e. disabled) this will never match, so the
    // atom will be global
    if (core_atom->atom == filter->n_atoms_per_core) {
        core_atom->core++;
        core_atom->atom = 0;
    }
}
 
static inline uint32_t get_bf_key(filter_info_t *filter, struct core_atom *core_atom) {
    // Note if n_atoms_per_core is 0, core will be 0, and atom will just be the
    // global atom
    return filter->key + (core_atom->core << filter->core_shift) + core_atom->atom;
}
 
static inline uint32_t global_atom(filter_info_t *filter, struct core_atom *core_atom) {
    return (filter->n_atoms_per_core * core_atom->core) + core_atom->atom;
}
 
#endif  // __FILTER_INFO_H__