cache.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2015-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_CACHE_H__
#define __MOTR_CONF_CACHE_H__

#include "conf/obj.h"
#include "lib/tlist.h"  /* M0_TL_DESCR_DECLARE */

struct m0_mutex;

M0_TL_DESCR_DECLARE(m0_conf_cache, extern);
M0_TL_DECLARE(m0_conf_cache, M0_INTERNAL, struct m0_conf_obj);


enum m0_conf_version {
        M0_CONF_VER_UNKNOWN = 0,
        M0_CONF_VER_TEMP = ~0,
};

struct m0_conf_cache {
        struct m0_tl     ca_registry;

        struct m0_mutex *ca_lock;

        uint64_t         ca_ver;

        uint64_t         ca_fid_counter;
};

M0_INTERNAL void m0_conf_cache_init(struct m0_conf_cache *cache,
                                    struct m0_mutex *lock);

M0_INTERNAL void m0_conf_cache_fini(struct m0_conf_cache *cache);

M0_INTERNAL void m0_conf_cache_lock(struct m0_conf_cache *cache);
M0_INTERNAL void m0_conf_cache_unlock(struct m0_conf_cache *cache);
M0_INTERNAL bool m0_conf_cache_is_locked(const struct m0_conf_cache *cache);

M0_INTERNAL void m0_conf_cache_clean(struct m0_conf_cache *cache,
                                     const struct m0_conf_obj_type *type);

M0_INTERNAL void m0_conf_cache_gc(struct m0_conf_cache *cache);

M0_INTERNAL int m0_conf_cache_add(struct m0_conf_cache *cache,
                                  struct m0_conf_obj *obj);

M0_INTERNAL void m0_conf_cache_del(const struct m0_conf_cache *cache,
                                   struct m0_conf_obj *obj);

M0_INTERNAL bool m0_conf_cache_contains(struct m0_conf_cache *cache,
                                        const struct m0_fid *fid);
M0_INTERNAL struct m0_conf_obj *
m0_conf_cache_lookup(const struct m0_conf_cache *cache,
                     const struct m0_fid *id);

M0_INTERNAL int m0_conf_cache_to_string(struct m0_conf_cache *cache, char **str,
                                        bool debug);

M0_INTERNAL int m0_conf_cache_from_string(struct m0_conf_cache *cache,
                                          const char           *str);

M0_INTERNAL int m0_conf_version(struct m0_conf_cache *cache);

M0_INTERNAL struct m0_conf_obj *
m0_conf_cache_pinned(const struct m0_conf_cache *cache);

enum { M0_CONF_PATH_MAX = 15 };

#endif /* __MOTR_CONF_CACHE_H__ */