stackchk.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * COPYRIGHT (c) 1989-2024 On-Line Applications Research Corporation (OAR).
 * COPYRIGHT (c) 2024 Mohamed Hassan <muhammad.hamdy.hassan@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _RTEMS_STACKCHK_H
#define _RTEMS_STACKCHK_H
 
#include <rtems.h>
#include <rtems/print.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
bool rtems_stack_checker_is_blown( void );
 
void rtems_stack_checker_report_usage( void );
 
void rtems_stack_checker_report_usage_with_plugin(
  const rtems_printer *printer
);
 
typedef struct {
  rtems_id id;
 
  const char *name;
 
  const void *begin;
 
  uintptr_t size;
 
  const void *current;
 
  uintptr_t used;
} rtems_stack_checker_info;
 
typedef void ( *rtems_stack_checker_visitor )(
  const rtems_stack_checker_info *info,
  void                           *arg
);
 
void rtems_stack_checker_iterate( rtems_stack_checker_visitor visit, void *arg );
 
/*************************************************************
 *************************************************************
 **  Prototyped only so the user extension can be installed **
 *************************************************************
 *************************************************************/
 
bool rtems_stack_checker_create_extension(
  rtems_tcb *running,
  rtems_tcb *the_thread
);
 
void rtems_stack_checker_begin_extension( rtems_tcb *executing );
 
void rtems_stack_checker_switch_extension(
  rtems_tcb *running,
  rtems_tcb *heir
);
 
void rtems_stack_checker_reporter_quiet(
  const rtems_tcb *running,
  bool pattern_ok
);
 
void rtems_stack_checker_reporter_print_details(
  const rtems_tcb *running,
  bool pattern_ok
);
 
#define RTEMS_STACK_CHECKER_EXTENSION \
{ \
  rtems_stack_checker_create_extension,        /* rtems_task_create  */ \
  0,                                           /* rtems_task_start   */ \
  0,                                           /* rtems_task_restart */ \
  0,                                           /* rtems_task_delete  */ \
  rtems_stack_checker_switch_extension,        /* task_switch  */ \
  rtems_stack_checker_begin_extension,         /* task_begin   */ \
  0,                                           /* task_exitted */ \
  0,                                           /* fatal        */ \
  0                                            /* terminate    */ \
}
 
typedef void (*Stack_checker_Reporter_handler)(
  const rtems_tcb *running,
  bool pattern_ok
);
 
extern const Stack_checker_Reporter_handler Stack_checker_Reporter;
 
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */