m0hsm_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020 Seagate Technology LLC and/or its Affiliates
 * COPYRIGHT 2017-2018 CEA[1] and SAGE partners
 *
 * 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.
 *
 * [1]Commissariat a l'energie atomique et aux energies alternatives
 *
 * Original author: Thomas Leibovici <thomas.leibovici@cea.fr>
 */

#pragma once

#ifndef __MOTR_HSM_M0HSM_API_H__
#define __MOTR_HSM_M0HSM_API_H__

#include <stdio.h>
#include <stdint.h>

#include "motr/client.h"

/*
 * Before using HSM calls, application should initialize Motr client API
 * with DIX index enabled (see m0_client_init()). It should then pass the
 * created client context to HSM by using m0hsm_init().
 */

enum hsm_log_level {
        LOG_NONE = 0,
        LOG_ERROR,
        LOG_INFO,
        LOG_VERB,
        LOG_DEBUG
};

struct m0hsm_options {
        enum hsm_log_level trace_level;
        time_t             op_timeout;
        FILE              *log_stream;
        FILE              *rcfile;
};

enum {MAX_M0_BUFSZ = 128*1024*1024};

#define HSM_TIER_MAX    (UINT8_MAX - 1)

int m0hsm_init(struct m0_client *instance, struct m0_realm *uber_realm,
               const struct m0hsm_options *options);

int m0hsm_create(struct m0_uint128 id, struct m0_obj *obj,
                 uint8_t tier_idx, bool keep_open);

int m0hsm_pwrite(struct m0_obj *obj, void *buf, size_t len, off_t off);

int m0hsm_set_write_tier(struct m0_uint128 id, uint8_t tier_idx);


/* -------------- HSM low-level calls ------------ */

enum hsm_cp_flags {
        HSM_MOVE          = (1 << 0), 
        HSM_KEEP_OLD_VERS = (1 << 1), 
        HSM_WRITE_TO_DEST = (1 << 2), 
};

int m0hsm_copy(struct m0_uint128 obj_id, uint8_t src_tier_idx,
              uint8_t tgt_tier_idx, off_t offset, size_t length,
              enum hsm_cp_flags flags);

enum hsm_rls_flags {
        HSM_KEEP_LATEST = (1 << 0), 
};

int m0hsm_release(struct m0_uint128 obj_id, uint8_t tier_idx,
                 off_t offset, size_t length, enum hsm_rls_flags flags);

/* -------------- HSM higer-level calls ------------ */

int m0hsm_stage(struct m0_uint128 obj_id, uint8_t target_tier,
                off_t offset, size_t length, enum hsm_cp_flags flags);

int m0hsm_archive(struct m0_uint128 obj_id, uint8_t target_tier,
                  off_t offset, size_t length, enum hsm_cp_flags flags);

int m0hsm_multi_release(struct m0_uint128 obj_id, uint8_t max_tier,
                        off_t offset, size_t length, enum hsm_rls_flags flags);


int m0hsm_dump(FILE *stream, struct m0_uint128 id, bool details);

#endif /* __M0HSM_API_H__ */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */