source_dock.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2017-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_FDMI_FDMI_SOURCE_DOCK_H__
#define __MOTR_FDMI_FDMI_SOURCE_DOCK_H__

#include "lib/buf.h"
#include "lib/tlist.h"
#include "lib/mutex.h"
#include "fop/fom.h"
#include "fdmi/fdmi.h"
#include "fdmi/filter.h"
#include "fdmi/src_rec.h"

/* This file describes FDMI source dock public API */

struct m0_fdmi_src {
        enum m0_fdmi_rec_type_id fs_type_id;

        /* Data owned and populated by source dock. */

        void (*fs_record_post)(struct m0_fdmi_src_rec *src_rec);

        /* Data owned and populated by source. */

        int (*fs_node_eval)(struct m0_fdmi_src_rec      *src_rec,
                            struct m0_fdmi_flt_var_node *value_desc,
                            struct m0_fdmi_flt_operand  *value);
        void (*fs_get)(struct m0_fdmi_src_rec *src_rec);
        void (*fs_put)(struct m0_fdmi_src_rec *src_rec);
        void (*fs_begin)(struct m0_fdmi_src_rec *src_rec);
        void (*fs_end)(struct m0_fdmi_src_rec *src_rec);

        int (*fs_encode)(struct m0_fdmi_src_rec *src_rec, struct m0_buf *buf);

        int (*fs_decode)(struct m0_buf *buf, void **handle);

};

M0_INTERNAL int m0_fdmi_source_alloc(enum m0_fdmi_rec_type_id type_id,
                                     struct m0_fdmi_src     **source);

M0_INTERNAL void m0_fdmi_source_free(struct m0_fdmi_src *source);

M0_INTERNAL int m0_fdmi_source_register(struct m0_fdmi_src *src);

M0_INTERNAL void m0_fdmi_source_deregister(struct m0_fdmi_src *src);


M0_INTERNAL void
m0_fdmi_source_dock_init(struct m0_fdmi_src_dock *src_dock);

M0_INTERNAL void
m0_fdmi_source_dock_fini(struct m0_fdmi_src_dock *src_dock);

#define M0_FDMI_SOURCE_POST_RECORD(_src_rec_ptr) \
        ((_src_rec_ptr)->fsr_src)->fs_record_post(_src_rec_ptr)

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