epoch.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_HA_EPOCH_H__
#define __MOTR_HA_EPOCH_H__


/* import */
#include "lib/types.h"
#include "lib/tlist.h"
#include "lib/rwlock.h"
struct m0_rpc_item;
struct m0_confc;

/* export */
struct m0_ha_domain;

struct m0_ha_epoch_monitor {
        int (*hem_past)(struct m0_ha_epoch_monitor *self, uint64_t epoch,
                        const struct m0_rpc_item *item);
        int (*hem_future)(struct m0_ha_epoch_monitor *self, uint64_t epoch,
                          const struct m0_rpc_item *item);
        struct m0_tlink      hem_linkage;
        struct m0_ha_domain *hem_domain;
        uint64_t             hem_magix;
};

struct m0_ha_domain {
        uint64_t         hdo_epoch;
        struct m0_rwlock hdo_lock;
        struct m0_tl               hdo_monitors;
        struct m0_ha_epoch_monitor hdo_default_mon;
};

enum m0_ha_epoch_outcome {
        M0_HEO_CONTINUE,
        M0_HEO_OK,
        M0_HEO_OBEY,
        M0_HEO_DROP,
        M0_HEO_ERROR
};

M0_EXTERN const uint64_t M0_HA_EPOCH_NONE;

M0_INTERNAL void m0_ha_domain_init(struct m0_ha_domain *dom, uint64_t epoch);
M0_INTERNAL void m0_ha_domain_fini(struct m0_ha_domain *dom);

M0_INTERNAL void m0_ha_domain_monitor_add(struct m0_ha_domain *dom,
                                        struct m0_ha_epoch_monitor *mon);
M0_INTERNAL void m0_ha_domain_monitor_del(struct m0_ha_domain *dom,
                                        struct m0_ha_epoch_monitor *mon);

M0_INTERNAL uint64_t m0_ha_domain_get_read(struct m0_ha_domain *dom);

M0_INTERNAL void m0_ha_domain_put_read(struct m0_ha_domain *dom);

M0_INTERNAL uint64_t m0_ha_domain_get_write(struct m0_ha_domain *dom);

M0_INTERNAL void m0_ha_domain_put_write(struct m0_ha_domain *dom, uint64_t epoch);

M0_INTERNAL int  m0_ha_global_init(void);
M0_INTERNAL void m0_ha_global_fini(void);

M0_INTERNAL int m0_ha_client_add(struct m0_confc *confc);

M0_INTERNAL int m0_ha_client_del(struct m0_confc *confc);

typedef void (*m0_ha_client_cb_t)(void       *client,
                                  const void *data,
                                  uint64_t    data2);

M0_INTERNAL void m0_ha_clients_iterate(m0_ha_client_cb_t iter,
                                       const void       *data,
                                       uint64_t          data2);

M0_INTERNAL int m0_ha_epoch_check(const struct m0_rpc_item *item);

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