entrypoint.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-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_HA_ENTRYPOINT_H__
#define __MOTR_HA_ENTRYPOINT_H__

#include "lib/types.h"          /* uint32_t */
#include "lib/buf.h"            /* m0_buf */
#include "lib/chan.h"           /* m0_chan */
#include "lib/semaphore.h"      /* m0_semaphore */
#include "lib/tlist.h"          /* m0_tl */
#include "lib/mutex.h"          /* m0_mutex */

#include "sm/sm.h"              /* m0_sm */
#include "fid/fid.h"            /* m0_fid */
#include "xcode/xcode_attr.h"   /* M0_XCA_RECORD */
#include "fop/fom.h"            /* M0_FOM_PHASE_INIT */
#include "fop/fop.h"            /* m0_fop */
#include "ha/entrypoint_fops.h" /* m0_ha_entrypoint_req */
#include "rpc/link.h"           /* m0_rpc_link */


struct m0_ha_entrypoint_server;
struct m0_rpc_session;
struct m0_rpc_item;

enum m0_ha_entrypoint_server_fom_state {
        M0_HES_INIT = M0_FOM_PHASE_INIT,
        M0_HES_FINI = M0_FOM_PHASE_FINISH,
        M0_HES_REPLY_WAIT,
};

struct m0_ha_entrypoint_server_cfg {
        struct m0_reqh         *hesc_reqh;
        struct m0_rpc_machine  *hesc_rpc_machine;
        void                  (*hesc_request_received)
                (struct m0_ha_entrypoint_server    *hes,
                 const struct m0_ha_entrypoint_req *req,
                 const struct m0_uint128           *req_id);
};

struct m0_ha_entrypoint_server {
        struct m0_ha_entrypoint_server_cfg  hes_cfg;
        struct m0_reqh_service             *hes_he_service;
        struct m0_tl                        hes_requests;
        struct m0_uint128                   hes_next_id;
        struct m0_mutex                     hes_lock;
};

enum m0_ha_entrypoint_client_state {
        M0_HEC_INIT,
        M0_HEC_STOPPED,
        M0_HEC_UNAVAILABLE,
        M0_HEC_CONNECT,
        M0_HEC_CONNECT_WAIT,
        M0_HEC_FILL,
        M0_HEC_SEND,
        M0_HEC_SEND_WAIT,
        M0_HEC_DISCONNECT,
        M0_HEC_DISCONNECT_WAIT,
        M0_HEC_AVAILABLE,
        M0_HEC_FINI,
};

struct m0_ha_entrypoint_client_cfg {
        struct m0_reqh        *hecc_reqh;
        struct m0_rpc_machine *hecc_rpc_machine;
        struct m0_fid          hecc_process_fid;
};

struct m0_ha_entrypoint_client {
        struct m0_ha_entrypoint_client_cfg  ecl_cfg;
        struct m0_rpc_link                  ecl_rlink;
        struct m0_clink                     ecl_rlink_wait;
        struct m0_ha_entrypoint_req         ecl_req;
        struct m0_fop                       ecl_req_fop;
        struct m0_ha_entrypoint_req_fop     ecl_req_fop_data;
        struct m0_ha_entrypoint_rep         ecl_rep;
        struct m0_fom                       ecl_fom;
        bool                                ecl_fom_running;
        struct m0_mutex                     ecl_fom_running_lock;
        bool                                ecl_stopping;
        struct m0_sm                        ecl_sm;
        struct m0_sm_group                  ecl_sm_group;
        struct m0_rpc_item                 *ecl_reply;
        bool                                ecl_send_error;
        struct m0_clink                     ecl_clink;
};

M0_INTERNAL int
m0_ha_entrypoint_server_init(struct m0_ha_entrypoint_server     *hes,
                             struct m0_ha_entrypoint_server_cfg *hes_cfg);
M0_INTERNAL void
m0_ha_entrypoint_server_fini(struct m0_ha_entrypoint_server *hes);
/* asynchronous */
M0_INTERNAL void
m0_ha_entrypoint_server_start(struct m0_ha_entrypoint_server *hes);
/* synchronous */
M0_INTERNAL void
m0_ha_entrypoint_server_stop(struct m0_ha_entrypoint_server *hes);
M0_INTERNAL void
m0_ha_entrypoint_server_reply(struct m0_ha_entrypoint_server    *hes,
                              const struct m0_uint128           *req_id,
                              const struct m0_ha_entrypoint_rep *rep);
M0_INTERNAL const struct m0_ha_entrypoint_req *
m0_ha_entrypoint_server_request_find(struct m0_ha_entrypoint_server *hes,
                                     const struct m0_uint128        *req_id);


M0_INTERNAL int
m0_ha_entrypoint_client_init(struct m0_ha_entrypoint_client     *ecl,
                             const char                         *ep,
                             struct m0_ha_entrypoint_client_cfg *ecl_cfg);
M0_INTERNAL void
m0_ha_entrypoint_client_fini(struct m0_ha_entrypoint_client *ecl);
M0_INTERNAL void
m0_ha_entrypoint_client_start(struct m0_ha_entrypoint_client *ecl);
M0_INTERNAL void
m0_ha_entrypoint_client_start_sync(struct m0_ha_entrypoint_client *ecl);
M0_INTERNAL void
m0_ha_entrypoint_client_stop(struct m0_ha_entrypoint_client *ecl);
M0_INTERNAL void
m0_ha_entrypoint_client_request(struct m0_ha_entrypoint_client *ecl);
M0_INTERNAL struct m0_chan *
m0_ha_entrypoint_client_chan(struct m0_ha_entrypoint_client *ecl);

M0_INTERNAL enum m0_ha_entrypoint_client_state
m0_ha_entrypoint_client_state_get(struct m0_ha_entrypoint_client *ecl);

M0_INTERNAL int  m0_ha_entrypoint_mod_init(void);
M0_INTERNAL void m0_ha_entrypoint_mod_fini(void);

extern const struct m0_fom_type_ops m0_ha_entrypoint_fom_type_ops;
extern struct m0_reqh_service_type m0_ha_entrypoint_service_type;
extern struct m0_sm_conf m0_ha_entrypoint_server_fom_states_conf;

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