MPCI Handler


Data Structures

struct  MPCI_Control
struct  MPCI_Internal_packet

Defines

#define MPCI_ALL_NODES   0
#define MPCI_DEFAULT_TIMEOUT   0xFFFFFFFF

Typedefs

typedef void MPCI_Entry
typedef MPCI_Entry(* MPCI_initialization_entry )(void)
typedef MPCI_Entry(* MPCI_get_packet_entry )(MP_packet_Prefix **)
typedef MPCI_Entry(* MPCI_return_packet_entry )(MP_packet_Prefix *)
typedef MPCI_Entry(* MPCI_send_entry )(uint32_t, MP_packet_Prefix *)
typedef MPCI_Entry(* MPCI_receive_entry )(MP_packet_Prefix **)
typedef void(* MPCI_Packet_processor )(MP_packet_Prefix *)

Enumerations

enum  MPCI_Internal_Remote_operations { MPCI_PACKETS_SYSTEM_VERIFY = 0 }

Functions

void _MPCI_Handler_initialization (MPCI_Control *users_mpci_table, uint32_t timeout_status)
void _MPCI_Create_server (void)
void _MPCI_Initialization (void)
void _MPCI_Register_packet_processor (MP_packet_Classes the_class, MPCI_Packet_processor the_packet_processor)
MP_packet_Prefix_MPCI_Get_packet (void)
void _MPCI_Return_packet (MP_packet_Prefix *the_packet)
void _MPCI_Send_process_packet (uint32_t destination, MP_packet_Prefix *the_packet)
uint32_t _MPCI_Send_request_packet (uint32_t destination, MP_packet_Prefix *the_packet, States_Control extra_state)
void _MPCI_Send_response_packet (uint32_t destination, MP_packet_Prefix *the_packet)
MP_packet_Prefix_MPCI_Receive_packet (void)
Thread_Control_MPCI_Process_response (MP_packet_Prefix *the_packet)
Thread _MPCI_Receive_server (uint32_t ignored)
void _MPCI_Announce (void)
void _MPCI_Internal_packets_Send_process_packet (MPCI_Internal_Remote_operations operation)
void _MPCI_Internal_packets_Process_packet (MP_packet_Prefix *the_packet_prefix)
MPCI_Internal_packet_MPCI_Internal_packets_Get_packet (void)

Variables

SCORE_EXTERN CORE_semaphore_Control _MPCI_Semaphore
SCORE_EXTERN Thread_queue_Control _MPCI_Remote_blocked_threads
SCORE_EXTERN MPCI_Control_MPCI_table
SCORE_EXTERN Thread_Control_MPCI_Receive_server_tcb
 Pointer to MP Thread Control Block.
SCORE_EXTERN MPCI_Packet_processor _MPCI_Packet_processors [MP_PACKET_CLASSES_LAST+1]

Detailed Description

The MPCI Handler encapsulates functionality which is related to the generation, receipt, and processing of remote operations in a multiprocessor system. This handler contains the message passing support for making remote service calls as well as the server thread which processes requests from remote nodes.

Define Documentation

#define MPCI_ALL_NODES   0

The following defines the node number used when a broadcast is desired.

#define MPCI_DEFAULT_TIMEOUT   0xFFFFFFFF

For packets associated with requests that don't already have a timeout, use the one specified by this MPCI driver. The value specified by the MPCI driver sets an upper limit on how long a remote request should take to complete.


Typedef Documentation

typedef void MPCI_Entry

This type is returned by all user provided MPCI routines.

This type defines the prototype for the get packet entry point in an Multiprocessor Communications Interface. The single parameter will point to the packet allocated.

This type defines the prototype for the initization entry point in an Multiprocessor Communications Interface.

The following defines the type for packet processing routines invoked by the MPCI Receive server.

This type defines the prototype for the receive packet entry point in an Multiprocessor Communications Interface. The single parameter will point to a packet allocated and filled in by the receive packet handler. The caller will block until a packet is received.

This type defines the prototype for the return packet entry point in an Multiprocessor Communications Interface. The single parameter will point to a packet previously allocated by the get packet MPCI entry.

typedef MPCI_Entry( * MPCI_send_entry)(uint32_t, MP_packet_Prefix *)

This type defines the prototype for send get packet entry point in an Multiprocessor Communications Interface. The single parameter will point to a packet previously allocated by the get packet entry point that has been filled in by the caller.


Enumeration Type Documentation

The following enumerated type defines the list of internal MP operations.


Function Documentation

void _MPCI_Announce ( void   ) 

This routine informs RTEMS of the availability of an MPCI packet.

void _MPCI_Create_server ( void   ) 

This routine creates the packet receive server used in MP systems.

MP_packet_Prefix* _MPCI_Get_packet ( void   ) 

This function obtains a packet by invoking the user provided MPCI get packet callout.

Returns:
This method returns a pointer to a MPCI packet which can be filled in by the caller and used to perform a subsequent remote operation.

void _MPCI_Handler_initialization ( MPCI_Control users_mpci_table,
uint32_t  timeout_status 
)

This routine performs the initialization necessary for this handler.

Parameters:
[in] users_mpci_table is a pointer to the application configured MPCI Table. This table contains pointers to the MPCI Layers entry points.
[in] timeout_status is the value which should be returned to blocking threads when they timeout on a remote operation.

void _MPCI_Initialization ( void   ) 

This routine initializes the MPCI driver by invoking the user provided MPCI initialization callout.

MPCI_Internal_packet* _MPCI_Internal_packets_Get_packet ( void   ) 

_MPCI_Internal_packets_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. _MPCI_Internal_packets_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. This routine is used to obtain a internal threads mp packet.

void _MPCI_Internal_packets_Process_packet ( MP_packet_Prefix the_packet_prefix  ) 

_MPCI_Internal_packets_Send_request_packet

This routine performs a remote procedure call so that a directive operation can be initiated on another node.

This routine is not needed since there are no request packets to be sent by this manager. _MPCI_Internal_packets_Send_response_packet

This routine performs a remote procedure call so that a directive can be performed on another node.

This routine is not needed since there are no response packets to be sent by this manager. This routine performs the actions specific to this package for the request from another node.

void _MPCI_Internal_packets_Send_process_packet ( MPCI_Internal_Remote_operations  operation  ) 

This routine performs a remote procedure call so that a process operation can be performed on another node.

Parameters:
[in] operation is the remote operation to perform.

Thread_Control* _MPCI_Process_response ( MP_packet_Prefix the_packet  ) 

This routine is responsible for passing the_packet to the thread waiting on the remote operation to complete. The unblocked thread is responsible for eventually freeing the_packet.

Parameters:
[in] the_packet is the response packet to be processed.
Returns:
This method returns a pointer to the thread which was if unblocked or NULL if the waiting thread no longer exists.

MP_packet_Prefix* _MPCI_Receive_packet ( void   ) 

This routine receives a packet by invoking the user provided MPCI receive callout.

Returns:
This method returns the packet received.

Thread _MPCI_Receive_server ( uint32_t  ignored  ) 

This is the server thread which receives and processes all MCPI packets.

Parameters:
[in] ignored is the thread argument. It is not used.

void _MPCI_Register_packet_processor ( MP_packet_Classes  the_class,
MPCI_Packet_processor  the_packet_processor 
)

This routine registers the MPCI packet processor for the designated object class.

Parameters:
[in] the_class is the class indicator for packets which will be processed by the_packet_processor method.
[in] the_packet_processor is a pointer to a method which is invoked when packets with the_class are received.

void _MPCI_Return_packet ( MP_packet_Prefix the_packet  ) 

This routine deallocates a packet by invoking the user provided MPCI return packet callout.

Parameters:
[in] the_packet is the MP packet to deallocate.

void _MPCI_Send_process_packet ( uint32_t  destination,
MP_packet_Prefix the_packet 
)

This routine sends a process packet by invoking the user provided MPCI send callout.

Parameters:
[in] destination is the node which should receive this packet.
[in] the_packet is the packet to be sent.

uint32_t _MPCI_Send_request_packet ( uint32_t  destination,
MP_packet_Prefix the_packet,
States_Control  extra_state 
)

This routine sends a request packet by invoking the user provided MPCI send callout.

Parameters:
[in] destination is the node which should receive this packet.
[in] the_packet is the packet to be sent.
[in] extra_state is the extra thread state bits which should be set in addition to the remote operation pending state. It may indicate the caller is blocking on a message queue operation.
Returns:
This method returns the operation status from the remote node.

void _MPCI_Send_response_packet ( uint32_t  destination,
MP_packet_Prefix the_packet 
)

This routine sends a response packet by invoking the user provided MPCI send callout.

Parameters:
[in] destination is the node which should receive this packet.
[in] the_packet is the packet to be sent.


Variable Documentation

SCORE_EXTERN MPCI_Packet_processor _MPCI_Packet_processors[MP_PACKET_CLASSES_LAST+1]

The following table contains the process packet routines provided by each object that supports MP operations.

Pointer to MP Thread Control Block.

The following is used to determine when the multiprocessing receive thread is executing so that a proxy can be allocated instead of blocking the multiprocessing receive thread.

Referenced by _Thread_MP_Is_receive().

The following thread queue is used to maintain a list of tasks which currently have outstanding remote requests.

This is the core semaphore which the MPCI Receive Server blocks on.

SCORE_EXTERN MPCI_Control* _MPCI_table

The following define the internal pointers to the user's configuration information.


Generated on Sat Jul 5 12:16:33 2008 for RTEMSSuperCore by  doxygen 1.5.6