domain.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_DOMAIN_H__
#define __MOTR_STOB_DOMAIN_H__

#include "lib/types.h"          /* uint64_t */
#include "lib/tlist.h"          /* m0_tlink */
#include "fid/fid.h"            /* m0_fid */

#include "stob/cache.h"         /* m0_stob_cache */

struct m0_stob_type;
struct m0_stob_domain_ops;
struct m0_stob;
struct m0_stob_id;
struct m0_stob_io;
struct m0_be_tx_credit;
struct m0_fid;
struct m0_dtx;
struct m0_indexvec;

struct m0_stob_domain {
        const struct m0_stob_domain_ops *sd_ops;
        struct m0_stob_type             *sd_type;
        struct m0_fid                    sd_id;
        char                            *sd_location;
        char                            *sd_location_data;
        struct m0_tlink                  sd_domain_linkage;
        uint64_t                         sd_magic;
        struct m0_stob_cache             sd_cache;
        void                            *sd_private;
};

struct m0_stob_domain_ops {
        void (*sdo_fini)(struct m0_stob_domain *dom);
        struct m0_stob *(*sdo_stob_alloc)(struct m0_stob_domain *dom,
                                          const struct m0_fid *stob_fid);
        void (*sdo_stob_free)(struct m0_stob_domain *dom,
                              struct m0_stob *stob);
        int (*sdo_stob_cfg_parse)(const char *str_cfg_create,
                                  void **cfg_create);
        void (*sdo_stob_cfg_free)(void *cfg_create);
        int (*sdo_stob_init)(struct m0_stob *stob,
                             struct m0_stob_domain *dom,
                             const struct m0_fid *stob_fid);
        void (*sdo_stob_create_credit)(struct m0_stob_domain *dom,
                                       struct m0_be_tx_credit *accum);
        int (*sdo_stob_create)(struct m0_stob *stob,
                               struct m0_stob_domain *dom,
                               struct m0_dtx *dtx,
                               const struct m0_fid *stob_fid,
                               void *cfg);
        void (*sdo_stob_write_credit)(const struct m0_stob_domain *dom,
                                      const struct m0_stob_io *io,
                                      struct m0_be_tx_credit *accum);
};

M0_INTERNAL int m0_stob_domain_init(const char *location,
                                    const char *str_cfg_init,
                                    struct m0_stob_domain **out);
M0_INTERNAL void m0_stob_domain_fini(struct m0_stob_domain *dom);
M0_INTERNAL bool m0_stob_domain__invariant(struct m0_stob_domain *dom);


M0_INTERNAL int m0_stob_domain_create(const char *location,
                                      const char *str_cfg_init,
                                      uint64_t dom_key,
                                      const char *str_cfg_create,
                                      struct m0_stob_domain **out);
M0_INTERNAL int m0_stob_domain_destroy(struct m0_stob_domain *dom);

M0_INTERNAL int m0_stob_domain_destroy_location(const char *location);

M0_INTERNAL int m0_stob_domain_create_or_init(const char *location,
                                              const char *str_cfg_init,
                                              uint64_t dom_key,
                                              const char *str_cfg_create,
                                              struct m0_stob_domain **out);
M0_INTERNAL struct m0_stob_domain *
m0_stob_domain_find(const struct m0_fid *dom_id);
M0_INTERNAL struct m0_stob_domain *
m0_stob_domain_find_by_location(const char *location);
M0_INTERNAL struct m0_stob_domain *
m0_stob_domain_find_by_stob_id(const struct m0_stob_id *stob_id);

M0_INTERNAL const struct m0_fid *
m0_stob_domain_id_get(const struct m0_stob_domain *dom);
M0_INTERNAL const char *
m0_stob_domain_location_get(const struct m0_stob_domain *dom);
M0_INTERNAL bool m0_stob_domain_is_of_type(const struct m0_stob_domain *dom,
                                           const struct m0_stob_type *dt);
M0_INTERNAL void m0_stob_domain__id_set(struct m0_stob_domain *dom,
                                         struct m0_fid *dom_id);
M0_INTERNAL void m0_stob_domain__dom_id_make(struct m0_fid *dom_id,
                                             uint8_t type_id,
                                             uint64_t dom_container,
                                             uint64_t dom_key);

M0_INTERNAL uint8_t m0_stob_domain__type_id(const struct m0_fid *dom_id);
M0_INTERNAL uint64_t m0_stob_domain__dom_key(const struct m0_fid *dom_id);

M0_INTERNAL bool m0_stob_domain__dom_key_is_valid(uint64_t dom_key);

M0_INTERNAL struct m0_stob_cache *
m0_stob_domain__cache(struct m0_stob_domain *dom);

M0_INTERNAL struct m0_stob *
m0_stob_domain__stob_alloc(struct m0_stob_domain *dom,
                           const struct m0_fid *stob_fid);
M0_INTERNAL void m0_stob_domain__stob_free(struct m0_stob_domain *dom,
                                           struct m0_stob *stob);
#endif /* __MOTR_STOB_DOMAIN_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
 */