at.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_RPC_AT_H__
#define __MOTR_RPC_AT_H__

#include "lib/types.h"
#include "lib/buf.h"              /* m0_buf */
#include "lib/buf_xc.h"           /* m0_buf_xc */
#include "net/net_otw_types.h"    /* m0_net_buf_desc_data */
#include "net/net_otw_types_xc.h" /* m0_net_buf_desc_data */
#include "xcode/xcode_attr.h"
#include "lib/assert.h"           /* M0_BASSERT */


/* Import */
struct m0_fom;
struct m0_rpc_conn;
struct rpc_at_bulk;

enum m0_rpc_at_type {
        M0_RPC_AT_EMPTY     = 0,
        M0_RPC_AT_INLINE    = 1,
        M0_RPC_AT_BULK_SEND = 2,
        M0_RPC_AT_BULK_RECV = 3,
        M0_RPC_AT_BULK_REP  = 4,
        M0_RPC_AT_TYPE_NR
};

enum {
        M0_RPC_AT_UNKNOWN_LEN = 0,
};

struct m0_rpc_at_bulk_rep {
        int32_t  abr_rc;

        uint64_t abr_len;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rpc_at_extra {
        /* This field is not used, it's neccessary for proper alignment only. */
        struct m0_net_buf_desc_data  abr_desc;
        struct rpc_at_bulk          *abr_bulk;
        struct m0_buf                abr_user_buf;
} M0_XCA_RECORD M0_XCA_DOMAIN(rpc);

struct m0_rpc_at_buf {
        uint32_t ab_type;
        union {
                struct m0_buf               ab_buf
                        M0_XCA_TAG("M0_RPC_AT_INLINE");

                struct m0_net_buf_desc_data ab_send
                        M0_XCA_TAG("M0_RPC_AT_BULK_SEND");

                struct m0_net_buf_desc_data ab_recv
                        M0_XCA_TAG("M0_RPC_AT_BULK_RECV");

                struct m0_rpc_at_bulk_rep   ab_rep
                        M0_XCA_TAG("M0_RPC_AT_BULK_REP");

                struct m0_rpc_at_extra      ab_extra
                        M0_XCA_TAG("M0_RPC_AT_TYPE_NR");
        } u;
} M0_XCA_UNION M0_XCA_DOMAIN(rpc);

/* Checks that ab_extra is properly placed in union. */
M0_BASSERT(sizeof((struct m0_rpc_at_buf *) 0)->u ==
           sizeof(struct m0_rpc_at_extra));
M0_BASSERT(offsetof(struct m0_rpc_at_buf, u.ab_extra.abr_bulk) >=
           sizeof((struct m0_rpc_at_buf *) 0)->u.ab_buf);
M0_BASSERT(offsetof(struct m0_rpc_at_buf, u.ab_extra.abr_bulk) >=
           sizeof((struct m0_rpc_at_buf *) 0)->u.ab_send);
M0_BASSERT(offsetof(struct m0_rpc_at_buf, u.ab_extra.abr_bulk) >=
           sizeof((struct m0_rpc_at_buf *) 0)->u.ab_recv);
M0_BASSERT(offsetof(struct m0_rpc_at_buf, u.ab_extra.abr_bulk) >=
           sizeof((struct m0_rpc_at_buf *) 0)->u.ab_rep);

M0_INTERNAL void m0_rpc_at_init(struct m0_rpc_at_buf *ab);

M0_INTERNAL void m0_rpc_at_fini(struct m0_rpc_at_buf *ab);

M0_INTERNAL int m0_rpc_at_add(struct m0_rpc_at_buf     *ab,
                              const struct m0_buf      *buf,
                              const struct m0_rpc_conn *conn);

M0_INTERNAL int m0_rpc_at_load(struct m0_rpc_at_buf *ab, struct m0_fom *fom,
                               int next_phase);

M0_INTERNAL int m0_rpc_at_get(const struct m0_rpc_at_buf *ab,
                              struct m0_buf              *buf);


M0_INTERNAL int m0_rpc_at_recv(struct m0_rpc_at_buf     *ab,
                               const struct m0_rpc_conn *conn,
                               uint32_t                  len,
                               bool                      force_bulk);

M0_INTERNAL int m0_rpc_at_reply(struct m0_rpc_at_buf *in,
                                struct m0_rpc_at_buf *out,
                                struct m0_buf        *repbuf,
                                struct m0_fom        *fom,
                                int                   next_phase);

M0_INTERNAL int m0_rpc_at_reply_rc(struct m0_rpc_at_buf *out);

M0_INTERNAL int m0_rpc_at_rep_get(struct m0_rpc_at_buf *sent,
                                  struct m0_rpc_at_buf *rcvd,
                                  struct m0_buf        *out);

M0_INTERNAL int m0_rpc_at_rep2inline(struct m0_rpc_at_buf *sent,
                                     struct m0_rpc_at_buf *rcvd);

M0_INTERNAL bool m0_rpc_at_rep_is_bulk(const struct m0_rpc_at_buf *rcvd,
                                       uint64_t                   *len);

M0_INTERNAL bool m0_rpc_at_is_set(const struct m0_rpc_at_buf *ab);

M0_INTERNAL void m0_rpc_at_detach(struct m0_rpc_at_buf *ab);

M0_INTERNAL uint64_t m0_rpc_at_len(const struct m0_rpc_at_buf *ab);

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