msg_queue.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_HA_MSG_QUEUE_H__
#define __MOTR_HA_MSG_QUEUE_H__

#include "lib/types.h"  /* uint64_t */
#include "lib/tlist.h"  /* m0_tlink */
#include "ha/msg.h"     /* m0_ha_msg */

enum m0_ha_msg_qitem_delivery_state {
        M0_HA_MSG_QITEM_NOT_DELIVERED,
        M0_HA_MSG_QITEM_DELIVERED,
};

struct m0_ha_msg_qitem {
        struct m0_ha_msg                    hmq_msg;
        enum m0_ha_msg_qitem_delivery_state hmq_delivery_state;
        struct m0_tlink                     hmq_link;
        uint64_t                            hmq_magic;
};

struct m0_ha_msg_queue_cfg {
        int unused;
};

struct m0_ha_msg_queue {
        struct m0_ha_msg_queue_cfg mq_cfg;
        struct m0_tl               mq_queue;
};

M0_INTERNAL void m0_ha_msg_queue_init(struct m0_ha_msg_queue     *mq,
                                      struct m0_ha_msg_queue_cfg *cfg);
M0_INTERNAL void m0_ha_msg_queue_fini(struct m0_ha_msg_queue *mq);
M0_INTERNAL struct m0_ha_msg_qitem *
m0_ha_msg_queue_alloc(struct m0_ha_msg_queue *mq);
M0_INTERNAL void m0_ha_msg_queue_free(struct m0_ha_msg_queue *mq,
                                      struct m0_ha_msg_qitem *qitem);
M0_INTERNAL void m0_ha_msg_queue_enqueue(struct m0_ha_msg_queue *mq,
                                         struct m0_ha_msg_qitem *qitem);
M0_INTERNAL struct m0_ha_msg_qitem *
m0_ha_msg_queue_dequeue(struct m0_ha_msg_queue *mq);
M0_INTERNAL void m0_ha_msg_queue_push_front(struct m0_ha_msg_queue *mq,
                                            struct m0_ha_msg_qitem *qitem);
M0_INTERNAL bool m0_ha_msg_queue_is_empty(struct m0_ha_msg_queue *mq);
M0_INTERNAL struct m0_ha_msg_qitem *
m0_ha_msg_queue_find(struct m0_ha_msg_queue *mq,
                     uint64_t                tag);
M0_INTERNAL struct m0_ha_msg_qitem *
m0_ha_msg_queue_next(struct m0_ha_msg_queue *mq,
                     const struct m0_ha_msg_qitem *cur);
M0_INTERNAL struct m0_ha_msg_qitem *
m0_ha_msg_queue_prev(struct m0_ha_msg_queue *mq,
                     const struct m0_ha_msg_qitem *cur);


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