Subversion Repositories or1k

/*  userext.h

 *

 *  This include file contains all information about user extensions.  This

 *  Handler provides mechanisms which can be used to initialize and manipulate

 *  all user extensions.

 *

 *  COPYRIGHT (c) 1989-1999.

 *  On-Line Applications Research Corporation (OAR).

 *

 *  The license and distribution terms for this file may be

 *  found in the file LICENSE in this distribution or at

 *  http://www.OARcorp.com/rtems/license.html.

 *

 *  userext.h,v 1.16 2002/04/08 17:26:13 joel Exp

 */

#ifndef __USER_EXTENSIONS_h

#define __USER_EXTENSIONS_h

#ifdef __cplusplus

extern "C" {

#endif

#include <rtems/score/interr.h>

#include <rtems/score/chain.h>

#include <rtems/score/thread.h>

/*

 *  The following records defines the User Extension Table.

 *  This table defines the application dependent routines which

 *  are invoked at critical points in the life of each thread and

 *  the system as a whole.

 */

typedef void User_extensions_routine;

typedef boolean ( *User_extensions_thread_create_extension )(

                 Thread_Control *,

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_delete_extension )(

                 Thread_Control *,

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_start_extension )(

                 Thread_Control *,

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_restart_extension )(

                 Thread_Control *,

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_switch_extension )(

                 Thread_Control *,

                 Thread_Control *

             );

typedef User_extensions_routine (

                                *User_extensions_thread_post_switch_extension )(

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_begin_extension )(

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_thread_exitted_extension )(

                 Thread_Control *

             );

typedef User_extensions_routine ( *User_extensions_fatal_extension )(

                 Internal_errors_Source  /* the_source  */,

                 boolean                 /* is_internal */,

                 unsigned32              /* the_error   */

             );

typedef struct {

  User_extensions_thread_create_extension       thread_create;

  User_extensions_thread_start_extension        thread_start;

  User_extensions_thread_restart_extension      thread_restart;

  User_extensions_thread_delete_extension       thread_delete;

  User_extensions_thread_switch_extension       thread_switch;

  User_extensions_thread_begin_extension        thread_begin;

  User_extensions_thread_exitted_extension      thread_exitted;

  User_extensions_fatal_extension               fatal;

}   User_extensions_Table;

/*

 *  The following is used to manage the list of switch handlers.

 */

typedef struct {

  Chain_Node                              Node;

  User_extensions_thread_switch_extension thread_switch;

}   User_extensions_Switch_control;

/*

 *  The following is used to manage each user extension set.

 *  The switch control is part of the extensions control even

 *  if not used due to the extension not having a switch

 *  handler.

 */

typedef struct {

  Chain_Node                     Node;

  User_extensions_Switch_control Switch;

  User_extensions_Table          Callouts;

}   User_extensions_Control;

/*

 *  The following is used to manage the list of active extensions.

 */

SCORE_EXTERN Chain_Control _User_extensions_List;

/*

 *  The following is used to manage a chain of user extension task

 *  switch nodes.

 */

SCORE_EXTERN Chain_Control _User_extensions_Switches_list;

/*

 *  _User_extensions_Thread_create

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension for

 *  the thread creation operate.

 */

boolean _User_extensions_Thread_create (

  Thread_Control *the_thread

);

/*

 *  _User_extensions_Thread_delete

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension for

 *  the thread deletion operation.

 */

void _User_extensions_Thread_delete (

  Thread_Control *the_thread

);

/*

 *  _User_extensions_Thread_start

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension for

 *  the thread start operation.

 */

void _User_extensions_Thread_start (

  Thread_Control *the_thread

);

/*

 *  _User_extensions_Thread_restart

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension for

 *  the thread restart operation.

 */

void _User_extensions_Thread_restart (

  Thread_Control *the_thread

);

/*

 *  _User_extensions_Thread_begin

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension which

 *  is invoked when a thread begins.

 */

void _User_extensions_Thread_begin (

  Thread_Control *executing

);

/*

 *  _User_extensions_Thread_exitted

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension which

 *  is invoked when a thread exits.

 */

void _User_extensions_Thread_exitted (

  Thread_Control *executing

);

/*

 *  _User_extensions_Fatal

 *

 *  DESCRIPTION:

 *

 *  This routine is used to invoke the user extension invoked

 *  when a fatal error occurs.

 */

void _User_extensions_Fatal (

  Internal_errors_Source  the_source,

  boolean                 is_internal,

  unsigned32              the_error

);

#ifndef __RTEMS_APPLICATION__

#include <rtems/score/userext.inl>

#endif

#ifdef __cplusplus

}

#endif

#endif

/* end of include file */