storage_dev.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_IOSERVICE_STORAGE_DEV_H__
#define __MOTR_IOSERVICE_STORAGE_DEV_H__

#include "lib/tlist.h"
#include "lib/mutex.h"
#include "lib/thread_pool.h"
#include "lib/chan.h"
#include "ha/note.h"
#include "conf/obj.h"
#include "sm/sm.h"            /* m0_sm_ast */

/* import */
struct m0_stob;
struct m0_stob_id;
struct m0_stob_domain;
struct m0_dtx;
struct m0_be_seg;
struct m0_conf_sdev;
struct m0_reqh;

enum m0_storage_dev_type {
        M0_STORAGE_DEV_TYPE_LINUX = 1,
        M0_STORAGE_DEV_TYPE_AD,
};

struct m0_storage_dev {
        enum m0_storage_dev_type   isd_type;
        struct m0_stob            *isd_stob;
        struct m0_stob_domain     *isd_domain;
        uint64_t                   isd_cid;
        struct m0_tlink            isd_linkage;
        struct m0_clink            isd_clink;
        enum m0_ha_obj_state       isd_ha_state;
        enum m0_conf_service_type  isd_srv_type;
        uint64_t                   isd_magic;
        struct m0_ref              isd_ref;
        struct m0_chan             isd_detached_chan;
        struct m0_mutex            isd_detached_lock;
        char                      *isd_filename;
};

M0_TL_DESCR_DECLARE(storage_dev, M0_EXTERN);
M0_TL_DECLARE(storage_dev, M0_EXTERN, struct m0_storage_dev);

struct m0_storage_devs {
        enum m0_storage_dev_type sds_type;
        struct m0_mutex          sds_lock;
        struct m0_tl             sds_devices;
        struct m0_stob_domain   *sds_back_domain;
        struct m0_be_seg        *sds_be_seg;
        struct m0_parallel_pool  sds_pool;
        bool                     sds_use_directio;

        /* Conf event callbacks provisioning. */

        struct m0_clink          sds_conf_exp;
        struct m0_clink          sds_conf_ready_async;
        bool                     sds_locks_disabled;
};

M0_INTERNAL int m0_storage_devs_init(struct m0_storage_devs   *devs,
                                     enum m0_storage_dev_type  type,
                                     struct m0_be_seg         *be_seg,
                                     struct m0_stob_domain    *bstore_dom,
                                     struct m0_reqh           *reqh);
M0_INTERNAL void m0_storage_devs_fini(struct m0_storage_devs *devs);

M0_INTERNAL void m0_storage_devs_lock(struct m0_storage_devs *devs);

M0_INTERNAL void m0_storage_devs_unlock(struct m0_storage_devs *devs);

M0_INTERNAL void m0_storage_devs_use_directio(struct m0_storage_devs *devs,
                                              bool                    directio);

M0_INTERNAL void m0_storage_devs_locks_disable(struct m0_storage_devs *devs);

M0_INTERNAL struct m0_storage_dev *
m0_storage_devs_find_by_cid(struct m0_storage_devs *devs,
                            uint64_t                cid);
M0_INTERNAL struct m0_storage_dev *
m0_storage_devs_find_by_dom(struct m0_storage_devs *devs,
                            struct m0_stob_domain  *dom);

M0_INTERNAL void m0_storage_dev_get(struct m0_storage_dev *dev);
M0_INTERNAL void m0_storage_dev_put(struct m0_storage_dev *dev);

M0_INTERNAL int m0_storage_dev_new_by_conf(struct m0_storage_devs *devs,
                                           struct m0_conf_sdev    *sdev,
                                           bool                    force,
                                           struct m0_storage_dev **dev);

M0_INTERNAL int m0_storage_dev_new(struct m0_storage_devs *devs,
                                   uint64_t                cid,
                                   const char             *path,
                                   uint64_t                size,
                                   struct m0_conf_sdev    *sdev,
                                   bool                    force,
                                   struct m0_storage_dev **dev);

M0_INTERNAL void m0_storage_dev_destroy(struct m0_storage_dev *dev);

M0_INTERNAL void m0_storage_dev_attach(struct m0_storage_dev  *dev,
                                       struct m0_storage_devs *devs);

M0_INTERNAL void m0_storage_dev_detach(struct m0_storage_dev *dev);

M0_INTERNAL void m0_storage_devs_detach_all(struct m0_storage_devs *devs);

struct m0_storage_space {
        m0_bcount_t sds_free_blocks;
        m0_bcount_t sds_block_size;
        m0_bcount_t sds_avail_blocks;
        m0_bcount_t sds_total_size;
};

M0_INTERNAL void m0_storage_dev_space(struct m0_storage_dev   *dev,
                                      struct m0_storage_space *space);

M0_INTERNAL int m0_storage_dev_format(struct m0_storage_dev *dev,
                                      uint64_t               cid);

M0_INTERNAL int m0_storage_devs_fdatasync(struct m0_storage_devs *devs);

M0_INTERNAL int m0_storage_dev_stob_create(struct m0_storage_devs *devs,
                                           struct m0_stob_id      *sid,
                                           struct m0_dtx          *dtx);

M0_INTERNAL int m0_storage_dev_stob_destroy(struct m0_storage_devs *devs,
                                            struct m0_stob         *stob,
                                            struct m0_dtx          *dtx);

M0_INTERNAL int m0_storage_dev_stob_find(struct m0_storage_devs  *devs,
                                         struct m0_stob_id       *sid,
                                         struct m0_stob         **stob);

M0_INTERNAL void m0_storage_dev_stob_put(struct m0_storage_devs *devs,
                                         struct m0_stob         *stob);

#endif /* __MOTR_IOSERVICE_STORAGE_DEV_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */