stob.c

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.
 *
 */


#define M0_TRACE_SUBSYSTEM M0_TRACE_SUBSYS_UT
#include "lib/trace.h"

#include "ut/stob.h"

#include "lib/misc.h"           /* ARRAY_SIZE */
#include "lib/mutex.h"          /* m0_mutex */
#include "lib/memory.h"         /* M0_ALLOC_PTR */
#include "lib/errno.h"          /* ENOMEM */

#include "module/instance.h"    /* m0_get */
#include "be/tx_credit.h"       /* m0_be_tx_credit */
#include "be/ut/helper.h"       /* m0_be_ut_backend_sm_group_lookup */
#include "dtm/dtm.h"            /* m0_dtx */

#include "stob/domain.h"        /* m0_stob_domain */
#include "stob/stob.h"          /* m0_stob_find */

enum {
        UT_STOB_KEY_BEGIN = 42,
};

struct ut_stob_module {
        struct m0_mutex        usm_lock;
        uint64_t               usm_stob_key;
        struct m0_stob_domain *usm_dom_linux;
};

static int level_ut_stob_enter(struct m0_module *module);
static void level_ut_stob_leave(struct m0_module *module);

struct m0_modlev m0_levels_ut_stob[] = {
        [M0_LEVEL_UT_STOB] = {
                .ml_name = "stob UT helper is initialised",
                .ml_enter = level_ut_stob_enter,
                .ml_leave = level_ut_stob_leave,
        },
};
const unsigned m0_levels_ut_stob_nr = ARRAY_SIZE(m0_levels_ut_stob);

/* linux stob domain configuratin */
static const char     *ut_stob_domain_location   = "linuxstob:./ut_stob";
static const uint64_t  ut_stob_domain_key        = 0x10000;
static const char     *ut_stob_domain_init_cfg   = "";
static const char     *ut_stob_domain_create_cfg = "";

static int level_ut_stob_enter(struct m0_module *module)
{
        return m0_ut_stob_init();
}

static void level_ut_stob_leave(struct m0_module *module)
{
        m0_ut_stob_fini();
}

static struct ut_stob_module *ut_stob_module_get(void)
{
        struct ut_stob_module *usm = m0_get()->i_ut_stob_module.usm_private;
        int                    rc;

        m0_mutex_lock(&usm->usm_lock);
        if (usm->usm_dom_linux == NULL) {
                rc = m0_stob_domain_create_or_init(ut_stob_domain_location,
                                                   ut_stob_domain_init_cfg,
                                                   ut_stob_domain_key,
                                                   ut_stob_domain_create_cfg,
                                                   &usm->usm_dom_linux);
                if (rc != 0)
                        M0_LOG(M0_WARN, "rc = %d", rc);
        } else {
                rc = 0;
        }
        m0_mutex_unlock(&usm->usm_lock);
        return rc == 0 ? usm : NULL;
}

M0_INTERNAL int m0_ut_stob_init(void)
{
        struct ut_stob_module *usm;
        int                    rc;

        M0_ALLOC_PTR(usm);
        rc = usm == NULL ? -ENOMEM : 0;
        if (usm != NULL) {
                m0_mutex_init(&usm->usm_lock);
                usm->usm_stob_key = UT_STOB_KEY_BEGIN;
                usm->usm_dom_linux = NULL;
                m0_get()->i_ut_stob_module.usm_private = usm;
        }
        return rc;
}
M0_EXPORTED(m0_ut_stob_init);

M0_INTERNAL void m0_ut_stob_fini(void)
{
        struct ut_stob_module *usm = m0_get()->i_ut_stob_module.usm_private;

        if (usm->usm_dom_linux != NULL) {
                m0_stob_domain_fini(usm->usm_dom_linux);
                usm->usm_dom_linux = NULL;
        }
        m0_mutex_fini(&usm->usm_lock);
        m0_free(usm);
}
M0_EXPORTED(m0_ut_stob_fini);

static struct m0_stob *
ut_stob_linux_create_by_key(uint64_t stob_key, char *stob_create_cfg)
{
        struct ut_stob_module *usm = ut_stob_module_get();
        struct m0_stob        *stob;
        int                    rc;
        struct m0_stob_id      stob_id;

        m0_mutex_lock(&usm->usm_lock);

        m0_stob_id_make(0, stob_key, &usm->usm_dom_linux->sd_id, &stob_id);
        rc = m0_stob_find(&stob_id, &stob);
        M0_ASSERT(rc == 0);
        rc = m0_stob_state_get(stob) == CSS_UNKNOWN ? m0_stob_locate(stob) : 0;
        M0_ASSERT_INFO(rc == 0, "rc = %d", rc);
        rc = m0_stob_state_get(stob) == CSS_NOENT ?
             m0_stob_create(stob, NULL, stob_create_cfg) : 0;
        M0_ASSERT_INFO(rc == 0, "rc = %d", rc);
        M0_ASSERT(m0_stob_state_get(stob) == CSS_EXISTS);

        m0_mutex_unlock(&usm->usm_lock);
        return stob;
}

static uint64_t ut_stob_linux_key_alloc(void)
{
        struct ut_stob_module *usm = ut_stob_module_get();
        uint64_t               stob_key;

        m0_mutex_lock(&usm->usm_lock);
        stob_key = usm->usm_stob_key++;
        m0_mutex_unlock(&usm->usm_lock);
        return stob_key;
}

M0_INTERNAL struct m0_stob *m0_ut_stob_linux_get(void)
{
        return m0_ut_stob_linux_get_by_key(ut_stob_linux_key_alloc());
}

M0_INTERNAL struct m0_stob *m0_ut_stob_linux_get_by_key(uint64_t stob_key)
{
        return ut_stob_linux_create_by_key(stob_key, NULL);
}

M0_INTERNAL struct m0_stob *m0_ut_stob_linux_create(char *stob_create_cfg)
{
        return ut_stob_linux_create_by_key(ut_stob_linux_key_alloc(),
                                           stob_create_cfg);
}

M0_INTERNAL void m0_ut_stob_put(struct m0_stob *stob, bool destroy)
{
        struct ut_stob_module *usm = ut_stob_module_get();

        m0_mutex_lock(&usm->usm_lock);
        m0_ut_stob_close(stob, destroy);
        m0_mutex_unlock(&usm->usm_lock);
}

static bool ut_stob_use_dtx(struct m0_stob_domain *dom)
{
        uint8_t type_id = m0_stob_domain__type_id(m0_stob_domain_id_get(dom));

        return !M0_IN(type_id, (m0_stob_type_id_by_name("nullstob"),
                                m0_stob_type_id_by_name("linuxstob")));
}

M0_INTERNAL int m0_ut_stob_create(struct m0_stob *stob, const char *str_cfg,
                                  struct m0_be_domain *be_dom)
{
        struct m0_be_tx_credit  cred = {};
        struct m0_stob_domain  *dom = m0_stob_dom_get(stob);
        struct m0_dtx          *dtx = NULL;
        bool                    use_dtx;
        int                     rc;

        use_dtx = ut_stob_use_dtx(dom);
        if (use_dtx) {
                m0_stob_create_credit(dom, &cred);
                dtx = m0_ut_dtx_open(&cred, be_dom);
        }
        rc = m0_stob_create(stob, dtx, str_cfg);
        if (use_dtx)
                m0_ut_dtx_close(dtx);
        return rc;
}

M0_INTERNAL int m0_ut_stob_destroy(struct m0_stob      *stob,
                                   struct m0_be_domain *be_dom)
{
        struct m0_be_tx_credit  cred = {};
        struct m0_be_tx_credit  accum;
        struct m0_indexvec      range;
        struct m0_indexvec      got;
        struct m0_dtx          *dtx = NULL;
        bool                    use_dtx;
        int                     rc;
        int                     rc_c;

        use_dtx = ut_stob_use_dtx(m0_stob_dom_get(stob));
        rc = m0_indexvec_alloc(&range, 1);
        M0_ASSERT(rc == 0);
        range.iv_index[0] = 0;
        range.iv_vec.v_count[0] = M0_BINDEX_MAX + 1;
        if (use_dtx) {
                rc = m0_indexvec_alloc(&got, 1);
                M0_ASSERT(rc == 0);
                do {
                        rc = m0_stob_punch_credit(stob, &range, &got, &cred);
                        M0_ASSERT(rc == 0);
                        range.iv_index[0] += got.iv_vec.v_count[0];
                        range.iv_vec.v_count[0] -= got.iv_vec.v_count[0];
                        rc_c = range.iv_vec.v_count[0] == 0 ? 0 : -EAGAIN;
                        dtx = m0_ut_dtx_open(&cred, be_dom);
                        rc = m0_stob_punch(stob, &got, dtx);
                        M0_ASSERT(rc == 0);
                        if (rc_c == 0) {
                                m0_stob_destroy_credit(stob, &accum);
                                m0_be_tx_credit_add(&cred, &accum);
                                rc = m0_stob_destroy(stob, dtx);
                                M0_ASSERT(rc == 0);
                        }
                        m0_ut_dtx_close(dtx);
                } while (rc_c == -EAGAIN);
        }
        else {
                /*
                 * m0_stob_punch() here is temporarily disabled.
                 * This is a quick fix that allows c/motr/+/18984 to land.
                 * On a jenkins node it returns -EFBIG for some reason.
                 */
                /* rc = m0_stob_punch(stob, &range, dtx); */
                /* M0_ASSERT(rc == 0); */
                rc = m0_stob_destroy(stob, dtx);
                M0_ASSERT(rc == 0);
        }
        return rc;
}

M0_INTERNAL struct m0_stob *m0_ut_stob_open(struct m0_stob_domain *dom,
                                            uint64_t stob_key,
                                            const char *str_cfg)
{
        struct m0_stob   *stob;
        int               rc;
        struct m0_stob_id stob_id;

        m0_stob_id_make(0, stob_key, &dom->sd_id, &stob_id);
        rc = m0_stob_find(&stob_id, &stob);
        M0_ASSERT(rc == 0);
        rc = m0_stob_state_get(stob) == CSS_UNKNOWN ? m0_stob_locate(stob) : 0;
        M0_ASSERT_INFO(rc == 0, "rc = %d", rc);
        if (m0_stob_state_get(stob) == CSS_NOENT)
                m0_ut_stob_create(stob, str_cfg, NULL);
        return stob;
}

M0_INTERNAL void m0_ut_stob_close(struct m0_stob *stob, bool destroy)
{
        if (destroy) {
                m0_ut_stob_destroy(stob, NULL);
        } else {
                m0_stob_put(stob);
        }
}

M0_INTERNAL int m0_ut_stob_create_by_stob_id(struct m0_stob_id *stob_id,
                                             const char *str_cfg)
{
        struct m0_stob *stob;
        int             rc;

        rc = m0_stob_find(stob_id, &stob);
        if (rc == 0) {
                rc = m0_stob_state_get(stob) == CSS_UNKNOWN ?
                     m0_stob_locate(stob) : 0;
                rc = rc ?: m0_ut_stob_create(stob, str_cfg, NULL);
                m0_stob_put(stob);
        }
        return rc;
}

M0_INTERNAL int m0_ut_stob_destroy_by_stob_id(struct m0_stob_id *stob_id)
{
        struct m0_stob *stob;
        int             rc;

        rc = m0_stob_find(stob_id, &stob);
        if (rc == 0) {
                rc = m0_stob_state_get(stob) == CSS_UNKNOWN ?
                     m0_stob_locate(stob) : 0;
                rc = rc ?: m0_ut_stob_destroy(stob, NULL);
                if (rc != 0)
                        m0_stob_put(stob);
        }
        return rc;
}

M0_INTERNAL struct m0_dtx *m0_ut_dtx_open(struct m0_be_tx_credit *cred,
                                          struct m0_be_domain    *be_dom)
{
#ifndef __KERNEL__
        struct m0_sm_group *grp;
        struct m0_dtx      *dtx = NULL;
        int                 rc;

        if (be_dom != NULL) {
                struct m0_be_ut_backend *ut_be =
                        bob_of(be_dom, struct m0_be_ut_backend, but_dom,
                               &m0_ut_be_backend_bobtype);
                M0_ALLOC_PTR(dtx);
                M0_ASSERT(dtx != NULL);
                grp = m0_be_ut_backend_sm_group_lookup(ut_be);
                m0_dtx_init(dtx, be_dom, grp);
                m0_dtx_prep(dtx, cred);
                rc = m0_dtx_open_sync(dtx);
                M0_ASSERT_INFO(rc == 0, "rc = %d", rc);
        }
        return dtx;
#else
        return NULL;
#endif
}

M0_INTERNAL void m0_ut_dtx_close(struct m0_dtx *dtx)
{
        int rc;

        if (dtx != NULL) {
                rc = m0_dtx_done_sync(dtx);
                M0_ASSERT_INFO(rc == 0, "rc = %d", rc);
                m0_dtx_fini(dtx);
                m0_free(dtx);
        }
}

#undef M0_TRACE_SUBSYSTEM

/*
 *  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
 */