addb2.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2014-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_ADDB2_H__
#define __MOTR_ADDB2_ADDB2_H__

/* import */
#include "lib/types.h"
#include "lib/time.h"
#include "lib/tlist.h"
#include "lib/misc.h"               /* ARRAY_SIZE */
#include "xcode/xcode_attr.h"

/* export */
struct m0_addb2_mach;
struct m0_addb2_sensor;
struct m0_addb2_trace;
struct m0_addb2_trace_obj;

void m0_addb2_push(uint64_t id, int n, const uint64_t *value);

void m0_addb2_pop (uint64_t id);

void m0_addb2_add (uint64_t id, int n, const uint64_t *value);

#define M0_ADDB2_ADD(id, ...)                                           \
        m0_addb2_add(id, ARRAY_SIZE(((uint64_t[]){ __VA_ARGS__ })),     \
                     (const uint64_t[]){ __VA_ARGS__ })

#define M0_ADDB2_PUSH(id, ...)                                          \
        m0_addb2_push(id, ARRAY_SIZE(((uint64_t[]){ __VA_ARGS__ })),    \
                      (const uint64_t[]){ __VA_ARGS__ })

#define M0_ADDB2_OBJ(obj) ((sizeof *(obj))/sizeof(uint64_t)), (uint64_t *)(obj)

#define M0_ADDB2_IN(id, stmnt, ...)             \
do {                                            \
        M0_ADDB2_PUSH(id , ##__VA_ARGS__);      \
        (stmnt);                                \
        m0_addb2_pop(id);                       \
} while (0)

struct m0_addb2_sensor_ops {
        void (*so_snapshot)(struct m0_addb2_sensor *s, uint64_t *area);
        void (*so_fini)(struct m0_addb2_sensor *s);
};

struct m0_addb2_sensor {
        const struct m0_addb2_sensor_ops *s_ops;
        struct m0_tlink                   s_linkage;
        uint64_t                          s_id;
        unsigned                          s_nr;
        uint64_t                          s_magix;
};

void m0_addb2_sensor_add(struct m0_addb2_sensor *s, uint64_t id, unsigned nr,
                         int idx, const struct m0_addb2_sensor_ops *ops);
void m0_addb2_sensor_del(struct m0_addb2_sensor *s);

void m0_addb2_force(m0_time_t delay);

void m0_addb2_force_all(void);

struct m0_addb2_mach_ops {
        int (*apo_submit)(struct m0_addb2_mach *mach,
                          struct m0_addb2_trace_obj *tobj);
        void (*apo_idle)(struct m0_addb2_mach *mach);
};

void m0_addb2_trace_done(const struct m0_addb2_trace *trace);

struct m0_addb2_mach *m0_addb2_mach_init(const struct m0_addb2_mach_ops *ops,
                                         void *cookie);
void m0_addb2_mach_fini(struct m0_addb2_mach *mach);

void m0_addb2_mach_stop(struct m0_addb2_mach *mach);

void m0_addb2_mach_wait(struct m0_addb2_mach *mach);

void *m0_addb2_mach_cookie(const struct m0_addb2_mach *mach);

int m0_addb2_module_init(void);
void m0_addb2_module_fini(void);

/* Internal interface. */

struct m0_addb2_trace {
        uint64_t  tr_nr;
        uint64_t *tr_body;
} M0_XCA_SEQUENCE M0_XCA_DOMAIN(rpc);

struct m0_addb2_trace_obj {
        struct m0_addb2_trace o_tr;
        struct m0_tlink       o_linkage;
        struct m0_addb2_mach *o_mach;
        void                (*o_done)(struct m0_addb2_trace_obj *obj);
        bool                  o_force;
        uint64_t              o_magix;
};

#endif /* __MOTR_ADDB2_ADDB2_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
 */