obj_ops.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_CONF_OBJOPS_H__
#define __MOTR_CONF_OBJOPS_H__

#include "conf/obj.h"

struct m0_conf_cache;
struct m0_confx_obj;
struct m0_fid_arr;


enum m0_conf_dirval {
        M0_CONF_DIREND = 0,
        M0_CONF_DIRNEXT,
        M0_CONF_DIRMISS
};

struct m0_conf_obj_ops {
        bool (*coo_invariant)(const struct m0_conf_obj *obj);

        int (*coo_decode)(struct m0_conf_obj *dest,
                          const struct m0_confx_obj *src);

        int (*coo_encode)(struct m0_confx_obj *dest,
                          const struct m0_conf_obj *src);

        bool (*coo_match)(const struct m0_conf_obj *cached,
                          const struct m0_confx_obj *flat);

        int (*coo_lookup)(const struct m0_conf_obj *parent,
                          const struct m0_fid *name, struct m0_conf_obj **out);

        int (*coo_readdir)(const struct m0_conf_obj *dir,
                           struct m0_conf_obj **pptr);

        const struct m0_fid **(*coo_downlinks)(const struct m0_conf_obj *obj);

        void (*coo_delete)(struct m0_conf_obj *obj);
};

M0_INTERNAL struct m0_conf_obj *m0_conf_obj_create(const struct m0_fid *id,
                                                   struct m0_conf_cache *cache);

M0_INTERNAL int m0_conf_obj_find(struct m0_conf_cache *cache,
                                 const struct m0_fid *id,
                                 struct m0_conf_obj **out);

M0_INTERNAL int m0_conf_obj_find_lock(struct m0_conf_cache *cache,
                                      const struct m0_fid *id,
                                      struct m0_conf_obj **out);
M0_INTERNAL void m0_conf_obj_delete(struct m0_conf_obj *obj);

M0_INTERNAL bool m0_conf_obj_invariant(const struct m0_conf_obj *obj);

M0_INTERNAL void m0_conf_obj_get(struct m0_conf_obj *obj);

M0_INTERNAL void m0_conf_obj_get_lock(struct m0_conf_obj *obj);
M0_INTERNAL void m0_conf_obj_put(struct m0_conf_obj *obj);

M0_INTERNAL int m0_conf_obj_fill(struct m0_conf_obj *dest,
                                 const struct m0_confx_obj *src);

M0_INTERNAL bool m0_conf_obj_match(const struct m0_conf_obj *cached,
                                   const struct m0_confx_obj *flat);

#endif /* __MOTR_CONF_OBJOPS_H__ */