bob.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_BOB_H__
#define __MOTR_LIB_BOB_H__

#include "lib/types.h"                  /* uint64_t */

/* import */
struct m0_tl_descr;

/* export */
struct m0_bob_type;

struct m0_bob_type {
        const char *bt_name;
        int         bt_magix_offset;
        uint64_t    bt_magix;
        bool      (*bt_check)(const void *bob);
};

M0_INTERNAL void m0_bob_type_tlist_init(struct m0_bob_type *bt,
                                        const struct m0_tl_descr *td);

M0_INTERNAL void m0_bob_init(const struct m0_bob_type *bt, void *bob);

M0_INTERNAL void m0_bob_fini(const struct m0_bob_type *bt, void *bob);

M0_INTERNAL bool m0_bob_check(const struct m0_bob_type *bt, const void *bob);

#define M0_BOB_DEFINE(scope, bob_type, type)                    \
scope void type ## _bob_init(struct type *bob)                  \
{                                                               \
        m0_bob_init(bob_type, bob);                             \
}                                                               \
                                                                \
scope void type ## _bob_fini(struct type *bob)                  \
{                                                               \
        m0_bob_fini(bob_type, bob);                             \
}                                                               \
                                                                \
scope M0_UNUSED bool type ## _bob_check(const struct type *bob) \
{                                                               \
        return m0_bob_check(bob_type, bob);                     \
}                                                               \
                                                                \
struct __ ## type ## _semicolon_catcher

#define M0_BOB_DECLARE(scope, type)                     \
scope void type ## _bob_init(struct type *bob);         \
scope void type ## _bob_fini(struct type *bob);         \
scope bool type ## _bob_check(const struct type *bob)

#define bob_of(ptr, type, field, bt)                                    \
({                                                                      \
        void *__ptr = (void *)(ptr);                                    \
        type *__amb;                                                    \
                                                                        \
        M0_ASSERT(__ptr != NULL);                                       \
        __amb = container_of(__ptr, type, field);                       \
                                                                        \
        M0_ASSERT_INFO(m0_bob_check(bt, __amb),                 \
                "%s.%s [%p->%p (%s)] got: %" PRIx64 " want: %" PRIx64   \
                " check: %i.", (bt)->bt_name, #field, __ptr, __amb, #type, \
                *((uint64_t *)(((void *)__amb) + (bt)->bt_magix_offset)), \
                (bt)->bt_magix,                                 \
                (bt)->bt_check != NULL ? (bt)->bt_check(__amb) : -1);   \
        __amb;                                                          \
})

/* __MOTR_LIB_BOB_H__ */
#endif

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