Skip to content

Commit 2bb79b1

Browse files
authored
Merge pull request #674 from eclipse-score/joho_harmonize_trlc_package_names
[requirements] harmonize trlc package names
2 parents 9841bcb + 12189b0 commit 2bb79b1

15 files changed

Lines changed: 122 additions & 124 deletions

score/message_passing/dependability/assumed_system/assumed_system_requirements.trlc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
*
1111
* SPDX-License-Identifier: Apache-2.0
1212
********************************************************************************/
13-
package MessagePassingSEooC
13+
package MessagePassing
1414

1515
import ScoreReq
1616

score/message_passing/dependability/requirements/component_requirements.trlc

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@
1010
*
1111
* SPDX-License-Identifier: Apache-2.0
1212
********************************************************************************/
13-
package MessagePassingComponent
13+
package MessagePassing
1414

1515
import ScoreReq
16-
import MessagePassingSEooC
1716

1817
///////////////////////////////
1918
// Component Requirements
@@ -25,29 +24,29 @@ section "System Requirements" {
2524
ScoreReq.CompReq SafetyCertifiedTransportMechanismUnderQNX {
2625
description = "On the QNX operating system, the message passing component shall use the QNX-message-passing as the underlying IPC mechanism."
2726
safety = ScoreReq.Asil.B
28-
derived_from = [MessagePassingSEooC.SafetyCertifiedTransportMechanism@1, MessagePassingSEooC.OSIndependentAPI@1]
27+
derived_from = [MessagePassing.SafetyCertifiedTransportMechanism@1, MessagePassing.OSIndependentAPI@1]
2928
version = 1
3029
}
3130

3231
ScoreReq.CompReq TransportMechanismOnLinux {
3332
description = "On the Linux operating system, the message passing component shall use unix domain-sockets as the underlying IPC mechanism."
3433
safety = ScoreReq.Asil.B
35-
derived_from = [MessagePassingSEooC.SafetyCertifiedTransportMechanism@1, MessagePassingSEooC.OSIndependentAPI@1]
34+
derived_from = [MessagePassing.SafetyCertifiedTransportMechanism@1, MessagePassing.OSIndependentAPI@1]
3635
version = 1
3736
}
3837

3938

4039
ScoreReq.CompReq OSProvidedSenderIdentity {
4140
description = "The message passing server shall be able to identify the sender of each received message by the sender's OS-provided user ID (UID)."
4241
safety = ScoreReq.Asil.B
43-
derived_from = [MessagePassingSEooC.ServerInterface@1]
42+
derived_from = [MessagePassing.ServerInterface@1]
4443
version = 1
4544
}
4645

4746
ScoreReq.CompReq UnforgableSenderIdentity {
4847
description = "The transport mechanism shall ensure that the UID used to identify a message, cannot be forged by the client."
4948
safety = ScoreReq.Asil.B
50-
derived_from = [MessagePassingSEooC.ServerInterface@1]
49+
derived_from = [MessagePassing.ServerInterface@1]
5150
version = 1
5251
}
5352

@@ -58,56 +57,56 @@ section "Behaviour Requirements" {
5857
ScoreReq.CompReq ServerCallbacksAreSequential {
5958
description = "The server shall serialize all callbacks belonging to the same server instance, such that no two such callbacks execute concurrently."
6059
safety = ScoreReq.Asil.B
61-
derived_from = [MessagePassingSEooC.ServerInterface@1]
60+
derived_from = [MessagePassing.ServerInterface@1]
6261
version = 1
6362
}
6463

6564
ScoreReq.CompReq ServerProcessesSinglePendingRequest {
6665
description = "The server shall not dispatch a new sent-with-reply message callback on a given `ServerConnection` until the preceding request has been replied to."
6766
safety = ScoreReq.Asil.B
68-
derived_from = [MessagePassingSEooC.SynchronousBidirectionalCommunication@1]
67+
derived_from = [MessagePassing.SynchronousBidirectionalCommunication@1]
6968
version = 1
7069
}
7170

7271
ScoreReq.CompReq ClientConnectionMaintainsStateMachine {
7372
description = "The `ClientConnection` shall maintain a state machine with the states `Starting`, `Ready`, `Stopping`, and `Stopped`."
7473
safety = ScoreReq.Asil.B
75-
derived_from = [MessagePassingSEooC.OSIndependentAPI@1]
74+
derived_from = [MessagePassing.OSIndependentAPI@1]
7675
version = 1
7776
}
7877

7978
ScoreReq.CompReq SynchronousSendBlocksUntilServerReceives {
8079
description = "The `ClientConnection` shall block the calling thread during a `Send` call until the message has been and accepted by the server's receive buffer, when no client-side send queue is configured."
8180
safety = ScoreReq.Asil.B
82-
derived_from = [MessagePassingSEooC.SynchronousUnidirectionalCommunication@1]
81+
derived_from = [MessagePassing.SynchronousUnidirectionalCommunication@1]
8382
version = 1
8483
}
8584

8685
ScoreReq.CompReq AsynchronousSendReturnsAfterLocalAcceptance {
8786
description = "The `ClientConnection` shall return from a Send call after the message has been accepted by the local message passing layer, when a client-side send queue is configured."
8887
safety = ScoreReq.Asil.B
89-
derived_from = [MessagePassingSEooC.AsynchronousUnidirectionalCommunication@1]
88+
derived_from = [MessagePassing.AsynchronousUnidirectionalCommunication@1]
9089
version = 1
9190
}
9291

9392
ScoreReq.CompReq SendWaitReplyBlocksUntilServerReply {
9493
description = "The ClientConnection shall block the calling thread during a SendWaitReply call until a reply from the server is received or an error is detected."
9594
safety = ScoreReq.Asil.B
96-
derived_from = [MessagePassingSEooC.SynchronousBidirectionalCommunication@1]
95+
derived_from = [MessagePassing.SynchronousBidirectionalCommunication@1]
9796
version = 1
9897
}
9998

10099
ScoreReq.CompReq MessageOrderPreservationPerConnection {
101100
description = "The message passing component shall deliver messages of the same delivery type from the same `IClientConnection` instance to the server in the order they were sent."
102101
safety = ScoreReq.Asil.B
103-
derived_from = [MessagePassingSEooC.PointToPointConnections@1]
102+
derived_from = [MessagePassing.PointToPointConnections@1]
104103
version = 1
105104
}
106105

107106
ScoreReq.CompReq SingleServerInstancePerServiceIdentifier {
108107
description = "The message passing component shall prevent more than one active `IServer` instance serves a any given service identifier at any point in time."
109108
safety = ScoreReq.Asil.B
110-
derived_from = [MessagePassingSEooC.PointToPointConnections@1]
109+
derived_from = [MessagePassing.PointToPointConnections@1]
111110
version = 1
112111
}
113112

@@ -118,70 +117,70 @@ section "API Requirements" {
118117
ScoreReq.CompReq IServerStartListeningAPI {
119118
description = "`IServer` shall provide a `StartListening` method that registers connection, disconnection, fire-and-forget message, and sent-with-reply message callbacks."
120119
safety = ScoreReq.Asil.B
121-
derived_from = [MessagePassingSEooC.ServerInterface@1]
120+
derived_from = [MessagePassing.ServerInterface@1]
122121
version = 1
123122
}
124123

125124
ScoreReq.CompReq IServerStopListeningAPI {
126125
description = "`IServer` shall provide a `StopListening` method that releases all registered callbacks and closes all active server connections."
127126
safety = ScoreReq.Asil.B
128-
derived_from = [MessagePassingSEooC.ServerInterface@1]
127+
derived_from = [MessagePassing.ServerInterface@1]
129128
version = 1
130129
}
131130

132131
ScoreReq.CompReq IClientConnectionSendAPI {
133132
description = "`IClientConnection` shall provide a Send method that accepts a byte-span message and transmits it to the server."
134133
safety = ScoreReq.Asil.B
135-
derived_from = [MessagePassingSEooC.SynchronousUnidirectionalCommunication@1]
134+
derived_from = [MessagePassing.SynchronousUnidirectionalCommunication@1]
136135
version = 1
137136
}
138137

139138
ScoreReq.CompReq IClientConnectionSendWaitReplyAPI {
140139
description = "`IClientConnection` shall provide a `SendWaitReply` method that accepts a message byte span and a reply buffer span and returns the received reply payload trimmed to its actual size."
141140
safety = ScoreReq.Asil.B
142-
derived_from = [MessagePassingSEooC.SynchronousBidirectionalCommunication@1]
141+
derived_from = [MessagePassing.SynchronousBidirectionalCommunication@1]
143142
version = 1
144143
}
145144

146145
ScoreReq.CompReq IClientConnectionSendWithCallbackAPI {
147146
description = "`IClientConnection` shall provide a `SendWithCallback` method that accepts a message byte span and a reply callback and returns after the message has been accepted by the local message passing layer."
148147
safety = ScoreReq.Asil.B
149-
derived_from = [MessagePassingSEooC.AsynchronousUnidirectionalCommunication@1]
148+
derived_from = [MessagePassing.AsynchronousUnidirectionalCommunication@1]
150149
version = 1
151150
}
152151

153152
ScoreReq.CompReq IServerConnectionReplyAPI {
154153
description = "`IServerConnection` shall provide a Reply method that accepts a byte-span message and delivers it as the reply to the pending REQUEST from the client."
155154
safety = ScoreReq.Asil.B
156-
derived_from = [MessagePassingSEooC.SynchronousBidirectionalCommunication@1]
155+
derived_from = [MessagePassing.SynchronousBidirectionalCommunication@1]
157156
version = 1
158157
}
159158

160159
ScoreReq.CompReq IServerConnectionNotifyAPI {
161160
description = "`IServerConnection` shall provide a `Notify` method that accepts a byte-span message and sends it as an asynchronous notification to the client."
162161
safety = ScoreReq.Asil.B
163-
derived_from = [MessagePassingSEooC.ServerInterface@1]
162+
derived_from = [MessagePassing.ServerInterface@1]
164163
version = 1
165164
}
166165

167166
ScoreReq.CompReq ClientFactoryCreateAPI {
168167
description = "`IClientFactory` shall provide a `Create` method that accepts a `ServiceProtocolConfig` and a `ClientConfig` and returns a new `IClientConnection` instance configured for the service specified by the `ServiceProtocolConfig`."
169168
safety = ScoreReq.Asil.B
170-
derived_from = [MessagePassingSEooC.OSIndependentAPI@1]
169+
derived_from = [MessagePassing.OSIndependentAPI@1]
171170
version = 1
172171
}
173172

174173
ScoreReq.CompReq ServerFactoryCreateAPI {
175174
description = "`IServerFactory` shall provide a `Create` method that accepts a `ServiceProtocolConfig` and a `ServerConfig` and returns a new `IServer` instance configured for the service specified by the `ServiceProtocolConfig`."
176175
safety = ScoreReq.Asil.B
177-
derived_from = [MessagePassingSEooC.OSIndependentAPI@1]
176+
derived_from = [MessagePassing.OSIndependentAPI@1]
178177
version = 1
179178
}
180179

181180
ScoreReq.CompReq IClientConnectionGetStateAPI {
182181
description = "`IClientConnection` shall provide a `GetState` method that returns the current connection state."
183182
safety = ScoreReq.Asil.B
184-
derived_from = [MessagePassingSEooC.OSIndependentAPI@1]
183+
derived_from = [MessagePassing.OSIndependentAPI@1]
185184
version = 1
186185
}
187186

@@ -192,28 +191,28 @@ section "Server Unit Requirements" {
192191
ScoreReq.CompReq ServerPreallocatesConnectionObjects {
193192
description = "The server shall preallocate memory for the number of `IServerConnection` objects specified by `ServerConfig::pre_alloc_connections` at construction time, without allocating additional memory for each incoming client connection."
194193
safety = ScoreReq.Asil.B
195-
derived_from = [MessagePassingSEooC.AllowsBoundedMonotonicMemoryAllocation@1]
194+
derived_from = [MessagePassing.AllowsBoundedMonotonicMemoryAllocation@1]
196195
version = 1
197196
}
198197

199198
ScoreReq.CompReq ServerRingBufferQueueSizeConfigurable {
200199
description = "The server shall implement the shared incoming message queue as a ring buffer with the number of slots equal to `ServerConfig::max_queued_sends`, configured at construction time."
201200
safety = ScoreReq.Asil.B
202-
derived_from = [MessagePassingSEooC.AllowsBoundedMonotonicMemoryAllocation@1]
201+
derived_from = [MessagePassing.AllowsBoundedMonotonicMemoryAllocation@1]
203202
version = 1
204203
}
205204

206205
ScoreReq.CompReq ServerConnectionRefusal {
207206
description = "The server shall enable the connection callback to reject an incoming client connection by returning an error, without establishing a server connection for the rejected client."
208207
safety = ScoreReq.Asil.B
209-
derived_from = [MessagePassingSEooC.ServerInterface@1]
208+
derived_from = [MessagePassing.ServerInterface@1]
210209
version = 1
211210
}
212211

213212
ScoreReq.CompReq ServerIConnectionHandlerDispatch {
214213
description = "The server shall invoke the `IConnectionHandler` virtual methods of the `UserData` object for a given `IServerConnection` in place of the server-wide callbacks, when the UserData holds an `IConnectionHandler` instance."
215214
safety = ScoreReq.Asil.B
216-
derived_from = [MessagePassingSEooC.ServerInterface@1]
215+
derived_from = [MessagePassing.ServerInterface@1]
217216
version = 1
218217
}
219218

@@ -225,50 +224,50 @@ ScoreReq.CompReq ClientConnectionSendQueuePreallocation {
225224
description = "The `ClientConnection` shall preallocate send queue storage for the number of asynchronous messages specified by `ClientConfig::max_queued_sends` at construction time."
226225
note = "This requirement is intended to ensure a design that avoids dynamic memory allocation for the send queue, after the construction."
227226
safety = ScoreReq.Asil.B
228-
derived_from = [MessagePassingSEooC.AllowsBoundedMonotonicMemoryAllocation@1]
227+
derived_from = [MessagePassing.AllowsBoundedMonotonicMemoryAllocation@1]
229228
version = 1
230229
}
231230

232231
ScoreReq.CompReq ClientConnectionSharedResourceEngineInjection {
233232
description = "The `ClientConnection` shall accept an `ISharedResourceEngine` instance as a constructor parameter, which shouldbe the exclusive provider forall shared resources."
234233
safety = ScoreReq.Asil.B
235-
derived_from = [MessagePassingSEooC.SingletonFreeImplementation@1]
234+
derived_from = [MessagePassing.SingletonFreeImplementation@1]
236235
version = 1
237236
}
238237

239238
ScoreReq.CompReq ClientConnectionMockInjectionForTesting {
240239
description = "The `ClientConnection` shall use the `ISharedResourceEngine` interface for all OS interactions."
241240
note="This enables injection of mock implementations for unit testing."
242241
safety = ScoreReq.Asil.B
243-
derived_from = [MessagePassingSEooC.AllowsResourceMockInjectionForTesting@1]
242+
derived_from = [MessagePassing.AllowsResourceMockInjectionForTesting@1]
244243
version = 1
245244
}
246245

247246
ScoreReq.CompReq ClientConnectionSendFailsWhenStopped {
248247
description = "The `ClientConnection` shall return an error for a Send call when the connection is in the `Stopped` state."
249248
safety = ScoreReq.Asil.B
250-
derived_from = [MessagePassingSEooC.SynchronousUnidirectionalCommunication@1]
249+
derived_from = [MessagePassing.SynchronousUnidirectionalCommunication@1]
251250
version = 1
252251
}
253252

254253
ScoreReq.CompReq ClientConnectionSendWaitReplyFailsWhenStopped {
255254
description = "The `ClientConnection` shall return an error for a `SendWaitReply` call when the connection is in the `Stopped` state."
256255
safety = ScoreReq.Asil.B
257-
derived_from = [MessagePassingSEooC.SynchronousBidirectionalCommunication@1]
256+
derived_from = [MessagePassing.SynchronousBidirectionalCommunication@1]
258257
version = 1
259258
}
260259

261260
ScoreReq.CompReq ClientConnectionSendWithCallbackFailsWhenStopped {
262261
description = "The `ClientConnection` shall return an error for a `SendWithCallback` call when the connection is in the `Stopped` state."
263262
safety = ScoreReq.Asil.B
264-
derived_from = [MessagePassingSEooC.AsynchronousUnidirectionalCommunication@1]
263+
derived_from = [MessagePassing.AsynchronousUnidirectionalCommunication@1]
265264
version = 1
266265
}
267266

268267
ScoreReq.CompReq ClientConnectionStateCallbackInvocation {
269268
description = "The `ClientConnection` shall invoke the registered `StateCallback` each time the connection state changes, passing the new state as the argument."
270269
safety = ScoreReq.Asil.B
271-
derived_from = [MessagePassingSEooC.OSIndependentAPI@1]
270+
derived_from = [MessagePassing.OSIndependentAPI@1]
272271
version = 1
273272
}
274273

score/message_passing/dependability/requirements/feature_requirements.trlc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
*
1111
* SPDX-License-Identifier: Apache-2.0
1212
********************************************************************************/
13-
package MessagePassingSEooC
13+
package MessagePassing
1414

1515
import ScoreReq
1616

@@ -22,77 +22,77 @@ import ScoreReq
2222
ScoreReq.FeatReq ServerInterface {
2323
description = "The message passing component shall provide a server interface that registers connection handlers and processes incoming requests."
2424
safety = ScoreReq.Asil.B
25-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
25+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
2626
version = 1
2727
}
2828

2929
ScoreReq.FeatReq OSIndependentAPI {
3030
description = "The message passing component shall provide an OS-independent API for OS-native IPC mechanisms."
3131
safety = ScoreReq.Asil.B
32-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
32+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
3333
version = 1
3434
}
3535

3636
ScoreReq.FeatReq SafetyCertifiedTransportMechanism {
3737
description = "The implementation under QNX shall use a safety-certified transport mechanism."
3838
safety = ScoreReq.Asil.B
39-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
39+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
4040
version = 1
4141
}
4242

4343
ScoreReq.FeatReq PointToPointConnections {
4444
description = "The message passing component shall support only point-to-point (1:1) connections between communication endpoints. N:M connections are explicitly excluded."
4545
safety = ScoreReq.Asil.B
46-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
46+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
4747
version = 1
4848
}
4949

5050
ScoreReq.FeatReq SmallDataLowLatencyCommunication {
5151
description = "The message passing component shall provide low-latency communication for small data between dedicated endpoints. "
5252
safety = ScoreReq.Asil.QM
53-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
53+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
5454
version = 1
5555
}
5656

5757
ScoreReq.FeatReq SynchronousUnidirectionalCommunication {
5858
description = "The communication shall support synchronous unidirectional message sending on a given connection. The send call blocks until the message has been transferred to the receiving side and a suitable handler has been identified."
5959
safety = ScoreReq.Asil.B
60-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
60+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
6161
version = 1
6262
}
6363

6464
ScoreReq.FeatReq SynchronousBidirectionalCommunication {
6565
description = "The communication shall support synchronous bidirectional request-response communication on a given connection. The send call blocks until a reply from the receiver has been received (SendWaitReply)."
6666
safety = ScoreReq.Asil.B
67-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
67+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
6868
version = 1
6969
}
7070

7171
ScoreReq.FeatReq AsynchronousUnidirectionalCommunication {
7272
description = "The communication shall support asynchronous unidirectional message sending, where the send call returns after the local message passing layer has accepted the message. No guarantee is provided that the message is delivered to or processed by the receiver."
7373
safety = ScoreReq.Asil.B
74-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
74+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
7575
version = 1
7676
}
7777

7878
ScoreReq.FeatReq SingletonFreeImplementation {
7979
description = "The Message Passing library design shall not use any singletons."
8080
note = "Since resource management and life-cycle of the singleton are hard to track."
8181
safety = ScoreReq.Asil.B
82-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
82+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
8383
version = 1
8484
}
8585

8686
ScoreReq.FeatReq AllowsBoundedMonotonicMemoryAllocation {
8787
description = "The Message Passing library design shall allow bounded monotonic memory allocation."
8888
safety = ScoreReq.Asil.B
89-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
89+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
9090
version = 1
9191
}
9292

9393
ScoreReq.FeatReq AllowsResourceMockInjectionForTesting {
9494
description = "The Message Passing library design shall allow resource mock injection for testing."
9595
safety = ScoreReq.Asil.B
96-
derived_from = [MessagePassingSEooC.SystemMessagingProtocol@1]
96+
derived_from = [MessagePassing.SystemMessagingProtocol@1]
9797
version = 1
9898
}

score/message_passing/dependability/safety_analysis/control_measures.trlc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
*
1111
* SPDX-License-Identifier: Apache-2.0
1212
********************************************************************************/
13-
package MessagePassingFMEA
13+
package MessagePassing
1414

1515
import ScoreReq
1616

0 commit comments

Comments
 (0)