plugin_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_PLUGIN_DOCK_H__
#define __MOTR_FDMI_FDMI_PLUGIN_DOCK_H__

#include "fdmi/fdmi.h"
#include "lib/types.h"
#include "lib/types_xc.h"
#include "lib/tlist.h"
#include "rpc/session.h"
#include "fid/fid.h"

struct m0_fdmi_plugin_ops {
        int (*po_fdmi_rec) (struct m0_uint128   *rec_id,
                            struct m0_buf        fdmi_rec,
                            struct m0_fid        filter_id);
};

struct m0_fdmi_filter_desc {
};

struct m0_fdmi_filter_reg {
        struct m0_fid               ffr_ffid;

        struct m0_fdmi_filter_desc *ffr_desc;   
        struct m0_fdmi_plugin_ops  *ffr_pcb;    
        char                       *ffr_ep;     
        uint32_t                    ffr_flags;

        /* tl specifics */
        struct m0_tlink             ffr_link;

        uint64_t                    ffr_magic;
};

struct m0_fdmi_record_reg {
        struct m0_fop_fdmi_record      *frr_rec;    
        char                           *frr_ep_addr;
        struct m0_rpc_session          *frr_sess;

        struct m0_ref                   frr_ref;    
        struct m0_fop                  *frr_fop;
        /* tl specifics */
        struct m0_tlink                 frr_link;

        uint64_t                        frr_magic;
};

struct m0_fdmi_pd_ops {
        int (*fpo_register_filter) (const struct m0_fid              *fid,
                                    const struct m0_fdmi_filter_desc *desc,
                                    const struct m0_fdmi_plugin_ops  *pcb);

        void (*fpo_enable_filters) (bool           enable,
                                    struct m0_fid *filter_ids,
                                    uint32_t       filter_count);

        void (*fpo_release_fdmi_rec) (struct m0_uint128 *rec_id,
                                      struct m0_fid     *filter_id);

        void (*fpo_deregister_plugin) (struct m0_fid *filter_ids,
                                       uint64_t       filter_count);
};

const struct m0_fdmi_pd_ops *m0_fdmi_plugin_dock_api_get(void);

#if 0  /* cut off until future development */

struct m0_fdmi_filters_enable {
        /* @todo Fill this in with filter definitions */
        int foo;
} M0_XCA_RECORD;

struct m0_fdmi_filters_enable_reply {
        int ffer_rc;                  
} M0_XCA_RECORD;
#endif

#endif

/*
 *  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
 */