rconfc_internal.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_CONF_RCONFC_INTERNAL_H__
#define __MOTR_CONF_RCONFC_INTERNAL_H__

#include "fid/fid.h"       /* m0_fid */
#include "fop/fom.h"       /* m0_fom */
#include "rm/rm_rwlock.h"  /* m0_rm_rw_lock */

enum confc_state {
        CONFC_IDLE,       
        CONFC_ARMED,      
        CONFC_OPEN,       
        CONFC_FAILED,     
        CONFC_DEAD,       
};

/* -------------- Read lock context ----------------- */
struct m0_rconfc;

struct rlock_ctx {
        struct m0_rconfc          *rlc_parent;    
        struct m0_rpc_machine     *rlc_rmach;     
        struct m0_rpc_conn         rlc_conn;      
        struct m0_rpc_session      rlc_sess;      
        char                      *rlc_rm_addr;   
        struct m0_fid              rlc_rm_fid;    
        bool                       rlc_online;    
        struct m0_rw_lockable      rlc_rwlock;    
        struct m0_rm_owner         rlc_owner;     
        struct m0_fid              rlc_owner_fid; 
        struct m0_rm_remote        rlc_creditor;  
        struct m0_rm_incoming      rlc_req;       
        struct m0_clink            rlc_clink;     
        struct m0_rm_domain        rlc_dom;       
        struct m0_rm_resource_type rlc_rt;        
        m0_time_t                  rlc_timeout;   
};

/* -------------- Quorum calculation context ----------------- */

/*
 * Version Item.  Keeps version number along with counter.
 */
struct ver_item {
        uint64_t vi_ver;
        uint32_t vi_count;
};

enum {
        VERSION_ITEMS_TOTAL_MAX = 256
};

/*
 * Version Accumulator. Keeps already found version items along with counter and
 * total confd count.
 */
struct ver_accm {
        struct ver_item  va_items[VERSION_ITEMS_TOTAL_MAX];
        int              va_count;
        int              va_total;
};

/* --------------   Rconfc internals   ----------------- */

struct rconfc_link {
        struct m0_confc      rl_confc;         
        struct m0_rconfc    *rl_rconfc;        
        struct m0_confc_ctx  rl_cctx;          
        struct m0_clink      rl_clink;         
        struct m0_tlink      rl_herd;          
        struct m0_tlink      rl_active;        
        uint64_t             rl_magic;         
        char                *rl_confd_addr;    
        struct m0_fid        rl_confd_fid;     
        struct m0_clink      rl_ha_clink;      
        int                  rl_rc;            
        int                  rl_state;         
        bool                 rl_preserve;      
        struct m0_fom        rl_fom;           
        struct m0_clink      rl_fom_clink;     
        bool                 rl_fom_queued;    
        /* XXX: intended for UT only */
        void (*rl_on_state_cb)(struct rconfc_link *lnk);
        struct m0_sm_ast     rl_link_ast;
        bool                 rl_finalised;
};

M0_INTERNAL void rconfc_herd_link_cleanup(struct rconfc_link *lnk);
/*
 * made accessible for UT suites
 */
M0_INTERNAL struct rconfc_link *rconfc_herd_find(struct m0_rconfc *rconfc,
                                                 const char       *addr);

#endif /* __MOTR_CONF_RCONFC_INTERNAL_H__ */

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