extmap.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_BE_EXTMAP_H__
#define __MOTR_BE_EXTMAP_H__

#include "lib/ext.h"       /* m0_ext */
#include "lib/ext_xc.h"    /* m0_ext_xc */
#include "lib/types.h"     /* struct m0_uint128 */
#include "lib/types_xc.h"  /* m0_uint128_xc */
#include "be/tx.h"
#include "be/btree.h"
#include "be/btree_xc.h"

#include "be/extmap_internal.h"
#include "be/extmap_internal_xc.h"

/* import */
struct m0_be_emap;
struct m0_be_seg;
struct m0_be_tx;
struct m0_indexvec;

/* export */
struct m0_be_emap_seg;
struct m0_be_emap_cursor;

M0_INTERNAL void m0_be_emap_init(struct m0_be_emap *map,
                                 struct m0_be_seg  *db);

M0_INTERNAL void m0_be_emap_fini(struct m0_be_emap *map);

M0_INTERNAL void m0_be_emap_create(struct m0_be_emap   *map,
                                   struct m0_be_tx     *tx,
                                   struct m0_be_op     *op,
                                   const struct m0_fid *fid);

M0_INTERNAL void m0_be_emap_destroy(struct m0_be_emap *map,
                                    struct m0_be_tx   *tx,
                                    struct m0_be_op   *op);

M0_INTERNAL void m0_be_emap_obj_insert(struct m0_be_emap *map,
                                       struct m0_be_tx   *tx,
                                       struct m0_be_op   *op,
                                 const struct m0_uint128 *prefix,
                                       uint64_t           val);

M0_INTERNAL void m0_be_emap_obj_delete(struct m0_be_emap *map,
                                       struct m0_be_tx   *tx,
                                       struct m0_be_op   *op,
                                 const struct m0_uint128 *prefix);

struct m0_be_emap_seg {
        struct m0_uint128 ee_pre;
        struct m0_ext     ee_ext;
        uint64_t          ee_val;
        struct m0_buf     ee_cksum_buf;
} M0_XCA_RECORD M0_XCA_DOMAIN(be);

struct m0_be_emap_cursor {
        struct m0_be_emap        *ec_map;
        uint64_t                  ec_version;
        struct m0_be_emap_seg     ec_seg;
        struct m0_be_btree_cursor ec_cursor;
        struct m0_be_emap_key     ec_key;
        struct m0_be_emap_rec     ec_rec;
        struct m0_buf             ec_keybuf;
        struct m0_buf             ec_recbuf;
        struct m0_uint128         ec_prefix;
        m0_bindex_t               ec_unit_size;
        struct m0_buf             ec_app_cksum_buf;
        struct m0_be_op           ec_op;
};

M0_INTERNAL bool m0_be_emap_ext_is_last(const struct m0_ext *ext);

M0_INTERNAL bool m0_be_emap_ext_is_first(const struct m0_ext *ext);

M0_INTERNAL struct m0_be_emap_seg *
        m0_be_emap_seg_get(struct m0_be_emap_cursor *it);

M0_INTERNAL struct m0_be_op *m0_be_emap_op(struct m0_be_emap_cursor *it);
M0_INTERNAL int m0_be_emap_op_rc(const struct m0_be_emap_cursor *it);

M0_INTERNAL void m0_be_emap_lookup(struct m0_be_emap        *map,
                             const struct m0_uint128        *prefix,
                                   m0_bindex_t               offset,
                                   struct m0_be_emap_cursor *it);

M0_INTERNAL void m0_be_emap_next(struct m0_be_emap_cursor *it);

M0_INTERNAL void m0_be_emap_prev(struct m0_be_emap_cursor *it);

M0_INTERNAL void m0_be_emap_merge(struct m0_be_emap_cursor *it,
                                  struct m0_be_tx          *tx,
                                  m0_bindex_t               delta);

M0_INTERNAL void m0_be_emap_split(struct m0_be_emap_cursor *it,
                                  struct m0_be_tx          *tx,
                                  struct m0_indexvec       *vec,
                                  struct m0_buf            *cksum);

M0_INTERNAL void m0_be_emap_paste(struct m0_be_emap_cursor *it,
                                  struct m0_be_tx          *tx,
                                  struct m0_ext            *ext,
                                  uint64_t                  val,
        void (*del)(struct m0_be_emap_seg*),
        void (*cut_left)(struct m0_be_emap_seg*, struct m0_ext*, uint64_t),
        void (*cut_right)(struct m0_be_emap_seg*, struct m0_ext*, uint64_t));

M0_INTERNAL int m0_be_emap_count(struct m0_be_emap_cursor *it,
                                 m0_bcount_t *segs);

M0_INTERNAL void m0_be_emap_extent_update(struct m0_be_emap_cursor *it,
                                          struct m0_be_tx          *tx,
                                    const struct m0_be_emap_seg    *es);

M0_INTERNAL void m0_be_emap_close(struct m0_be_emap_cursor *it);

struct m0_be_emap_caret {
        struct m0_be_emap_cursor *ct_it;
        m0_bindex_t            ct_index;
};

M0_INTERNAL void m0_be_emap_caret_init(struct m0_be_emap_caret  *car,
                                       struct m0_be_emap_cursor *it,
                                       m0_bindex_t               index);

M0_INTERNAL void m0_be_emap_caret_fini(struct m0_be_emap_caret *car);

M0_INTERNAL int m0_be_emap_caret_move(struct m0_be_emap_caret *car,
                                      m0_bcount_t              count);

M0_INTERNAL int m0_be_emap_caret_move_sync(struct m0_be_emap_caret *car,
                                           m0_bcount_t              count);

M0_INTERNAL m0_bcount_t m0_be_emap_caret_step(const struct m0_be_emap_caret*);

enum m0_be_emap_optype {
        M0_BEO_CREATE,  
        M0_BEO_DESTROY, 
        M0_BEO_INSERT,  
        M0_BEO_DELETE,  
        M0_BEO_UPDATE,  
        M0_BEO_MERGE,   
        M0_BEO_SPLIT,   
        M0_BEO_PASTE,   
};

M0_INTERNAL void m0_be_emap_credit(struct m0_be_emap      *emap,
                                   enum m0_be_emap_optype  optype,
                                   m0_bcount_t             nr,
                                   struct m0_be_tx_credit *accum);

M0_INTERNAL
struct m0_be_domain *m0_be_emap_seg_domain(const struct m0_be_emap *emap);

/*
 * Dumps the number of cobs and segments from the @emap
 * into the trace logs. Note, on large amount of data
 * when BE segment does not fit into available RAM this
 * may generate a lot of I/O because of page-ins.
 */
M0_INTERNAL int m0_be_emap_dump(struct m0_be_emap *emap);

/* __MOTR_BE_EXTMAP_H__ */
#endif

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