source_dock_internal.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_SOURCE_DOCK_INTERNAL_H__
#define __MOTR_FDMI_SOURCE_DOCK_INTERNAL_H__

#include "lib/types.h"

#include "fdmi/fdmi.h"
#include "fdmi/source_dock.h"
#include "fdmi/filterc.h"
#include "fdmi/flt_eval.h"
#include "rpc/conn_pool.h"

/* This file describes FDMI source dock internals */

struct m0_fdmi_src_ctx {
        uint64_t                fsc_magic;

        struct m0_fdmi_src      fsc_src;

        struct m0_tlink         fsc_linkage;

        bool                    fsc_registered;
};

M0_TL_DESCR_DECLARE(fdmi_record_list, M0_EXTERN);
M0_TL_DECLARE(fdmi_record_list, M0_EXTERN, struct m0_fdmi_src_rec);

M0_TL_DESCR_DECLARE(fdmi_matched_filter_list, M0_EXTERN);
M0_TL_DECLARE(fdmi_matched_filter_list, M0_EXTERN, struct m0_conf_fdmi_filter);

struct fdmi_sd_fom {
        uint64_t                fsf_magic;
        struct m0_fom           fsf_fom;
        struct m0_sm_ast        fsf_wakeup_ast;
        struct m0_filterc_ctx   fsf_filter_ctx;
        struct m0_filterc_iter  fsf_filter_iter;
        struct m0_fdmi_eval_ctx fsf_flt_eval;
        struct m0_rpc_conn_pool fsf_conn_pool;
        struct m0_tl            fsf_pending_fops;
        struct m0_mutex         fsf_pending_fops_lock;
        struct m0_semaphore     fsf_shutdown;
        char                   *fsf_client_ep;
        bool                    fsf_has_records;
        m0_time_t               fsf_last_checkpoint;
};

struct fdmi_rr_fom {
        uint64_t                frf_magic;
        struct m0_fom           frf_fom;
};

struct fdmi_sd_timer_fom {
        struct m0_fom           fstf_fom;
        struct m0_fom_timeout   fstf_timeout;
        struct m0_sm_ast        fstf_wakeup_ast;
        struct m0_semaphore     fstf_shutdown;
};

struct m0_fdmi_src_dock {
        bool                  fsdc_started;

        bool                  fsdc_filters_defined;

        struct m0_tl          fsdc_src_list;

        struct m0_tl          fsdc_posted_rec_list;

        struct m0_tl          fsdc_rec_inflight;

        struct m0_mutex       fsdc_list_mutex;

        uint64_t              fsdc_instance_id;

        struct fdmi_sd_fom    fsdc_sd_fom;

        struct fdmi_sd_timer_fom    fsdc_sd_timer_fom;
};

struct m0_fdmi_sd_filter_type_handler {
        enum m0_fdmi_filter_type_id   ffth_id;
        int                         (*ffth_handler)
                (struct m0_fdmi_eval_ctx      *ctx,
                 struct m0_conf_fdmi_filter   *filter,
                 struct m0_fdmi_eval_var_info *var_info);
};

M0_INTERNAL void m0_fdmi__enqueue(struct m0_fdmi_src_rec *src_rec);
M0_INTERNAL void m0_fdmi__enqueue_locked(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__record_post(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__rec_id_gen(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__src_dock_fom_init(void);

M0_INTERNAL int m0_fdmi__src_dock_fom_start(
                struct m0_fdmi_src_dock     *src_dock,
                const struct m0_filterc_ops *filterc_ops,
                struct m0_reqh *reqh);

M0_INTERNAL void
m0_fdmi__src_dock_fom_stop(struct m0_fdmi_src_dock *src_dock);

M0_INTERNAL struct m0_fdmi_src_ctx *m0_fdmi__src_ctx_get(
        enum m0_fdmi_rec_type_id    src_type_id);

M0_INTERNAL void m0_fdmi__fs_get(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__fs_put(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__fs_begin(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__fs_end(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__record_init(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL void m0_fdmi__record_deinit(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL enum m0_fdmi_rec_type_id
m0_fdmi__sd_rec_type_id_get(struct m0_fdmi_src_rec *src_rec);

M0_INTERNAL int m0_fdmi__handle_release(struct m0_uint128 *fdmi_rec_id);

M0_INTERNAL void m0_fdmi__src_dock_fom_wakeup(struct fdmi_sd_fom *sd_fom);

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