ag.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_CM_AG_H__
#define __MOTR_CM_AG_H__

#include "lib/atomic.h"
#include "lib/types.h"
#include "lib/types_xc.h"
#include "lib/tlist.h"
#include "lib/mutex.h"
#include "lib/refs.h"

#include "sm/sm.h"

struct m0_cm_cp;
struct m0_cm_proxy;
struct m0_cm_sw;

struct m0_cm_ag_id {
        struct m0_uint128 ai_hi;
        struct m0_uint128 ai_lo;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

#define M0_AG_F U128X_F "::" U128X_F
#define M0_AG_P(ag) U128_P(&((ag)->ai_hi)), U128_P(&((ag)->ai_lo))

#define ID_LOG(prefix, id) M0_LOG(M0_DEBUG, prefix "=["M0_AG_F"]", M0_AG_P(id))
#define ID_INCOMING_LOG(prefix, id, has_incoming)                       \
        M0_LOG(M0_DEBUG, prefix "=["M0_AG_F"] has incoming: %d",        \
               M0_AG_P(id), !!(has_incoming));

#define GRP_END_MARK_ID (struct m0_cm_ag_id) {           \
        .ai_hi = M0_UINT128((uint64_t)-1, (uint64_t)-1), \
        .ai_lo = M0_UINT128((uint64_t)-1, (uint64_t)-1)  \
}

struct m0_cm_aggr_group {
        struct m0_cm                      *cag_cm;

        struct m0_cm_ag_id                 cag_id;

        const struct m0_cm_aggr_group_ops *cag_ops;

        struct m0_mutex                    cag_mutex;

        struct m0_sm_ast                   cag_fini_ast;

        uint64_t                           cag_ref;

        uint64_t                           cag_cp_global_nr;

        uint64_t                           cag_cp_local_nr;

        uint64_t                           cag_transformed_cp_nr;

        uint64_t                           cag_freed_cp_nr;

        bool                               cag_has_incoming;

        bool                               cag_is_finalising;

        bool                               cag_is_frozen;

        struct m0_tlink                    cag_cm_in_linkage;

        struct m0_tlink                    cag_cm_out_linkage;

        int                                cag_rc;

        uint64_t                           cag_magic;
};

struct m0_cm_aggr_group_ops {
        bool (*cago_ag_can_fini) (const struct m0_cm_aggr_group *ag);

        void (*cago_fini)(struct m0_cm_aggr_group *ag);

        uint64_t (*cago_local_cp_nr)(const struct m0_cm_aggr_group *ag);

        bool (*cago_has_incoming_from)(struct m0_cm_aggr_group *ag,
                                       struct m0_cm_proxy *proxy);

        bool (*cago_is_frozen_on)(struct m0_cm_aggr_group *ag, struct m0_cm_proxy *proxy);
};

extern struct m0_bob_type aggr_grps_bob;

M0_INTERNAL void m0_cm_aggr_group_init(struct m0_cm_aggr_group *ag,
                                       struct m0_cm *cm,
                                       const struct m0_cm_ag_id *id,
                                       bool has_incoming,
                                       const struct m0_cm_aggr_group_ops
                                       *ag_ops);

M0_INTERNAL void m0_cm_aggr_group_fini(struct m0_cm_aggr_group *ag);

/*
 * Finalises the given aggregation group and also updates the sliding window.
 * If there is no more data to be restructured, marks the operation as complete
 * by invoking m0_cm_ops::cmo_complete().
 */
M0_INTERNAL void m0_cm_aggr_group_fini_and_progress(struct m0_cm_aggr_group *ag);
M0_INTERNAL int m0_cm_ag_id_cmp(const struct m0_cm_ag_id *id0,
                                const struct m0_cm_ag_id *id1);

M0_INTERNAL void m0_cm_ag_id_copy(struct m0_cm_ag_id *dst,
                                  const struct m0_cm_ag_id *src);

M0_INTERNAL bool m0_cm_ag_id_is_set(const struct m0_cm_ag_id *id);

M0_INTERNAL struct m0_cm_aggr_group *m0_cm_aggr_group_locate(struct m0_cm *cm,
                                                             const struct
                                                             m0_cm_ag_id *id,
                                                             bool has_incoming);

M0_INTERNAL int m0_cm_aggr_group_alloc(struct m0_cm *cm,
                                       const struct m0_cm_ag_id *id,
                                       bool has_incoming,
                                       struct m0_cm_aggr_group **out);

M0_INTERNAL void m0_cm_aggr_group_add(struct m0_cm *cm,
                                      struct m0_cm_aggr_group *ag,
                                      bool has_incoming);

M0_INTERNAL struct m0_cm_aggr_group *m0_cm_ag_in_hi(const struct m0_cm *cm);

M0_INTERNAL struct m0_cm_aggr_group *m0_cm_ag_in_lo(const struct m0_cm *cm);

M0_INTERNAL struct m0_cm_aggr_group *m0_cm_ag_out_hi(const struct m0_cm *cm);

M0_INTERNAL struct m0_cm_aggr_group *m0_cm_ag_out_lo(const struct m0_cm *cm);

M0_INTERNAL void m0_cm_ag_in_interval(const struct m0_cm *cm,
                                      struct m0_cm_sw *in_interval);

M0_INTERNAL void m0_cm_ag_out_interval(const struct m0_cm *cm,
                                       struct m0_cm_sw *out_interval);
M0_INTERNAL int m0_cm_ag_advance(struct m0_cm *cm);

M0_INTERNAL bool m0_cm_aggr_group_tlists_are_empty(struct m0_cm *cm);

M0_INTERNAL void m0_cm_ag_lock(struct m0_cm_aggr_group *ag);
M0_INTERNAL void m0_cm_ag_unlock(struct m0_cm_aggr_group *ag);
M0_INTERNAL bool m0_cm_ag_is_locked(struct m0_cm_aggr_group *ag);
M0_INTERNAL void m0_cm_ag_get(struct m0_cm_aggr_group *ag);
M0_INTERNAL void m0_cm_ag_put(struct m0_cm_aggr_group *ag);

M0_INTERNAL void m0_cm_ag_cp_add_locked(struct m0_cm_aggr_group *ag,
                                        struct m0_cm_cp *cp);
M0_INTERNAL void m0_cm_ag_cp_add(struct m0_cm_aggr_group *ag, struct m0_cm_cp *cp);
M0_INTERNAL void m0_cm_ag_cp_del(struct m0_cm_aggr_group *ag, struct m0_cm_cp *cp);
M0_INTERNAL bool m0_cm_ag_has_pending_cps(struct m0_cm_aggr_group *ag);
M0_INTERNAL void m0_cm_ag_fini_post(struct m0_cm_aggr_group *ag);
M0_INTERNAL bool m0_cm_ag_can_fini(struct m0_cm_aggr_group *ag);

M0_TL_DESCR_DECLARE(aggr_grps_in, M0_EXTERN);
M0_TL_DECLARE(aggr_grps_in, M0_INTERNAL, struct m0_cm_aggr_group);

M0_TL_DESCR_DECLARE(aggr_grps_out, M0_EXTERN);
M0_TL_DECLARE(aggr_grps_out, M0_INTERNAL, struct m0_cm_aggr_group);

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