stob.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_STOB_STOB_H__
#define __MOTR_STOB_STOB_H__

#include "lib/atomic.h"
#include "lib/types.h"         /* m0_uint128 */
#include "lib/vec.h"
#include "lib/chan.h"
#include "lib/rwlock.h"
#include "lib/tlist.h"
#include "fid/fid.h"
#include "sm/sm.h"
#include "stob/cache.h"         /* m0_stob_cache */
#include "fid/fid_xc.h"
#include "be/extmap.h"          /* m0_be_emap_seg */

#ifndef MAXPATHLEN
#define MAXPATHLEN 1024
#endif

/* import */
struct m0_dtx;
struct m0_chan;
struct m0_indexvec;
struct m0_io_scope;

struct m0_be_tx_credit;
struct m0_be_seg;
struct m0_dtx;

struct m0_stob_type_ops;
struct m0_stob_domain_ops;
struct m0_stob_domain;
struct m0_stob_ops;
struct m0_stob;
struct m0_stob_io;

enum m0_stob_state {
        CSS_UNKNOWN,
        CSS_EXISTS,
        CSS_NOENT,
        CSS_DELETE,
};

struct m0_stob_id {
        /* Stob domain fid. @see m0_stob_domain, m0_stob */
        struct m0_fid si_domain_fid;
        /* Stob fid. @see m0_stob */
        struct m0_fid si_fid;
} M0_XCA_RECORD M0_XCA_DOMAIN(be|rpc);

#define STOB_ID_F  "{" FID_F "," FID_F "}"
#define STOB_ID_P(si)  FID_P(&(si)->si_domain_fid), FID_P(&(si)->si_fid)

struct m0_stob {
        const struct m0_stob_ops *so_ops;
        struct m0_stob_domain    *so_domain;
        struct m0_stob_id         so_id;
        enum m0_stob_state        so_state;
        uint64_t                  so_ref;
        struct m0_chan            so_ref_chan;
        /* so_ref_chan protection. */
        struct m0_mutex           so_ref_mutex;
        struct m0_tlink           so_cache_linkage;
        uint64_t                  so_cache_magic;
        void                     *so_private;
};

struct m0_stob_ops {
        void (*sop_fini)(struct m0_stob *stob);
        void (*sop_destroy_credit)(struct m0_stob *stob,
                                   struct m0_be_tx_credit *accum);
        int (*sop_destroy)(struct m0_stob *stob, struct m0_dtx *dtx);
        int (*sop_punch_credit)(struct m0_stob *stob,
                                struct m0_indexvec *want,
                                struct m0_indexvec *got,
                                struct m0_be_tx_credit *accum);
        int (*sop_punch)(struct m0_stob *stob, struct m0_indexvec *range,
                         struct m0_dtx *dtx);
        int  (*sop_io_init)(struct m0_stob *stob, struct m0_stob_io *io);
        uint32_t (*sop_block_shift)(struct m0_stob *stob);
        int (*sop_fd)(struct m0_stob *stob);
};

M0_INTERNAL int m0_stob_find(const struct m0_stob_id *id, struct m0_stob **out);
M0_INTERNAL int m0_stob_find_by_key(struct m0_stob_domain *dom,
                                    const struct m0_fid *stob_fid,
                                    struct m0_stob **out);

M0_INTERNAL int m0_stob_lookup(const struct m0_stob_id *id,
                               struct m0_stob **out);
M0_INTERNAL int m0_stob_lookup_by_key(struct m0_stob_domain *dom,
                                      const struct m0_fid *stob_fid,
                                      struct m0_stob **out);

M0_INTERNAL int m0_stob_locate(struct m0_stob *stob);

M0_INTERNAL void m0_stob_create_credit(struct m0_stob_domain *dom,
                                       struct m0_be_tx_credit *accum);
M0_INTERNAL int m0_stob_create(struct m0_stob *stob,
                               struct m0_dtx *dtx,
                               const char *str_cfg);

M0_INTERNAL void m0_stob_destroy_credit(struct m0_stob *stob,
                                        struct m0_be_tx_credit *accum);

M0_INTERNAL void m0_stob_delete_mark(struct m0_stob *stob);

/*
 * Destroys stob.
 *
 * @pre stob->so_state != CSS_UNKNOWN
 * @pre stob->so_ref == 1
 */
M0_INTERNAL int m0_stob_destroy(struct m0_stob *stob, struct m0_dtx *dtx);

M0_INTERNAL int m0_stob_punch_credit(struct m0_stob *stob,
                                     struct m0_indexvec *want,
                                     struct m0_indexvec *got,
                                     struct m0_be_tx_credit *accum);

M0_INTERNAL int m0_stob_punch(struct m0_stob *stob,
                              struct m0_indexvec *range,
                              struct m0_dtx *dtx);

M0_INTERNAL uint32_t m0_stob_block_shift(struct m0_stob *stob);

M0_INTERNAL void m0_stob_get(struct m0_stob *stob);

M0_INTERNAL void m0_stob_put(struct m0_stob *stob);

M0_INTERNAL struct m0_stob_domain *m0_stob_dom_get(struct m0_stob *stob);

M0_INTERNAL enum m0_stob_state m0_stob_state_get(struct m0_stob *stob);

M0_INTERNAL uint64_t m0_stob_dom_id_get(struct m0_stob *stob);
M0_INTERNAL const struct m0_stob_id *m0_stob_id_get(struct m0_stob *stob);
M0_INTERNAL const struct m0_fid *m0_stob_fid_get(struct m0_stob *stob);
M0_INTERNAL uint64_t m0_stob_id_dom_id_get(const struct m0_stob_id *stob_id);
M0_INTERNAL void m0_stob_id_make(uint64_t container,
                                 uint64_t key,
                                 const struct m0_fid *dom_id,
                                 struct m0_stob_id *stob_id);

M0_INTERNAL bool m0_stob_id_eq(const struct m0_stob_id *stob_id0,
                               const struct m0_stob_id *stob_id1);

M0_INTERNAL int m0_stob_fd(struct m0_stob *stob);

M0_INTERNAL int m0_stob_mod_init(void);
M0_INTERNAL void m0_stob_mod_fini(void);

#endif /* __MOTR_STOB_STOB_H__ */

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