summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/mqueuemp.h
blob: 920dcd94806a52c7e319301de8a0ec3a7548f9c5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/**
 * @file rtems/posix/mqueuemp.h
 */

/*  mqueuemp.h
 *
 *  This include file contains all the constants and structures associated
 *  with the Multiprocessing Support in the POSIX Message Queue Manager.
 *
 *  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.rtems.com/license/LICENSE.
 *
 *  $Id$
 */

#ifndef __RTEMS_POSIX_MESSAGE_QUEUE_MP_h
#define __RTEMS_POSIX_MESSAGE_QUEUE_MP_h

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/score/mppkt.h>
#include <rtems/score/object.h>
#include <rtems/score/thread.h>
#include <rtems/score/watchdog.h>

/*
 *  The following enumerated type defines the list of
 *  remote message queue operations.
 */

typedef enum {
  POSIX_MESSAGE_QUEUE_MP_ANNOUNCE_CREATE  =  0,
  POSIX_MESSAGE_QUEUE_MP_ANNOUNCE_DELETE  =  1,
  POSIX_MESSAGE_QUEUE_MP_EXTRACT_PROXY    =  2,
  POSIX_MESSAGE_QUEUE_MP_OBTAIN_REQUEST   =  3,
  POSIX_MESSAGE_QUEUE_MP_OBTAIN_RESPONSE  =  4,
  POSIX_MESSAGE_QUEUE_MP_RELEASE_REQUEST  =  5,
  POSIX_MESSAGE_QUEUE_MP_RELEASE_RESPONSE =  6,
}   POSIX_Message_queue_MP_Remote_operations;

/*
 *  The following data structure defines the packet used to perform
 *  remote message queue operations.
 */

typedef struct {
  MP_packet_Prefix                          Prefix;
  POSIX_Message_queue_MP_Remote_operations  operation;
  Objects_Name                              name;
  boolean                                   wait;  /* XXX options */
  Objects_Id                                proxy_id;
}   POSIX_Message_queue_MP_Packet;

/*
 *  _POSIX_Message_queue_MP_Send_process_packet
 *
 *  DESCRIPTION:
 *
 *  This routine performs a remote procedure call so that a
 *  process operation can be performed on another node.
 */

void _POSIX_Message_queue_MP_Send_process_packet (
  POSIX_Message_queue_MP_Remote_operations  operation,
  Objects_Id                        mq_id,
  Objects_Name                      name,
  Objects_Id                        proxy_id
);

/*
 *  _POSIX_Message_queue_MP_Send_request_packet
 *
 *  DESCRIPTION:
 *
 *  This routine performs a remote procedure call so that a
 *  directive operation can be initiated on another node.
 */

int _POSIX_Message_queue_MP_Send_request_packet (
  POSIX_Message_queue_MP_Remote_operations  operation,
  Objects_Id                                mq_id,
  boolean                                   wait,  /* XXX options */
  Watchdog_Interval                         timeout
);

/*
 *  _POSIX_Message_queue_MP_Send_response_packet
 *
 *  DESCRIPTION:
 *
 *  This routine performs a remote procedure call so that a
 *  directive can be performed on another node.
 */

void _POSIX_Message_queue_MP_Send_response_packet (
  POSIX_Message_queue_MP_Remote_operations  operation,
  Objects_Id                        mq_id,
  Thread_Control                   *the_thread
);

/*
 *
 *  _POSIX_Message_queue_MP_Process_packet
 *
 *  DESCRIPTION:
 *
 *  This routine performs the actions specific to this package for
 *  the request from another node.
 */

void _POSIX_Message_queue_MP_Process_packet (
  MP_packet_Prefix *the_packet_prefix
);

/*
 *  _POSIX_Message_queue_MP_Send_object_was_deleted
 *
 *  DESCRIPTION:
 *
 *  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.
 */

void _POSIX_Message_queue_MP_Send_object_was_deleted (
  Thread_Control *the_proxy
);

/*
 *  _POSIX_Message_queue_MP_Send_extract_proxy
 *
 *  DESCRIPTION:
 *
 *  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.
 */

void _POSIX_Message_queue_MP_Send_extract_proxy (
  Thread_Control *the_thread
);

/*
 *  _POSIX_Message_queue_MP_Get_packet
 *
 *  DESCRIPTION:
 *
 *  This function is used to obtain a message queue mp packet.
 */

POSIX_Message_queue_MP_Packet *_POSIX_Message_queue_MP_Get_packet ( void );

#ifdef __cplusplus
}
#endif

#endif
/* end of file */