type.h

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


#pragma once

#ifndef __MOTR_STOB_TYPE_H__
#define __MOTR_STOB_TYPE_H__

#include "lib/tlist.h"  /* m0_tl */
#include "lib/types.h"  /* uint64_t */
#include "lib/mutex.h"  /* m0_mutex */

#include "fid/fid.h"    /* m0_fid_type */

struct m0_stob_domain;
struct m0_stob_type_ops;

struct m0_stob_types {
        struct m0_tl sts_stypes;
};

M0_INTERNAL int m0_stob_types_init(void);
M0_INTERNAL void m0_stob_types_fini(void);

struct m0_stob_type {
        const struct m0_stob_type_ops *st_ops;
        struct m0_fid_type             st_fidt;
        struct m0_tl                   st_domains;
        struct m0_mutex                st_domains_lock;
        struct m0_tlink                st_type_linkage;
        uint64_t                       st_magic;
        void                          *st_private;
};

struct m0_stob_type_ops {
        void (*sto_register)(struct m0_stob_type *type);
        void (*sto_deregister)(struct m0_stob_type *type);
        int (*sto_domain_cfg_init_parse)(const char *str_cfg_init,
                                         void **cfg_init);
        void (*sto_domain_cfg_init_free)(void *cfg_init);
        int (*sto_domain_cfg_create_parse)(const char *str_cfg_create,
                                           void **cfg_create);
        void (*sto_domain_cfg_create_free)(void *cfg_create);
        int (*sto_domain_init)(struct m0_stob_type *type,
                               const char *location_data,
                               void *cfg_init,
                               struct m0_stob_domain **out);
        int (*sto_domain_create)(struct m0_stob_type *type,
                                 const char *location_data,
                                 uint64_t dom_key,
                                 void *cfg_create);
        int (*sto_domain_destroy)(struct m0_stob_type *type,
                                  const char *location_data);
};

M0_INTERNAL void m0_stob_type_register(struct m0_stob_type *type);
M0_INTERNAL void m0_stob_type_deregister(struct m0_stob_type *type);

M0_INTERNAL struct m0_stob_type *
m0_stob_type_by_dom_id(const struct m0_fid *id);
M0_INTERNAL struct m0_stob_type *m0_stob_type_by_name(const char *name);
M0_INTERNAL uint8_t m0_stob_type_id_by_name(const char *name);

M0_INTERNAL uint8_t m0_stob_type_id_get(const struct m0_stob_type *type);
M0_INTERNAL const char *m0_stob_type_name_get(struct m0_stob_type *type);

M0_INTERNAL void m0_stob_type__dom_add(struct m0_stob_type *type,
                                       struct m0_stob_domain *dom);
M0_INTERNAL void m0_stob_type__dom_del(struct m0_stob_type *type,
                                       struct m0_stob_domain *dom);
M0_INTERNAL struct m0_stob_domain *
m0_stob_type__dom_find(struct m0_stob_type *type, const struct m0_fid *dom_id);

M0_INTERNAL struct m0_stob_domain *
m0_stob_type__dom_find_by_location(struct m0_stob_type *type,
                                   const char *location);

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