idx.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-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_IDX_H__
#define __MOTR_IDX_H__

#include "motr/client.h" /* m0_entity_opcode */
#include "dix/layout.h"    /* m0_dix_ldesc */

struct m0_op_idx;

enum m0_idx_service_type {
        M0_IDX_MOCK,
        M0_IDX_DIX,
        M0_IDX_CASS,
        M0_IDX_MAX_SERVICE_ID
};

enum m0_op_idx_flags {
        M0_OIF_OVERWRITE         = 1 << 0,
        M0_OIF_EXCLUDE_START_KEY = 1 << 1,
        M0_OIF_SYNC_WAIT = 1 << 2,
        M0_OIF_SKIP_LAYOUT = 1 << 3,
        M0_OIF_CROW = 1 << 4
};

struct m0_idx_query_ops {
        /* Index operations. */
        int  (*iqo_namei_create)(struct m0_op_idx *oi);
        int  (*iqo_namei_delete)(struct m0_op_idx *oi);
        int  (*iqo_namei_lookup)(struct m0_op_idx *oi);
        int  (*iqo_namei_list)(struct m0_op_idx *oi);

        /* Query operations. */
        int  (*iqo_get)(struct m0_op_idx *oi);
        int  (*iqo_put)(struct m0_op_idx *oi);
        int  (*iqo_del)(struct m0_op_idx *oi);
        int  (*iqo_next)(struct m0_op_idx *oi);
};

struct m0_idx_service_ops {
        int (*iso_init) (void *svc);
        int (*iso_fini) (void *svc);
};

struct m0_idx_service {
        struct m0_idx_service_ops *is_svc_ops;
        struct m0_idx_query_ops   *is_query_ops;
};

struct m0_idx_service_ctx {
        struct m0_idx_service *isc_service;

        void                         *isc_svc_conf;
        void                         *isc_svc_inst;
};

/* Configurations for Cassandra cluster. */
struct m0_idx_cass_config {
        char *cc_cluster_ep;   /* Contact point for a Cassandra cluster. */
        char *cc_keyspace;
        int   cc_max_column_family_num;
};

struct m0_idx_dix_config {
        bool                kc_create_meta;

        struct m0_dix_ldesc kc_layout_ldesc;

        struct m0_dix_ldesc kc_ldescr_ldesc;

};

/* BOB types */
extern const struct m0_bob_type oi_bobtype;
M0_BOB_DECLARE(M0_INTERNAL, m0_op_idx);

M0_INTERNAL bool m0__idx_op_invariant(struct m0_op_idx *oi);
M0_INTERNAL void idx_op_ast_complete(struct m0_sm_group *grp,
                                     struct m0_sm_ast   *ast);
M0_INTERNAL void idx_op_ast_executed(struct m0_sm_group *grp,
                                     struct m0_sm_ast   *ast);
M0_INTERNAL void idx_op_ast_stable(struct m0_sm_group *grp,
                                   struct m0_sm_ast   *ast);
M0_INTERNAL void idx_op_ast_fail(struct m0_sm_group *grp,
                                 struct m0_sm_ast *ast);


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

M0_INTERNAL void m0_idx_service_config(struct m0_client *m0c,
                                       int svc_id, void *svc_conf);
M0_INTERNAL void m0_idx_service_register(int svc_id,
                                         struct m0_idx_service_ops *sops,
                                         struct m0_idx_query_ops   *qops);
M0_INTERNAL void m0_idx_services_register(void);

M0_INTERNAL void m0_idx_mock_register(void);

#ifdef MOTR_IDX_STORE_CASS
M0_INTERNAL void m0_idx_cass_register(void);
#endif

M0_INTERNAL void m0_idx_dix_register(void);

#endif /* __MOTR_IDX_H__ */

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