RTEMS
5.0.0
|
Files | |
file | mpci.h |
MPCI Layer API. | |
file | mpciimpl.h |
MPCI Layer Implementation. | |
file | mpci.c |
Multiprocessing Communications Interface (MPCI) Handler. | |
Data Structures | |
struct | MPCI_Control |
struct | MPCI_Internal_packet |
Macros | |
#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 } |
Variables | |
Thread_queue_Control | _MPCI_Remote_blocked_threads |
MPCI_Control * | _MPCI_table |
Thread_Control * | _MPCI_Receive_server_tcb |
Pointer to MP thread control block. More... | |
MPCI_Packet_processor | _MPCI_Packet_processors [MP_PACKET_CLASSES_LAST+1] |
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 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 void MPCI_Entry |
This type is returned by all user provided MPCI routines.
typedef MPCI_Entry( * MPCI_get_packet_entry) (MP_packet_Prefix **) |
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.
typedef MPCI_Entry( * MPCI_initialization_entry) (void) |
This type defines the prototype for the initization entry point in an Multiprocessor Communications Interface.
typedef void(* MPCI_Packet_processor) (MP_packet_Prefix *) |
The following defines the type for packet processing routines invoked by the MPCI Receive server.
typedef MPCI_Entry( * MPCI_receive_entry) (MP_packet_Prefix **) |
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.
typedef MPCI_Entry( * MPCI_return_packet_entry) (MP_packet_Prefix *) |
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.
The following enumerated type defines the list of internal MP operations.
RTEMS_INLINE_ROUTINE bool _Mp_packet_Is_valid_packet_class | ( | MP_packet_Classes | the_packet_class | ) |
This function returns true if the the_packet_class is valid, and false otherwise.
void _MPCI_Announce | ( | void | ) |
Announce the availability of a packet.
This routine informs RTEMS of the availability of an MPCI packet.
MP_packet_Prefix* _MPCI_Get_packet | ( | void | ) |
This function obtains a packet by invoking the user provided MPCI get packet callout.
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. |
MPCI_Internal_packet* _MPCI_Internal_packets_Get_packet | ( | void | ) |
Obtain an internal thread.
_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 an internal threads MP packet.
void _MPCI_Internal_packets_Process_packet | ( | MP_packet_Prefix * | the_packet_prefix | ) |
Perform requested action from another node.
_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 | ) |
Perform a process on another node.
This routine performs a remote procedure call so that a process operation can be performed on another node.
[in] | operation | is the remote operation to perform. |
Thread_Control* _MPCI_Process_response | ( | MP_packet_Prefix * | the_packet | ) |
Pass a packet to the thread.
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.
[in] | the_packet | is the response packet to be processed. |
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 | ) |
Receive a packet.
This routine receives a packet by invoking the user provided MPCI receive callout.
This | method returns the packet received. |
void _MPCI_Receive_server | ( | Thread_Entry_numeric_type | ignored | ) |
Receive and process all packets.
This is the server thread which receives and processes all MCPI packets.
[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.
[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 | ) |
Deallocate a packet.
This routine deallocates a packet by invoking the user provided MPCI return packet callout.
[in] | the_packet | is the MP packet to deallocate. |
void _MPCI_Send_process_packet | ( | uint32_t | destination, |
MP_packet_Prefix * | the_packet | ||
) |
Send a process packet.
This routine sends a process packet by invoking the user provided MPCI send callout.
[in] | destination | is the node which should receive this packet. |
[in] | the_packet | is the packet to be sent. |
Status_Control _MPCI_Send_request_packet | ( | uint32_t | destination, |
MP_packet_Prefix * | the_packet, | ||
States_Control | extra_state | ||
) |
Send a request packet.
This routine sends a request packet by invoking the user provided MPCI send callout.
[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. |
This | method returns the operation status from the remote node. |
void _MPCI_Send_response_packet | ( | uint32_t | destination, |
MP_packet_Prefix * | the_packet | ||
) |
Send a response packet.
This routine sends a response packet by invoking the user provided MPCI send callout.
[in] | destination | is the node which should receive this packet. |
[in] | the_packet | is the packet to be sent. |
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.
Thread_Control* _MPCI_Receive_server_tcb |
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.
Thread_queue_Control _MPCI_Remote_blocked_threads |
The following thread queue is used to maintain a list of tasks which currently have outstanding remote requests.
MPCI_Control* _MPCI_table |
The following define the internal pointers to the user's configuration information.