idx.c

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 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.
 *
 */

#include "motr/client.h"
#include "motr/client_internal.h"
#include "motr/addb.h"
#include "motr/idx.h"
#include "motr/sync.h"
#include "dtm0/dtx.h" /* m0_dtm0_dtx_* API */
#include "dtm0/service.h" /* m0_dtm0_service_find */

#include "lib/errno.h"
#include "lib/finject.h"

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

static struct m0_idx_service
idx_services[M0_IDX_MAX_SERVICE_ID];

static void idx_op_cb_launch(struct m0_op_common *oc);
static void idx_op_cb_fini(struct m0_op_common *oc);
static void idx_op_cb_free(struct m0_op_common *oc);
static void idx_op_cb_cancel(struct m0_op_common *oc);

const struct m0_bob_type oi_bobtype;
M0_BOB_DEFINE(M0_INTERNAL, &oi_bobtype,  m0_op_idx);
const struct m0_bob_type oi_bobtype = {
        .bt_name         = "oi_bobtype",
        .bt_magix_offset = offsetof(struct m0_op_idx, oi_magic),
        .bt_magix        = M0_OI_MAGIC,
        .bt_check        = NULL,
};

static struct m0_client *
oi_instance(struct m0_op_idx *oi)
{
        M0_PRE(oi != NULL);

        return m0__entity_instance(oi->oi_oc.oc_op.op_entity);
}

M0_INTERNAL bool m0__idx_op_invariant(struct m0_op_idx *oi)
{
        struct m0_op *op;

        if (oi != NULL)
                op = &oi->oi_oc.oc_op;

        return _0C(oi != NULL) &&
               _0C(M0_IN(op->op_code, (M0_EO_CREATE,
                                       M0_EO_DELETE,
                                       M0_IC_GET,
                                       M0_IC_PUT,
                                       M0_IC_DEL,
                                       M0_IC_NEXT,
                                       M0_IC_LOOKUP,
                                       M0_IC_LIST))) &&
              _0C(m0_op_idx_bob_check(oi)) &&
              _0C(oi->oi_oc.oc_op.op_size >= sizeof *oi &&
                  m0_ast_rc_bob_check(&oi->oi_ar) &&
                  m0_op_common_bob_check(&oi->oi_oc));
}

M0_INTERNAL struct m0_idx*
m0__idx_entity(struct m0_entity *entity)
{
        struct m0_idx *idx;

        M0_PRE(entity != NULL);

        return M0_AMB(idx, entity, in_entity);
}

M0_INTERNAL int
m0__idx_pool_version_get(struct m0_idx *idx,
                         struct m0_pool_version **pv)
{
        int               rc;
        struct m0_client *cinst;

        M0_ENTRY();

        if (pv == NULL)
                return M0_ERR(-EINVAL);

        cinst = m0__idx_instance(idx);

        rc = m0_dix_pool_version_get(&cinst->m0c_pools_common, pv);
        if (rc != 0)
                return M0_ERR(rc);
        return M0_RC(0);
}

static int idx_pool_version_get(struct m0_op_idx *oi)
{
        int                     rc;
        struct m0_pool_version *pv;
        struct m0_idx          *idx;

        M0_ENTRY();
        M0_PRE(oi != NULL);

        M0_PRE(M0_IN(OP_IDX2CODE(oi), (M0_EO_CREATE)));

        idx = m0__idx_entity(oi->oi_oc.oc_op.op_entity);

        rc = m0__idx_pool_version_get(idx, &pv);
        if (rc != 0)
                return M0_ERR(rc);
        idx->in_attr.idx_pver = pv->pv_id;

        return M0_RC(0);
}

static int idx_op_init(struct m0_idx *idx, int opcode,
                       struct m0_bufvec *keys, struct m0_bufvec *vals,
                       int32_t *rcs, uint32_t flags,
                       struct m0_op *op)
{
        int                  rc;
        struct m0_op_common *oc;
        struct m0_op_idx    *oi;
        struct m0_entity    *entity;
        struct m0_locality  *locality;
        struct m0_client    *m0c;
        uint64_t             cid;
        uint64_t             did;

        M0_ENTRY();

        M0_PRE(idx != NULL);
        M0_PRE(op != NULL);

        /* Initialise the operation's generic part. */
        entity = &idx->in_entity;
        m0c = entity->en_realm->re_instance;
        op->op_code = opcode;
        rc = m0_op_init(op, &m0_op_conf, entity);
        if (rc != 0)
                return M0_ERR(rc);
        /*
         * Init m0_op_common part.
         * bob_init()'s haven't been called yet: we use M0_AMB().
         */
        oc = M0_AMB(oc, op, oc_op);
        m0_op_common_bob_init(oc);
        oc->oc_cb_launch = idx_op_cb_launch;
        oc->oc_cb_fini   = idx_op_cb_fini;
        oc->oc_cb_free   = idx_op_cb_free;
        oc->oc_cb_cancel = idx_op_cb_cancel;

        /* Init the m0_op_idx part. */
        oi = M0_AMB(oi, oc, oi_oc);
        oi->oi_idx  = idx;
        oi->oi_keys = keys;
        oi->oi_vals = vals;
        oi->oi_rcs  = rcs;
        oi->oi_flags = flags;

        locality = m0__locality_pick(oi_instance(oi));
        M0_ASSERT(locality != NULL);
        oi->oi_sm_grp = locality->lo_grp;
        M0_SET0(&oi->oi_ar);

        m0_op_idx_bob_init(oi);
        m0_ast_rc_bob_init(&oi->oi_ar);

        if (ENABLE_DTM0 && !(flags & M0_OIF_NO_DTM) &&
            M0_IN(op->op_code, (M0_IC_PUT, M0_IC_DEL))) {
                M0_ASSERT(m0c->m0c_dtms != NULL);
                oi->oi_dtx = m0_dtx0_alloc(m0c->m0c_dtms, oi->oi_sm_grp);
                if (oi->oi_dtx == NULL)
                        return M0_ERR(-ENOMEM);
                did = m0_sm_id_get(&oi->oi_dtx->tx_dtx->dd_sm);
                cid = m0_sm_id_get(&op->op_sm);
                M0_ADDB2_ADD(M0_AVI_CLIENT_TO_DIX, cid, did);
        } else
                oi->oi_dtx = NULL;

        if (opcode == M0_EO_CREATE && entity->en_type == M0_ET_IDX &&
            entity->en_flags & M0_ENF_META) {
                rc = idx_pool_version_get(oi);
                if (rc != 0)
                        return M0_ERR(rc);
                idx->in_attr.idx_layout_type = DIX_LTYPE_DESCR;
                M0_LOG(M0_DEBUG, "DIX pool version at index create: "FID_F"",
                       FID_P(&idx->in_attr.idx_pver));
        }

        return M0_RC(0);
}

static struct m0_op_idx *ar_ast2oi(struct m0_sm_ast *ast)
{
        struct m0_ast_rc *ar;
        ar = bob_of(ast,  struct m0_ast_rc, ar_ast, &ar_bobtype);
        return bob_of(ar, struct m0_op_idx, oi_ar, &oi_bobtype);
}

static void idx_op_complete_state_set(struct m0_sm_group *grp,
                                      struct m0_sm_ast   *ast,
                                      uint64_t            mask)
{
        struct m0_op_idx    *oi = ar_ast2oi(ast);
        struct m0_op        *op = &oi->oi_oc.oc_op;
        struct m0_sm_group  *op_grp = &op->op_sm_group;
        struct m0_sm_group  *en_grp = &op->op_entity->en_sm_group;

        M0_ENTRY("oi=%p, mask=%" PRIu64, oi, mask);

        M0_PRE(grp != NULL);
        M0_PRE(m0_sm_group_is_locked(grp));
        M0_PRE((mask & ~M0_BITS(M0_OS_EXECUTED, M0_OS_STABLE)) == 0);

        oi->oi_in_completion = true;

        if (M0_IN(op->op_code, (M0_EO_CREATE, M0_EO_DELETE))) {
                m0_sm_group_lock(en_grp);
                if (op->op_code == M0_EO_CREATE)
                        m0_sm_move(&op->op_entity->en_sm, 0, M0_ES_OPEN);
                else if (op->op_code == M0_EO_DELETE)
                        m0_sm_move(&op->op_entity->en_sm, 0, M0_ES_INIT);
                m0_sm_group_unlock(en_grp);
        }

        m0_sm_group_lock(op_grp);
        if ((mask & M0_BITS(M0_OS_EXECUTED)) != 0) {
                m0_sm_move(&op->op_sm, 0, M0_OS_EXECUTED);
                m0_op_executed(op);
        }
        if ((mask & M0_BITS(M0_OS_STABLE)) != 0) {
                m0_sm_move(&op->op_sm, 0, M0_OS_STABLE);
                m0_op_stable(op);
                if (oi->oi_dtx != NULL) {
                        m0_dtx0_done(oi->oi_dtx);
                        oi->oi_dtx = NULL;
                }
        }
        m0_sm_group_unlock(op_grp);

        M0_LEAVE();
}

M0_INTERNAL void idx_op_ast_stable(struct m0_sm_group *grp,
                                   struct m0_sm_ast *ast)
{
        idx_op_complete_state_set(grp, ast, M0_BITS(M0_OS_STABLE));
}

M0_INTERNAL void idx_op_ast_executed(struct m0_sm_group *grp,
                                     struct m0_sm_ast *ast)
{
        idx_op_complete_state_set(grp, ast, M0_BITS(M0_OS_EXECUTED));
}

M0_INTERNAL void idx_op_ast_complete(struct m0_sm_group *grp,
                                     struct m0_sm_ast *ast)
{
        idx_op_complete_state_set(grp, ast,
                                  M0_BITS(M0_OS_EXECUTED, M0_OS_STABLE));
}

static void idx_op_fail(struct m0_op_idx *oi, int rc)
{
        struct m0_op        *op;
        struct m0_sm_group  *op_grp;
        struct m0_sm_group  *en_grp;

        M0_ENTRY();

        M0_PRE(oi != NULL);

        op = &oi->oi_oc.oc_op;

        op_grp = &op->op_sm_group;
        en_grp = &op->op_entity->en_sm_group;

        oi->oi_in_completion = true;
        m0_sm_group_lock(en_grp);

        if (op->op_code == M0_EO_CREATE)
                m0_sm_move(&op->op_entity->en_sm, 0, M0_ES_OPEN);
        else if (op->op_code == M0_EO_DELETE)
                m0_sm_move(&op->op_entity->en_sm, 0, M0_ES_INIT);

        m0_sm_group_unlock(en_grp);

        m0_sm_group_lock(op_grp);
        op->op_rc = rc;
        m0_sm_move(&op->op_sm, 0, M0_OS_EXECUTED);
        m0_op_executed(op);
        m0_sm_move(&op->op_sm, 0, M0_OS_STABLE);
        m0_op_stable(op);
        m0_sm_group_unlock(op_grp);

        M0_LEAVE();
}

M0_INTERNAL void idx_op_ast_fail(struct m0_sm_group *grp,
                                 struct m0_sm_ast *ast)
{
        struct m0_op_idx *oi;
        struct m0_ast_rc *ar;

        M0_ENTRY();

        M0_PRE(grp != NULL);
        M0_PRE(m0_sm_group_is_locked(grp));
        M0_PRE(ast != NULL);

        ar = bob_of(ast, struct m0_ast_rc, ar_ast, &ar_bobtype);
        oi = bob_of(ar, struct m0_op_idx, oi_ar, &oi_bobtype);
        idx_op_fail(oi, ar->ar_rc);

        M0_LEAVE();
}

static void idx_op_cb_fini(struct m0_op_common *oc)
{
        struct m0_op_idx *oi;

        M0_ENTRY();

        M0_PRE(oc != NULL);
        M0_PRE(oc->oc_op.op_size >= sizeof *oi);

        oi = bob_of(oc, struct m0_op_idx, oi_oc, &oi_bobtype);
        M0_PRE(m0__idx_op_invariant(oi));

        m0_op_common_bob_fini(&oi->oi_oc);
        m0_ast_rc_bob_fini(&oi->oi_ar);
        m0_op_idx_bob_fini(oi);

        M0_LEAVE();
}

static void idx_op_cb_free(struct m0_op_common *oc)
{
        struct m0_op_idx *oi;

        M0_ENTRY();

        M0_PRE(oc != NULL);
        M0_PRE((oc->oc_op.op_size >= sizeof *oi));

        /* By now, fini() has been called and bob_of cannot be used */
        oi = M0_AMB(oi, oc, oi_oc);
        m0_free(oi);

        M0_LEAVE();
}

static void idx_op_cb_cancel(struct m0_op_common *oc)
{
        struct m0_op      *op;
        struct m0_op_idx  *oi;
        struct m0_client  *m0c;
        struct m0_config  *conf;

        M0_ENTRY();

        M0_PRE(oc != NULL);
        op = &oc->oc_op;
        M0_PRE(op->op_entity != NULL);
        M0_PRE(m0_sm_group_is_locked(&op->op_sm_group));

        oi = bob_of(oc, struct m0_op_idx, oi_oc, &oi_bobtype);
        M0_PRE(m0__idx_op_invariant(oi));

        m0c = oi_instance(oi);
        conf = m0c->m0c_config;

        M0_LOG(M0_DEBUG, "op->op_code:%d", op->op_code);

        if (!oi->oi_in_completion && conf->mc_idx_service_id == M0_IDX_DIX)
                op->op_rc = m0__idx_cancel(oi);
        else
                op->op_rc = 0;

        M0_LEAVE();
}

static void idx_op_cb_launch(struct m0_op_common *oc)
{
        int                      rc;
        struct m0_client        *m0c;
        struct m0_op            *op;
        struct m0_op_idx        *oi;
        struct m0_idx_query_ops *query_ops;

        int (*query) (struct m0_op_idx *);

        M0_ENTRY();

        M0_PRE(oc != NULL);
        op = &oc->oc_op;
        oi = bob_of(oc, struct m0_op_idx, oi_oc, &oi_bobtype);

        m0c = oi_instance(oi);
        query_ops = m0c->m0c_idx_svc_ctx.isc_service->is_query_ops;
        M0_ASSERT(query_ops != NULL);

        /* No harm to set the operation state here. */
        m0_sm_move(&op->op_sm, 0, M0_OS_LAUNCHED);

        /* Move to a different state and call the control function. */
        m0_sm_group_lock(&op->op_entity->en_sm_group);

        if (oi->oi_dtx)
                m0_dtx0_prepare(oi->oi_dtx);

        switch (op->op_code) {
        case M0_EO_CREATE:
                m0_sm_move(&op->op_entity->en_sm, 0,
                           M0_ES_CREATING);
                query = query_ops->iqo_namei_create;
                break;
        case M0_EO_DELETE:
                m0_sm_move(&op->op_entity->en_sm, 0,
                           M0_ES_DELETING);
                query = query_ops->iqo_namei_delete;
                break;
        case M0_IC_GET:
                query = query_ops->iqo_get;
                break;
        case M0_IC_PUT:
                query = query_ops->iqo_put;
                break;
        case M0_IC_DEL:
                query = query_ops->iqo_del;
                break;
        case M0_IC_NEXT:
                query = query_ops->iqo_next;
                break;
        case M0_IC_LOOKUP:
                query = query_ops->iqo_namei_lookup;
                break;
        case M0_IC_LIST:
                query = query_ops->iqo_namei_list;
                break;
        default:
                M0_IMPOSSIBLE("Management operation not implemented");
        }
        M0_ASSERT(query != NULL);

        m0_sm_group_unlock(&op->op_entity->en_sm_group);
        /*
         * Returned value of query operations:
         *  = 0: the query is executed synchronously and returns successfully.
         *  < 0: the query fails.
         *  = 1: the driver successes in launching the query asynchronously.
        */
        rc = query(oi);
        oi->oi_ar.ar_rc = rc;
        if (rc < 0) {
                oi->oi_ar.ar_ast.sa_cb = &idx_op_ast_fail;
                m0_sm_ast_post(oi->oi_sm_grp, &oi->oi_ar.ar_ast);
        } else if (rc == 0) {
                oi->oi_ar.ar_ast.sa_cb = &idx_op_ast_complete;
                m0_sm_ast_post(oi->oi_sm_grp, &oi->oi_ar.ar_ast);
        }

        M0_LEAVE();
}

int m0_idx_op(struct m0_idx       *idx,
              enum m0_idx_opcode   opcode,
              struct m0_bufvec    *keys,
              struct m0_bufvec    *vals,
              int32_t             *rcs,
              uint32_t             flags,
              struct m0_op       **op)
{
        int rc;

        M0_ENTRY();

        M0_PRE(idx != NULL);
        M0_PRE(M0_IN(opcode, (M0_IC_LOOKUP, M0_IC_LIST,
                              M0_IC_GET, M0_IC_PUT,
                              M0_IC_DEL, M0_IC_NEXT)));
        M0_PRE(M0_IN(opcode, (M0_IC_DEL,
                              M0_IC_LOOKUP,
                              M0_IC_LIST)) == (vals == NULL));
        M0_PRE(ergo(opcode != M0_IC_LOOKUP, keys != NULL));
        M0_PRE(ergo(vals != NULL,
                    keys->ov_vec.v_nr == vals->ov_vec.v_nr));
        M0_PRE(ergo(opcode == M0_IC_LIST,
                    m0_forall(i, keys->ov_vec.v_nr,
                              keys->ov_vec.v_count[i] ==
                              sizeof(struct m0_uint128))));
        M0_PRE(op != NULL);
        M0_PRE(ergo(flags == M0_OIF_SYNC_WAIT,
                    M0_IN(opcode, (M0_IC_PUT, M0_IC_DEL))));

        rc = m0_op_get(op, sizeof(struct m0_op_idx));
        if (rc == 0) {
                M0_ASSERT(*op != NULL);
                rc = idx_op_init(idx, opcode, keys, vals, rcs, flags,
                                        *op);
        }

        return M0_RC(rc);
}
M0_EXPORTED(m0_idx_op);

M0_INTERNAL int m0_idx_op_namei(struct m0_entity *entity,
                                struct m0_op **op,
                                enum m0_entity_opcode opcode)
{
        int                   rc;
        struct m0_idx        *idx;

        M0_ENTRY();

        M0_PRE(entity != NULL);
        M0_PRE(op != NULL);

        rc = m0_op_get(op, sizeof(struct m0_op_idx));
        if (rc == 0) {
                M0_ASSERT(*op != NULL);
                idx = M0_AMB(idx, entity, in_entity);
                rc = idx_op_init(idx, opcode, NULL, NULL, NULL, 0,
                                        *op);
        }

        return M0_RC(rc);
}

void m0_idx_init(struct m0_idx    *idx,
                 struct m0_realm  *parent,
                 const struct m0_uint128 *id)
{
        M0_ENTRY();

        M0_PRE(idx != NULL);
        M0_PRE(parent != NULL);
        M0_PRE(id != NULL);

        /* Initialise the entity */
        m0_entity_init(&idx->in_entity, parent, id, M0_ET_IDX);

        M0_LEAVE();
}
M0_EXPORTED(m0_idx_init);

void m0_idx_fini(struct m0_idx *idx)
{
        M0_ENTRY();

        M0_PRE(idx != NULL);
        m0_entity_fini(&idx->in_entity);

        M0_LEAVE();
}
M0_EXPORTED(m0_idx_fini);

M0_INTERNAL void m0_idx_service_config(struct m0_client *m0c,
                                       int svc_id, void *svc_conf)
{
        struct m0_idx_service     *service;
        struct m0_idx_service_ctx *ctx;

        M0_PRE(m0c != NULL);
        M0_PRE(svc_id >= 0 && svc_id < M0_IDX_MAX_SERVICE_ID);

        service = &idx_services[svc_id];
        ctx = &m0c->m0c_idx_svc_ctx;
        ctx->isc_service  = service;
        ctx->isc_svc_conf = svc_conf;
        ctx->isc_svc_inst = NULL;
}

M0_INTERNAL void m0_idx_service_register(int svc_id,
                                         struct m0_idx_service_ops *sops,
                                         struct m0_idx_query_ops   *qops)
{
        struct m0_idx_service *service;

        M0_PRE(svc_id >= 0 && svc_id < M0_IDX_MAX_SERVICE_ID);

        service = &idx_services[svc_id];
        service->is_svc_ops = sops;
        service->is_query_ops = qops;
}

M0_INTERNAL void m0_idx_services_register(void)
{
        m0_idx_mock_register();
#ifdef MOTR_IDX_STORE_CASS
        m0_idx_cass_register();
#endif
        m0_idx_dix_register();
}

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