summaryrefslogblamecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/signalmp.h
blob: c6b9a3d045448ffd0664aa29f944f6d37c1ad6e9 (plain) (tree)
1
2
3
4
5
6
7
8
9

                               
  



                                                                         

   
                           
                                                   
  

                                                          
                                        

   

                               
 



                                                                                                  

                                 



                  
   


                                               
  

                                                                              
   
     

   


                                                     

                              
                             

                                
   


                                                                   
                


                                         


                     
                                        







                                                           
   
                                        



                                                           


                                                  
                                       

  
   
                                         



                                                           




                                         
   
                                   



                                                                  




                                        
                                            









                                                           
                                       








                                                             
   
                               


                                                       

                                                 

       





                  
/**
 * @file rtems/rtems/signalmp.h
 *
 * @brief Signal MP Support
 *
 * This include file contains all the constants and structures associated
 * with the Multiprocessing Support in the Signal Manager.
 */

/* COPYRIGHT (c) 1989-2013.
 * 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.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_SIGNALMP_H
#define _RTEMS_RTEMS_SIGNALMP_H

#ifndef _RTEMS_RTEMS_SIGNALIMPL_H
# error "Never use <rtems/rtems/signalmp.h> directly; include <rtems/rtems/signalimpl.h> instead."
#endif

#include <rtems/score/mpciimpl.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 *  @defgroup ClassicSignalMP Signal MP Support
 *
 *  @ingroup ClassicMP
 *
 *  This encapsulates functionality related to the transparent multiprocessing
 *  support within the Classic API Signal Manager.
 */
/*{*/

/**
 *  The following enumerated type defines the list of
 *  remote signal operations.
 */
typedef enum {
  SIGNAL_MP_SEND_REQUEST  = 0,
  SIGNAL_MP_SEND_RESPONSE = 1
}   Signal_MP_Remote_operations;

/**
 *  The following data structure defines the packet used to perform
 *  remote signal operations.
 */
typedef struct {
  rtems_packet_prefix          Prefix;
  Signal_MP_Remote_operations  operation;
  rtems_signal_set             signal_in;
}   Signal_MP_Packet;

/*
 *  @brief Signal_MP_Send_process_packet
 *
 *  This routine performs a remote procedure call so that a
 *  process operation can be performed on another node.
 *
 *  This routine is not needed since there are no process
 *  packets to be sent by this manager.
 */

/**
 *  @brief Signal MP Send Request Packet
 *
 *  This routine performs a remote procedure call so that a
 *  directive operation can be initiated on another node.
 */
rtems_status_code _Signal_MP_Send_request_packet (
  Signal_MP_Remote_operations operation,
  Objects_Id                  task_id,
  rtems_signal_set            signal_in
);

/**
 *  @brief Signal MP Send Response Packet
 *
 *  This routine performs a remote procedure call so that a
 *  directive can be performed on another node.
 */
void _Signal_MP_Send_response_packet (
  Signal_MP_Remote_operations  operation,
  Thread_Control              *the_thread
);

/**
 *  @brief Signal MP Process Packet
 *
 *  This routine performs the actions specific to this package for
 *  the request from another node.
 */
void _Signal_MP_Process_packet (
  rtems_packet_prefix *the_packet_prefix
);

/*
 *  @brief Signal_MP_Send_object_was_deleted
 *
 *  This routine is invoked indirectly by the thread queue
 *  when a proxy has been removed from the thread queue and
 *  the remote node must be informed of this.
 *
 *  This routine is not needed since there are no objects
 *  deleted by this manager.
 */

/*
 *  @brief Signal_MP_Send_extract_proxy
 *
 *  This routine is invoked when a task is deleted and it
 *  has a proxy which must be removed from a thread queue and
 *  the remote node must be informed of this.
 *
 *  This routine is not needed since there are no objects
 *  deleted by this manager.
 */

/**
 *  @brief Signal MP Get Packet
 *
 *  This function is used to obtain a signal mp packet.
 */
Signal_MP_Packet *_Signal_MP_Get_packet ( void );

/**@}*/

#ifdef __cplusplus
}
#endif

#endif
/* end of file */