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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261 | ------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- Cheddar is a GNU GPL real-time scheduling analysis tool.
-- This program provides services to automatically check schedulability and
-- other performance criteria of real-time architecture models.
--
-- Copyright (C) 2002-2023, Frank Singhoff, Alain Plantec, Jerome Legrand,
-- Hai Nam Tran, Stephane Rubini
--
-- The Cheddar project was started in 2002 by
-- Frank Singhoff, Lab-STICC UMR CNRS 6285, Universite de Bretagne Occidentale
--
-- Cheddar has been published in the "Agence de Protection des Programmes/France" in 2008.
-- Since 2008, Ellidiss technologies also contributes to the development of
-- Cheddar and provides industrial support.
--
-- The full list of contributors and sponsors can be found in README.md
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program; if not, write to the Free Software
-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
--
--
-- Contact : cheddar@listes.univ-brest.fr
--
------------------------------------------------------------------------------
-- Last update :
-- $Rev: 4589 $
-- $Date: 2023-09-29 16:02:19 +0200 (ven., 29 sept. 2023) $
-- $Author: singhoff $
------------------------------------------------------------------------------
------------------------------------------------------------------------------
with Text_IO;
with Ada.Strings.Unbounded.Text_IO;
with Systems; use Systems;
with GNAT.Sockets; use GNAT.Sockets;
with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
with Multiprocessor_Services_Interface; use Multiprocessor_Services_Interface;
use Multiprocessor_Services_Interface.Scheduling_Result_Per_Processor_Package;
use type Multiprocessor_Services_Interface.scheduling_table_range;
---------------------------------------------------------------------
-- Package Sockets_Overlay
-- Purpose: Contrains types definitions, functions and procedures
-- usefull for sockets manipulations such as IO and configuration.
--
-- Extra: Currently the sockets and channels are declared as global
-- variables in the package since we know that we only have 1 client
-- and 1 server using specifically 3 sockets: simple -> better
-- Implementation should be changed if tasks are added / multiple
-- connections clients. (clients list)
---------------------------------------------------------------------
package Sockets_Overlay is
Address : Sock_Addr_Type;
Server : Socket_Type;
Ack_Socket : Socket_Type;
Data_Socket : Socket_Type;
Command_Socket : Socket_Type;
Ack_Channel : GNAT.Sockets.Stream_Access;
Data_Channel : GNAT.Sockets.Stream_Access;
Command_Channel : GNAT.Sockets.Stream_Access;
Socket_Mode_Activated : Boolean := False;
-- Sockets selector identifiers:
Input_Status : Selector_Status;
Input_Selector : Selector_Type;
Input_Set : Socket_Set_Type;
WSet : Socket_Set_Type;
type communication_state is (starting, running, ending);
Current_Communication_State : communication_state := starting;
procedure Data_Communication
(Sys : in system;
Result : in scheduling_table_ptr;
J : in scheduling_table_range;
Current_Time : in Natural;
Last_Time_Mod : in out Natural;
SpeedFactor : in Duration;
Speed : in out Duration;
Slice_Size : in out Natural;
Exit_Simulation : in out Boolean);
---------------------------------------------------------------------
-- Close_Sockets
-- Purpose: Close the three sockets used: Ack, Command, Data.
---------------------------------------------------------------------
procedure Close_Sockets;
---------------------------------------------------------------------
-- Connect_Socket
-- Purpose: Used to make a simple connection between a client and the server.
-- - Only a listen and accept statement.
---------------------------------------------------------------------
procedure Connect_Socket
(Serv : in out Socket_Type;
Client : in out Socket_Type;
Addr : in Sock_Addr_Type;
Channel : in out GNAT.Sockets.Stream_Access);
---------------------------------------------------------------------
-- Get_Command_Value
-- Purpose: Return the value passed as argument of a socket command.
-- The value of a command is in this format:
-- "my_command [my_value]"
---------------------------------------------------------------------
function Get_Command_Value (Command : Unbounded_String) return String;
---------------------------------------------------------------------
-- Initialize_Socket
-- Purpose: Used to initialize a socket.
-- - Only a bind and accept statement.
---------------------------------------------------------------------
procedure Initialize_Socket
(Address : in Sock_Addr_Type;
Serv : in out Socket_Type);
---------------------------------------------------------------------
-- Read
-- Purpose: Read data on the socket channel.
--
-- Extra: At first, Read_Channel was used to get the input on sockets,
-- tests was made between 2 ADA programs and no problem was detected.
-- Since the connection is made between an ADA program (Cheddar) and an
-- other one (AADLInspector) the Read_Channel procedure wasn't functionnal
-- anymore.
--
-- The procedure was locked in a waiting state on reading Inputs from
-- AADLInspector. After multiples tests and modifications, no solution was
-- spotted. After internet research on GNAT.Socket documentation and
-- code documentation of specification and body files no clue on the issue
-- was found. A network analysis showed unspecifed data before the message
-- sended from an ADA program.
--
-- Indeed, it was found later that GNAT.Socket is adding a layer on top of
-- the message. As said before, this layer was not specified on the
-- GNAT.Socket documentation and was only spotted in a book:
-- "Systèmes temps réel embarqués - 2e éd: Conception et implémentation
-- Par Francis Cottet,Emmanuel Grolleau, page 435."
-- GNAT.Socket uses a specific communication protocol over the TCP stack,
-- while sending a string with String'Output(s), the string is transmitted
-- under the following form:
-- * an integer with value 1 on 4 bytes in binary followed by,
-- * an integer on 4 bytes in binary wich is the string length,
-- * and then the characters of the string s.
-- The function String'Input only accept this format too.
--
-- So, this is a issue that you need to be aware if you try to communicate
-- between an Ada program and another program written in another language.
---------------------------------------------------------------------
function Read
(Client : in out Socket_Type;
Channel : in out Stream_Access) return Unbounded_String;
---------------------------------------------------------------------
-- Read_Channel
-- Purpose: Read data on the specified socket channel.
-- Extra: This procedure assume that the communication is between
-- Ada programs or betwenn programs in Ada and in different languages
-- but implementing the protocol used by Gnat.Sockets.
--
-- [See 'Read' procedure Documentation for Issue]
---------------------------------------------------------------------
procedure Read_Channel
(Channel : in out GNAT.Sockets.Stream_Access;
Data : out Unbounded_String);
---------------------------------------------------------------------
-- Server_Start_Listening
-- Purpose: Use to make the full connection on the three sockets used
-- for AADLInspector<>Cheddar communication (ACK,DATA,COMMAND).
-- Use Connect and Initialize procedures, bind the socket IO to
-- the specified channel.
---------------------------------------------------------------------
procedure Server_Start_Listening
(Addr : in String;
Port : in Port_Type;
Socket : in out Socket_Type;
Channel : in out GNAT.Sockets.Stream_Access);
---------------------------------------------------------------------
-- Sockets_Initialization
-- Purpose: Initialize the three sockets used to communicate with
-- AADLInspector.
---------------------------------------------------------------------
procedure Initialize_Sockets;
---------------------------------------------------------------------
-- Start_State_Communication
-- Run_State_Communication
-- End_State_Communication
--
-- Purpose: They're aiming to receive commands from the client and
-- send an acknowledgment message on receive.
-- Three functions are used currently because between the three
-- states (Before simulation, During simulation and at the end of
-- the simulation when the last time is reached) differents
-- commands can be received and are handled differently.
-- TODO::Factoriser
--------------------------------------------------------------------
procedure Command_Communication
(Slice_Size : in out Natural;
Last_Time_Mod : in out Natural;
Speed : in out Duration;
SpeedFactor : in Duration;
Exit_Simulation : in out Boolean);
procedure Command_Start_State_Communication
(Slice_Size : in out Natural;
Last_Time_Mod : in out Natural;
Speed : in out Duration;
SpeedFactor : in Duration;
Exit_Simulation : in out Boolean);
procedure Command_Run_State_Communication
(Slice_Size : in out Natural;
Last_Time_Mod : in out Natural;
Speed : in out Duration;
SpeedFactor : in Duration;
Exit_Simulation : in out Boolean);
procedure Command_End_State_Communication
(Slice_Size : in out Natural;
Last_Time_Mod : in out Natural;
Speed : in out Duration;
SpeedFactor : in Duration;
Exit_Simulation : in out Boolean);
---------------------------------------------------------------------
-- Write_Channel
-- Purpose: Write data on the specified socket channel.
-- Extra: This procedure assume that the communication is between
-- Ada programs or betwenn programs in Ada and in different languages
-- but implementing the protocol used by Gnat.Sockets.
--
-- [See 'Read' procedure Documentation for Issue]
---------------------------------------------------------------------
procedure Write_Channel
(Channel : in out GNAT.Sockets.Stream_Access;
Data : in Unbounded_String);
end Sockets_Overlay;
|