recovery.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2014-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_BE_RECOVERY_H__
#define __MOTR_BE_RECOVERY_H__

#include "lib/tlist.h"          /* m0_tl */
#include "lib/mutex.h"          /* m0_mutex */
#include "lib/types.h"          /* bool */

struct m0_be_log;
struct m0_be_log_record_iter;

struct m0_be_recovery_cfg {
        struct m0_be_log *brc_log;
};

struct m0_be_recovery {
        struct m0_be_recovery_cfg brec_cfg;
        struct m0_mutex           brec_lock;
        struct m0_tl              brec_iters;
        m0_bindex_t               brec_last_record_pos;
        m0_bcount_t               brec_last_record_size;
        m0_bindex_t               brec_current;
        m0_bindex_t               brec_discarded;
};

M0_INTERNAL void m0_be_recovery_init(struct m0_be_recovery     *rvr,
                                     struct m0_be_recovery_cfg *cfg);
M0_INTERNAL void m0_be_recovery_fini(struct m0_be_recovery *rvr);
M0_INTERNAL int m0_be_recovery_run(struct m0_be_recovery *rvr);

M0_INTERNAL bool
m0_be_recovery_log_record_available(struct m0_be_recovery *rvr);

M0_INTERNAL void
m0_be_recovery_log_record_get(struct m0_be_recovery        *rvr,
                              struct m0_be_log_record_iter *iter);

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