formation2_internal.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_RPC_FORMATION2_H__
#define __MOTR_RPC_FORMATION2_H__

#include "lib/types.h"
#include "lib/tlist.h"

/* Imports */
struct m0_rpc_packet;
struct m0_rpc_item;
struct m0_rpc_session;

/* Forward references */
struct m0_rpc_frm_ops;

struct m0_rpc_frm_constraints {

        uint64_t    fc_max_nr_packets_enqed;

        m0_bcount_t fc_max_packet_size;

        uint64_t    fc_max_nr_segments;

        m0_bcount_t fc_max_nr_bytes_accumulated;
};

enum frm_state {
        FRM_UNINITIALISED,
        FRM_IDLE,
        FRM_BUSY,
        FRM_NR_STATES
};

enum m0_rpc_frm_itemq_type {
        FRMQ_URGENT,
        FRMQ_WAITING,
        FRMQ_NR_QUEUES
};

struct m0_rpc_frm {
        enum frm_state                 f_state;

        struct m0_tl                   f_itemq[FRMQ_NR_QUEUES];

        uint64_t                       f_nr_items;

        m0_bcount_t                    f_nr_bytes_accumulated;

        uint64_t                       f_nr_packets_enqed;

        struct m0_rpc_frm_constraints  f_constraints;

        const struct m0_rpc_frm_ops   *f_ops;

        uint64_t                       f_magic;
};

struct m0_rpc_frm_ops {
        int (*fo_packet_ready)(struct m0_rpc_packet *p);
};

extern const struct m0_rpc_frm_ops m0_rpc_frm_default_ops;

M0_INTERNAL void
m0_rpc_frm_constraints_get_defaults(struct m0_rpc_frm_constraints *constraint);

M0_INTERNAL void m0_rpc_frm_init(struct m0_rpc_frm *frm,
                                 struct m0_rpc_frm_constraints *constraints,
                                 const struct m0_rpc_frm_ops *ops);

M0_INTERNAL void m0_rpc_frm_fini(struct m0_rpc_frm *frm);

M0_INTERNAL void m0_rpc_frm_enq_item(struct m0_rpc_frm *frm,
                                     struct m0_rpc_item *item);
M0_INTERNAL void m0_rpc_frm_remove_item(struct m0_rpc_frm *frm,
                                        struct m0_rpc_item *item);

M0_INTERNAL void m0_rpc_frm_item_deadline_passed(struct m0_rpc_frm *frm,
                                                 struct m0_rpc_item *item);

M0_INTERNAL void m0_rpc_frm_packet_done(struct m0_rpc_packet *packet);

M0_INTERNAL void m0_rpc_frm_run_formation(struct m0_rpc_frm *frm);

M0_INTERNAL struct m0_rpc_frm *session_frm(const struct m0_rpc_session *s);

M0_TL_DESCR_DECLARE(itemq, M0_EXTERN);
M0_TL_DECLARE(itemq, M0_INTERNAL, struct m0_rpc_item);

M0_INTERNAL struct m0_rpc_chan *frm_rchan(const struct m0_rpc_frm *frm);
M0_INTERNAL struct m0_rpc_machine *frm_rmachine(const struct m0_rpc_frm *frm);

M0_INTERNAL bool item_is_in_waiting_queue(const struct m0_rpc_item *item,
                                          const struct m0_rpc_frm *frm);

#endif /* __MOTR_RPC_FORMATION2_H__ */