cookie.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_LIB_COOKIE_H__
#define __MOTR_LIB_COOKIE_H__

#include "lib/types.h"
#include "xcode/xcode.h"

struct m0_cookie {
        uint64_t co_addr;
        uint64_t co_generation;
} M0_XCA_RECORD M0_XCA_DOMAIN(be|rpc);

M0_INTERNAL int m0_cookie_global_init(void);

M0_INTERNAL void m0_cookie_global_fini(void);

M0_INTERNAL void m0_cookie_new(uint64_t * gen);

M0_INTERNAL void m0_cookie_init(struct m0_cookie *cookie, const uint64_t *obj);

M0_INTERNAL int m0_cookie_dereference(const struct m0_cookie *cookie,
                                      uint64_t **addr);

M0_INTERNAL bool m0_addr_is_sane(const uint64_t *addr);

M0_INTERNAL bool m0_addr_is_sane_and_aligned(const uint64_t *addr);


M0_INTERNAL bool m0_cookie_is_null(const struct m0_cookie *cookie);

M0_INTERNAL bool m0_cookie_is_eq(const struct m0_cookie *cookie1,
                                 const struct m0_cookie *cookie2);

#define m0_cookie_of(cookie, type, field)                     \
({                                                            \
        uint64_t               *__gen;                        \
        const struct m0_cookie *__cookie = (cookie);          \
        m0_cookie_dereference(__cookie, &__gen) != 0 ? NULL : \
                        container_of(__gen, type, field);     \
})

/*__M0_LIB_COOKIE_H__*/
#endif

M0_EXTERN const struct m0_cookie M0_COOKIE_NULL;
/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */