summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/barriermp.h
blob: d215ecdb5f94f294b8adb691192176c1bd0519ef (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
/**
 * @file
 *
 * @brief MP Support in the Barrier Manager
 *
 * This include file contains all the constants and structures associated
 * with the Multiprocessing Support in the Barrier 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_BARRIERMP_H
#define _RTEMS_RTEMS_BARRIERMP_H

#include <rtems/score/mpciimpl.h>

#ifdef __cplusplus
extern "C" {
#endif

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

/**
 *  The following enumerated type defines the list of
 *  remote barrier operations.
 */
typedef enum {
  BARRIER_MP_ANNOUNCE_CREATE  =  0,
  BARRIER_MP_ANNOUNCE_DELETE  =  1,
  BARRIER_MP_EXTRACT_PROXY    =  2,
  BARRIER_MP_WAIT_REQUEST     =  3,
  BARRIER_MP_WAIT_RESPONSE    =  4,
  BARRIER_MP_RELEASE_REQUEST  =  5,
  BARRIER_MP_RELEASE_RESPONSE =  6
}   Barrier_MP_Remote_operations;

/**
 *  The following data structure defines the packet used to perform
 *  remote barrier operations.
 */
typedef struct {
  rtems_packet_prefix           Prefix;
  Barrier_MP_Remote_operations  operation;
  rtems_name                    name;
  rtems_option                  option_set;
  Objects_Id                    proxy_id;
}   Barrier_MP_Packet;

/**
 *  @brief _Barrier_MP_Send_process_packet
 *
 *  This routine performs a remote procedure call so that a
 *  process operation can be performed on another node.
 */
void _Barrier_MP_Send_process_packet (
  Barrier_MP_Remote_operations operation,
  Objects_Id                   barrier_id,
  rtems_name                   name,
  Objects_Id                   proxy_id
);

/**
 *  @brief _Barrier_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 _Barrier_MP_Send_request_packet (
  Barrier_MP_Remote_operations operation,
  Objects_Id                   barrier_id,
  rtems_interval               timeout
);

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

/**
 *  @brief _Barrier_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.
 */
void _Barrier_MP_Send_object_was_deleted (
  Thread_Control *the_proxy
);

/**
 *  @brief _Barrier_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.
 */
void _Barrier_MP_Send_extract_proxy (
  void           *argument
);

/**@}*/

#ifdef __cplusplus
}
#endif

#endif
/* end of file */