finject_internal.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_FINJECT_INTERNAL_H__
#define __MOTR_LIB_FINJECT_INTERNAL_H__

#include "lib/mutex.h"     /* m0_mutex */

struct m0_fi_fpoint_id {
        const char  *fpi_func;
        const char  *fpi_tag;
};

struct m0_fi_fpoint_state;
typedef bool (*fp_state_func_t)(struct m0_fi_fpoint_state *fps);

struct m0_fi_fpoint_state {
        struct m0_fi_fpoint_id    fps_id;
        fp_state_func_t           fps_trigger_func;
        struct m0_fi_fpoint_data  fps_data;
        struct m0_fi_fault_point *fps_fp;
        /* Mutex, used to keep "state" structure in consistent state */
        struct m0_mutex           fps_mutex;
        uint32_t                  fps_total_hit_cnt;
        uint32_t                  fps_total_trigger_cnt;
};

struct m0_fi_fpoint_state_info {
        uint32_t    si_idx;
        char        si_enb;
        uint32_t    si_total_hit_cnt;
        uint32_t    si_total_trigger_cnt;
        uint32_t    si_hit_cnt;
        uint32_t    si_trigger_cnt;
        const char *si_type;
        char        si_data[64];
        const char *si_module;
        const char *si_file;
        const char *si_func;
        const char *si_tag;
        uint32_t    si_line_num;
};

#ifdef ENABLE_FAULT_INJECTION

extern struct m0_mutex  fi_states_mutex;

static inline bool fi_state_enabled(const struct m0_fi_fpoint_state *state)
{
        /*
         * If fps_trigger_func is not set, then FP state is considered to be
         * "disabled"
         */
        return state->fps_trigger_func != NULL;
}

M0_INTERNAL const struct m0_fi_fpoint_state *m0_fi_states_get(void);

M0_INTERNAL uint32_t m0_fi_states_get_free_idx(void);

M0_INTERNAL void m0_fi_states_get_state_info(const struct m0_fi_fpoint_state *s,
                                             struct m0_fi_fpoint_state_info
                                             *si);

extern const char  *m0_fi_states_headline[];
extern const char   m0_fi_states_print_format[];

M0_INTERNAL int m0_fi_add_dyn_id(char *str);

M0_INTERNAL const char *m0_fi_fpoint_type_name(enum m0_fi_fpoint_type type);

M0_INTERNAL enum m0_fi_fpoint_type m0_fi_fpoint_type_from_str(const char
                                                              *type_name);

M0_INTERNAL void fi_states_init(void);
M0_INTERNAL void fi_states_fini(void);

#endif /* ENABLE_FAULT_INJECTION */

#endif /* __MOTR_LIB_FINJECT_INTERNAL_H__ */