summaryrefslogtreecommitdiff
path: root/cesar/cp2/cco/action/cco_conn/cco_action.h
blob: 76e838356171ee25401e921ee996b105cb7d6cff (plain)
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
#ifndef cp_cco_action_h
#define cp_cco_action_h
/* Cesar project {{{
 *
 * Copyright (C) 2008 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    cp_cco_action.h
 * \brief   « brief description »
 * \ingroup « module »
 *
 * « long description »
 */
#include "cp2/mme.h"
#include "lib/list.h"
#include "cp2/conn/conn.h"

/**
 * - Functions reacting to incoming MME related to global connection.
 * - Treatment of those MME - Storage and validation of the global connections
 * - Control of the Bandwidth Manager's actions - React to the connections'
 * states to send IND or CNF MME
 */
struct cp_cco_action_conn_t
{
    cp_conn_cspec_t *proposed_cspec;
};
typedef struct cp_cco_action_conn_t cp_cco_action_conn_t;

/**
 * Checks the states of the connections. If then need to be warned of changes
 * on their allocation this function will do so.
 * \param  ctx  Control Plane Context
 *
 * Checks the states of the connections allocation status.
 */
void
cp_cco_action_mme_glink_send (cp_t *ctx);

/**
 * Process a CC_LINK_NEW.
 * \param  ctx  Control Plane Context
 * \param  mme  Incoming mme
 *
 * Check the validity of the connection. Add the connection into
 * the list of connections and the pending allocation list Call the bandwidth
 * manager to redo the schedule  Call cp_cco_action_mme_conn_cnf()
 */
void
cp_cco_action_process_cc_link_new_req (cp_t* ctx, cp_mme_rx_t* mme);

/*Managed by sta action :*/
void
cp_cco_action_process_cc_link_new_cnf (cp_t* ctx, cp_mme_rx_t* mme);

/**
 * Process a CC_LINK_REL.
 * \param  ctx  Control Plane Context
 * \param  mme  Incoming mme
 *
 * Release the connection from the connections list and the pending
 * allocation list Send the MME that will release the connection Call
 * the bandwidth manager to redo the schedule
 */
void
cp_cco_action_process_cc_link_rel_req (cp_t* ctx, cp_mme_rx_t* mme);

/*Managed by sta action :*/
void
cp_cco_action_process_cc_link_rel_ind (cp_t* ctx, cp_mme_rx_t* mme);

/**
 * Process a CC_LINK_MOD.
 * \param  ctx  Control Plane Context
 * \param  mme  Incoming mme
 *
 * Check the validity of the modifications Modify the connection's
 * data Call the schedule function Check if the connection is still in
 * the schedule Send the MME CNF with the result
 */
void
cp_cco_action_process_cc_link_mod_req (cp_t* ctx, cp_mme_rx_t* mme);

/*Managed by sta action :*/
void
cp_cco_action_process_cc_link_mod_cnf (cp_t* ctx, cp_mme_rx_t* mme);

/**
 * Process a CC_ALLOC_MOVE.
 * \param  ctx  Control Plane Context
 * \param  mme  Incoming mme
 *
 * Check the validity of the connection. Memorise the position of
 * the allocation Call the function that can allocate a unique connection.
 * If it has allocated it somewhere else we delete the old allocation
 * if not we keep the old allocation Send the MME CNF with the result
 * Add the connection into the list of connections and the pending allocation
 * list Call the bandwidth manager to redo the schedule  Call cp_cco_action_mme_conn_cnf()
 */
void
cp_cco_action_process_cc_alloc_move_req (cp_t* ctx, cp_mme_rx_t* mme);

/*Managed by sta action :*/
void
cp_cco_action_process_cc_alloc_move_cnf (cp_t* ctx, cp_mme_rx_t* mme);

/**
 * Process of a CC_BLE_UPDATE.
 * \param  ctx  Control Plane Context.
 * \param  mme  Incoming MME
 *
 * IND. Actualisation of the BLE of a specific GLID. Call the Bandwidth
 * Manager to redo the schedule
 */
void
cp_cco_action_process_cc_ble_update_ind (cp_t* ctx, cp_mme_rx_t* mme);

/**
 * Init function of the CCo.
 * \param  ctx  Control Plane Context.
 *
 */
void
cp_cco_action_init (cp_t* ctx);

/**
 * Uninit the cco action module (call the uninit function of lower ctx).
 * \param  ctx  Control Plane Context.
 *
 */
void
cp_cco_action_uninit (cp_t *ctx);

/*****************************/
/*    STUBBED FUNCTIONS      */
/*****************************/

/*****************************/
/****      LINK NEW       ****/
/*****************************/

struct cp_msg_cc_link_new_req_t
{
    /** Mac address of the initiating STA */
    mac_t osa;

    /** Mac address of the terminating STA */
    mac_t oda;

    /** Connection identifier  */
    u16 cid;

    /** Forward BLE */
    list_t ble_f;

    /** Reverse BLE */
    list_t ble_r;

    /** CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_new_req_t cp_msg_cc_link_new_req_t;

struct cp_msg_cc_link_new_cnf_t
{
    /** Connection identifier */
    u16 cid;

    /** Forward GLID */
    u8 glid_f;

    /** Reverse GLID */
    u8 glid_r;

    /** Result */
    u8 result;

    /** Proposed CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_new_cnf_t cp_msg_cc_link_new_cnf_t;

void
cp_msg_cc_link_new_req_send(cp_t *ctx,
                            cp_mme_peer_t peer,
                            cp_msg_cc_link_new_req_t *data);
bool
cp_msg_cc_link_new_req_receive(cp_t *ctx,
                               cp_mme_rx_t *mme,
                               cp_msg_cc_link_new_req_t *data);

void
cp_msg_cc_link_new_cnf_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_new_cnf_t *data);

bool
cp_msg_cc_link_new_cnf_receive(cp_t *ctx,
                               cp_mme_rx_t *mme,
                               cp_msg_cc_link_new_cnf_t *data);

/*****************************/
/****      LINK REL       ****/
/*****************************/

struct cp_msg_cc_link_rel_req_t
{
    /** Connection identifier */
    u16 cid;

    /** TEI of the requesting STA */
    u8 tei;

    /** Reason code */
    u8 reason_code;

    /** Violated CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_rel_req_t cp_msg_cc_link_rel_req_t;

struct cp_msg_cc_link_rel_ind_t
{
    /** Connection identifier */
    u16 cid;

    /** MAC address of the STA requesting the release */
    mac_t mac;

    /** Reason code */
    u8 reason_code;

    /** Proposed CSPEC */
    cp_conn_cspec_t *cspec_proposed;

    /** Violated CSPEC */
    cp_conn_cspec_t *cspec_violated;
};
typedef struct cp_msg_cc_link_rel_ind_t cp_msg_cc_link_rel_ind_t;

void
cp_msg_cc_link_rel_req_send(cp_t *ctx,
                            cp_mme_peer_t peer,
                            cp_msg_cc_link_rel_req_t *data);

bool
cp_msg_cc_link_rel_req_receive(cp_t *ctx,
                               cp_mme_rx_t *mme,
                               cp_msg_cc_link_rel_req_t *data);

void
cp_msg_cc_link_rel_ind_send(cp_t *ctx,
                            cp_mme_peer_t peer,
                            cp_msg_cc_link_rel_ind_t *data);

bool
cp_msg_cc_link_rel_ind_receive(cp_t *ctx,
                               cp_mme_rx_t *mme,
                               cp_msg_cc_link_rel_ind_t *data);

/*****************************/
/****      LINK MOD       ****/
/*****************************/

struct cp_msg_cc_link_mod_req_t
{
    /** Connection identifier */
    u16 cid;

    /** CSPEC */
    cp_conn_cspec_t *cspec;

    /** Forward ble */
    list_t ble_f;

    /** Reversr ble */
    list_t ble_r;
};
typedef struct cp_msg_cc_link_mod_req_t cp_msg_cc_link_mod_req_t;

struct cp_msg_cc_link_mod_cnf_t
{
    /** Connection identifier */
    u16 cid;

    /** Result */
    u8 result;

    /** Proposed CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_mod_cnf_t cp_msg_cc_link_mod_cnf_t;

void
cp_msg_cc_link_mod_req_send(cp_t *ctx,
                            cp_mme_peer_t peer,
                            cp_msg_cc_link_mod_req_t *data);

bool
cp_msg_cc_link_mod_req_receive(cp_t *ctx,
                                 cp_mme_rx_t *mme,
                                 cp_msg_cc_link_mod_req_t *data);

void
cp_msg_cc_link_mod_cnf_send(cp_t *ctx,
                            cp_mme_peer_t peer,
                            cp_msg_cc_link_mod_cnf_t *data);

bool
cp_msg_cc_link_mod_cnf_receive(cp_t *ctx,
                               cp_mme_rx_t *mme,
                               cp_msg_cc_link_mod_cnf_t *data);
/*************************/
/***    LINK INFO      ***/
/*************************/

struct cp_msg_cc_link_info_req_t
{
    /**  */

    /** CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_info_req_t cp_msg_cc_link_info_req_t;

struct cp_msg_cc_link_info_cnf_t
{
    /**  */

    /** CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_info_cnf_t cp_msg_cc_link_info_cnf_t;

struct cp_msg_cc_link_info_ind_t
{
    /**  */

    /** CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_info_ind_t cp_msg_cc_link_info_ind_t;

struct cp_msg_cc_link_info_rsp_t
{
    /**  */

    /** CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_info_rsp_t cp_msg_cc_link_info_rsp_t;

void
cp_msg_cc_link_info_req_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_info_req_t *data);

bool
cp_msg_cc_link_info_req_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_info_req_t *data);

void
cp_msg_cc_link_info_cnf_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_info_cnf_t *data);

bool
cp_msg_cc_link_info_cnf_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_info_cnf_t *data);

void
cp_msg_cc_link_info_ind_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_info_ind_t *data);

bool
cp_msg_cc_link_info_ind_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_info_ind_t *data);

void
cp_msg_cc_link_info_rsp_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_info_rsp_t *data);

bool
cp_msg_cc_link_info_rsp_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_info_rsp_t *data);

/*****************************/
/****      LINK SQZ       ****/
/*****************************/

struct cp_msg_cc_link_sqz_req_t
{
    /** Connection identifier */
    u16 cid;

    /** Modified CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_sqz_req_t cp_msg_cc_link_sqz_req_t;

struct cp_msg_cc_link_sqz_cnf_t
{
    /** Connection identifier */
    u16 cid;

    /** Result */
    u8 result;

    /** Proposed CSPEC */
    cp_conn_cspec_t *cspec;
};
typedef struct cp_msg_cc_link_sqz_cnf_t cp_msg_cc_link_sqz_cnf_t;

void
cp_msg_cc_link_sqz_req_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_sqz_req_t *data);

bool
cp_msg_cc_link_sqz_req_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_sqz_req_t *data);
void
cp_msg_cc_link_sqz_cnf_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_link_sqz_cnf_t *data);
bool
cp_msg_cc_link_sqz_cnf_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_link_sqz_cnf_t *data);

/*****************************/
/****      BLE UPDATE     ****/
/*****************************/

struct cp_msg_cc_ble_update_ind_t
{
    /** GLID */
    u8 glid;

    /** BLE */
    list_t ble;
};
typedef struct cp_msg_cc_ble_update_ind_t cp_msg_cc_ble_update_ind_t;

void
cp_msg_cc_ble_update_ind_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_ble_update_ind_t *data);
bool
cp_msg_cc_ble_update_ind_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_ble_update_ind_t *data);

/*****************************/
/****      ALLOC MOVE     ****/
/*****************************/

struct cp_msg_cc_alloc_move_req_t
{
    /** Connection identifier */
    u16 cid;

    /** Forward GLID */
    u8 glid_f;

    /** Reverse GLID */
    u8 glid_r;

    /** Forward BLE */
    list_t ble_f;

    /** Reverse BLE */
    list_t ble_r;
};
typedef struct cp_msg_cc_alloc_move_req_t cp_msg_cc_alloc_move_req_t;

struct cp_msg_cc_alloc_move_cnf_t
{
    /** Connection identifier */
    u16 cid;

    /** Result */
    u8 result;
};
typedef struct cp_msg_cc_alloc_move_cnf_t cp_msg_cc_alloc_move_cnf_t;

void
cp_msg_cc_alloc_move_req_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_alloc_move_req_t *data);

bool
cp_msg_cc_alloc_move_req_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_alloc_move_req_t *data);
void
cp_msg_cc_alloc_move_cnf_send(cp_t *ctx,
                             cp_mme_peer_t peer,
                             cp_msg_cc_alloc_move_cnf_t *data);
bool
cp_msg_cc_alloc_move_cnf_receive(cp_t *ctx,
                                cp_mme_rx_t *mme,
                                cp_msg_cc_alloc_move_cnf_t *data);

#endif /* cp_cco_action_h */