isc.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 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_ISC_H__
#define __MOTR_ISC_H__

#include "iscservice/isc_fops.h"
#include "fop/fom_generic.h"

struct m0_isc_comp_private {
        struct m0_fom *icp_fom;

        void          *icp_data;
};

enum m0_isc_comp_req_type {
        M0_ICRT_LOCAL,
        M0_ICRT_REMOTE,
};

struct m0_isc_comp_req {
/* Public fields: */

        struct m0_buf              icr_args;
        struct m0_buf              icr_result;
        struct m0_fid              icr_comp_fid;
        struct m0_cookie           icr_cookie;
        int                        icr_rc;
/* Private fields: */
        enum m0_isc_comp_req_type  icr_req_type;
        bool                       icr_req_bulk;
        struct m0_isc_comp_private icr_comp_data;
        struct m0_mutex            icr_guard;
        struct m0_chan             icr_chan;
        struct m0_fom              icr_fom;
        struct m0_reqh            *icr_reqh;
};

M0_INTERNAL void m0_isc_comp_req_init(struct m0_isc_comp_req *comp_req,
                                      const struct m0_buf *comp_args,
                                      const struct m0_fid *comp_fid,
                                      const struct m0_cookie *comp_cookie,
                                      enum m0_isc_comp_req_type comp_req_type,
                                      struct m0_reqh *reqh);

M0_INTERNAL void m0_isc_comp_req_fini(struct m0_isc_comp_req *comp_req);

M0_INTERNAL int m0_isc_comp_req_exec(struct m0_isc_comp_req *comp_req);

M0_INTERNAL int m0_isc_comp_req_exec_sync(struct m0_isc_comp_req *comp_req);

M0_INTERNAL int m0_isc_comp_register(int (*ftn)(struct m0_buf *arg_in,
                                                struct m0_buf *args_out,
                                                struct m0_isc_comp_private
                                                *comp_data, int *rc),
                                     const char *f_name,
                                     const struct m0_fid *ftn_fid);

M0_INTERNAL void m0_isc_comp_unregister(const struct m0_fid *fid);

M0_INTERNAL int m0_isc_comp_state_probe(const struct m0_fid *fid);

/*
 * Loads a computation library into m0d instances hosting ISC-service.
 *
 * The library must be accessible at @libpath on all the nodes where
 * the m0d instances (processes) are running.
 */
M0_INTERNAL int m0_isc_lib_register(const char *libpath, struct m0_fid *profile,
                                    struct m0_reqh *reqh);

M0_INTERNAL int m0_isc_io_launch(struct m0_stob_io *stio,
                                 struct m0_fid *cob,
                                 struct m0_io_indexvec *iv,
                                 struct m0_fom *fom);

M0_INTERNAL int64_t m0_isc_io_res(struct m0_stob_io *stio, char **buf);

M0_INTERNAL void m0_isc_io_fini(struct m0_stob_io *stio);

/* __MOTR_ISC_H__ */
#endif

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */