fom_generic.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_FOP_FOM_GENERIC_H__
#define __MOTR_FOP_FOM_GENERIC_H__

#include "fop/fom.h"
#include "lib/types.h"
#include "xcode/xcode_attr.h"
#include "lib/string.h"
#include "lib/string_xc.h"
#include "be/tx.h"
#include "be/tx_xc.h"

struct m0_rpc_item;

#define FOM_PHASE_STATS_DATA_SZ(nr)     (M0_FOM_STATS_CNTR_DATA * (nr))

enum m0_fom_standard_phase {
        M0_FOPH_INIT = M0_FOM_PHASE_INIT,  /*< fom has been initialised. */
        M0_FOPH_FINISH = M0_FOM_PHASE_FINISH,  /*< terminal phase. */
        M0_FOPH_AUTHENTICATE,        /*< authentication loop is in progress. */
        M0_FOPH_AUTHENTICATE_WAIT,   /*< waiting for key cache miss. */
        M0_FOPH_RESOURCE_LOCAL,      /*< local resource reservation loop is in
                                         progress. */
        M0_FOPH_RESOURCE_LOCAL_WAIT, /*< waiting for a local resource. */
        M0_FOPH_RESOURCE_DISTRIBUTED,/*< distributed resource reservation loop
                                         is in progress. */
        M0_FOPH_RESOURCE_DISTRIBUTED_WAIT, /*< waiting for a distributed
                                               resource. */
        M0_FOPH_OBJECT_CHECK,       /*< object checking loop is in progress. */
        M0_FOPH_OBJECT_CHECK_WAIT,  /*< waiting for object cache miss. */
        M0_FOPH_AUTHORISATION,      /*< authorisation loop is in progress. */
        M0_FOPH_AUTHORISATION_WAIT, /*< waiting for userdb cache miss. */
        M0_FOPH_TXN_INIT,           /*< init local transactional context. */
        M0_FOPH_TXN_OPEN,           /*< open local transactional context. */
        M0_FOPH_TXN_WAIT,           /*< waiting for log space. */
        M0_FOPH_SUCCESS,            /*< fom execution completed successfully. */
        M0_FOPH_FOL_REC_ADD,        /*< add a FOL transaction record. */
        M0_FOPH_TXN_COMMIT,         /*< commit local transaction context. */
        M0_FOPH_QUEUE_REPLY,        /*< queuing fop reply.  */
        M0_FOPH_QUEUE_REPLY_WAIT,   /*< waiting for fop cache space. */
        M0_FOPH_TXN_LOGGED_WAIT,    /*< waiting for local transaction to become
                                        logged. */
        M0_FOPH_TXN_DONE_WAIT,      /*< waiting for local transaction to become
                                        done. */
        M0_FOPH_TIMEOUT,            /*< fom timed out. */
        M0_FOPH_FAILURE,            /*< fom execution failed. */
        M0_FOPH_NR,                  /*< number of standard phases. fom type
                                        specific phases have numbers larger than
                                        this. */
        M0_FOPH_TYPE_SPECIFIC        /*< used when only single specific phase
                                         present in FOM. */
};

int m0_fom_tick_generic(struct m0_fom *fom);

M0_INTERNAL void m0_fom_generic_fini(void);
M0_INTERNAL int m0_fom_generic_init(void);

enum {
        M0_FOM_GENERIC_TRANS_NR = 48,
};

extern struct m0_sm_trans_descr
m0_generic_phases_trans[M0_FOM_GENERIC_TRANS_NR];
extern const struct m0_sm_conf m0_generic_conf;

struct m0_fop_generic_reply {
        int32_t           gr_rc;
        struct m0_fop_str gr_msg;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

extern struct m0_fop_type m0_fop_generic_reply_fopt;

bool m0_rpc_item_is_generic_reply_fop(const struct m0_rpc_item *item);

struct m0_fop_mod_rep {
        struct m0_be_tx_remid fmr_remid;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

M0_INTERNAL void m0_fom_mod_rep_fill(struct m0_fop_mod_rep *rep,
                                     struct m0_fom *fom);

int32_t m0_rpc_item_generic_reply_rc(const struct m0_rpc_item *item);

M0_INTERNAL int m0_fom_tx_done_wait(struct m0_fom *fom);

/* __MOTR_FOP_FOM_GENERIC_H__ */
#endif

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