consumer.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-2020 Seagate Technology LLC and/or its Affiliates
 *
 * 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.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_ADDB2_CONSUMER_H__
#define __MOTR_ADDB2_CONSUMER_H__

/* import */
#include "lib/types.h"
#include "lib/tlist.h"

struct m0_addb2_trace;
struct m0_addb2_mach;

/* export */
struct m0_addb2_record;
struct m0_addb2_cursor;
struct m0_addb2_source;
struct m0_addb2_philter;
struct m0_addb2_callback;

void m0_addb2_cursor_init(struct m0_addb2_cursor *cur,
                          const struct m0_addb2_trace *trace);
void m0_addb2_cursor_fini(struct m0_addb2_cursor *cur);
int  m0_addb2_cursor_next(struct m0_addb2_cursor *cur);

enum {
        M0_ADDB2_LABEL_MAX = 64
};

struct m0_addb2_value {
        uint64_t        va_id;
        uint64_t        va_time;
        unsigned        va_nr;
        const uint64_t *va_data;
};

struct m0_addb2_record {
        struct m0_addb2_value ar_val;
        unsigned              ar_label_nr;
        struct m0_addb2_value ar_label[M0_ADDB2_LABEL_MAX];
};

struct m0_addb2_source {
        struct m0_tl so_philter;
};

void m0_addb2_source_init(struct m0_addb2_source *src);
void m0_addb2_source_fini(struct m0_addb2_source *src);

struct m0_addb2_philter {
        bool           (*ph_matches)(struct m0_addb2_philter *ph,
                                     const struct m0_addb2_record *rec);
        void            *ph_datum;
        struct m0_tlink  ph_linkage;
        struct m0_tl     ph_callback;
        uint64_t         ph_magix;
};

void m0_addb2_philter_init(struct m0_addb2_philter *philter,
                           bool (*matches)(struct m0_addb2_philter *,
                                           const struct m0_addb2_record *),
                           void *datum);

void m0_addb2_philter_fini(struct m0_addb2_philter *philter);

void m0_addb2_philter_add(struct m0_addb2_source *src,
                          struct m0_addb2_philter *ph);
void m0_addb2_philter_del(struct m0_addb2_philter *ph);

struct m0_addb2_callback {
        void           (*ca_fire)(const struct m0_addb2_source   *src,
                                  const struct m0_addb2_philter  *ph,
                                  const struct m0_addb2_callback *callback,
                                  const struct m0_addb2_record   *rec);
        void            *ca_datum;
        struct m0_tlink  ca_linkage;
        uint64_t         ca_magix;
};

void m0_addb2_callback_init(struct m0_addb2_callback *callback,
                            void (*fire)(const struct m0_addb2_source   *,
                                         const struct m0_addb2_philter  *,
                                         const struct m0_addb2_callback *,
                                         const struct m0_addb2_record   *),
                            void *datum);

void m0_addb2_callback_fini(struct m0_addb2_callback *callback);

void m0_addb2_callback_add(struct m0_addb2_philter *ph,
                           struct m0_addb2_callback *callback);
void m0_addb2_callback_del(struct m0_addb2_callback *callback);

struct m0_addb2_cursor {
        const struct m0_addb2_trace *cu_trace;
        unsigned                     cu_pos;
        struct m0_addb2_source       cu_src;
        struct m0_addb2_record       cu_rec;
};

struct m0_addb2_source *m0_addb2_mach_source(struct m0_addb2_mach *m);
struct m0_addb2_source *m0_addb2_cursor_source(struct m0_addb2_cursor *c);

void m0_addb2_consume(struct m0_addb2_source *src,
                      const struct m0_addb2_record *rec);

void m0_addb2_philter_true_init(struct m0_addb2_philter *ph);

void m0_addb2_philter_id_init(struct m0_addb2_philter *ph, uint64_t id);

void m0_addb2_philter_global_add(struct m0_addb2_philter *ph);

void m0_addb2_philter_global_del(struct m0_addb2_philter *ph);
#endif /* __MOTR_ADDB2_CONSUMER_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */