sync/gen_statemachine.ysl2
author Volker Birk <vb@pep.foundation>
Tue, 20 Nov 2018 17:18:46 +0100
branchsync
changeset 3143 81c80e27cbf7
parent 3129 ad8aa4d09cf0
child 3144 334a6c3faacd
permissions -rw-r--r--
signing of beacons
krista@2271
     1
// This file is under GNU General Public License 3.0
krista@2271
     2
// see LICENSE.txt
krista@2271
     3
krista@2271
     4
// generate state machine code
krista@2271
     5
vb@2840
     6
// Copyleft (c) 2016 - 2018, p≡p foundation
krista@2271
     7
krista@2271
     8
// Written by Volker Birk
krista@2271
     9
krista@2271
    10
include yslt.yml2
krista@2271
    11
krista@2271
    12
tstylesheet {
krista@2271
    13
    include standardlib.ysl2
krista@2271
    14
    include ./functions.ysl2
krista@2271
    15
krista@2271
    16
    template "/protocol" {
vb@2838
    17
        document "generated/{@name}_event.h", "text"
vb@2838
    18
        ||
vb@2838
    19
        // This file is under GNU General Public License 3.0
vb@2838
    20
        // see LICENSE.txt
vb@2838
    21
vb@2838
    22
        #pragma once
vb@2838
    23
vb@2838
    24
        #include "dynamic_api.h"
vb@2838
    25
vb@2838
    26
        #ifdef __cplusplus
vb@2838
    27
        extern "C" {
vb@2838
    28
        #endif
vb@2838
    29
vb@3020
    30
        typedef struct «@name» «yml:ucase(@name)»;
vb@3020
    31
        typedef int «yml:ucase(@name)»_PR;
vb@2838
    32
vb@2847
    33
        typedef struct «@name»_event {
vb@3020
    34
            «yml:ucase(@name)»_PR fsm;
vb@2838
    35
            int event;
vb@3020
    36
            «yml:ucase(@name)» *msg;
vb@2838
    37
        } «@name»_event_t;
vb@2838
    38
vb@2838
    39
 
vb@2838
    40
        // new_«@name»_event() - allocate a new «@name»_event
vb@2838
    41
        //
vb@2838
    42
        //  parameters:
vb@2838
    43
        //      fsm (in)        finite state machine the event is for
vb@2838
    44
        //      event (in)      event or None
vb@2838
    45
        //      msg (in)        message to compute event from
vb@2838
    46
        //
vb@2838
    47
        //  return value:
vb@2838
    48
        //      pointer to new event or NULL in case of failure
vb@2838
    49
        //
vb@2838
    50
        //  caveat:
vb@2838
    51
        //      event must be valid for fsm or None
vb@2838
    52
        //      in case msg is given event will be calculated out of message
vb@2838
    53
vb@3020
    54
        «@name»_event_t *new_«@name»_event(«yml:ucase(@name)»_PR fsm, int event, «yml:ucase(@name)» *msg);
vb@2838
    55
vb@2910
    56
        #define «yml:ucase(@name)»_TIMEOUT_EVENT new_«@name»_event(«@name»_PR_NOTHING, 0, NULL);
vb@2910
    57
vb@2838
    58
vb@2838
    59
        // free_«@name»_event() - free memory occupied by event
vb@2838
    60
        //
vb@2838
    61
        //  parameters:
vb@2838
    62
        //      ev (in)         event to free
vb@2838
    63
vb@2899
    64
        void free_«@name»_event(«@name»_event_t *ev);
vb@2838
    65
vb@2838
    66
vb@2838
    67
        #ifdef __cplusplus
vb@2838
    68
        }
vb@2838
    69
        #endif
vb@2838
    70
vb@2838
    71
        ||
vb@2838
    72
vb@2838
    73
        document "generated/{@name}_event.c", "text"
vb@2838
    74
        ||
vb@2838
    75
        // This file is under GNU General Public License 3.0
vb@2838
    76
        // see LICENSE.txt
vb@2838
    77
vb@3062
    78
        #include "platform.h"
vb@3062
    79
vb@2838
    80
        #include "pEp_internal.h"
vb@2838
    81
        #include "«@name»_event.h"
vb@2838
    82
        #include "«@name»_func.h"
vb@2839
    83
        `` for "fsm" | #include "«@name»_fsm.h"
vb@2838
    84
vb@3020
    85
        «@name»_event_t *new_«@name»_event(«yml:ucase(@name)»_PR fsm, int event, «@name»_t *msg)
vb@2838
    86
        {
vb@2838
    87
            «@name»_event_t *ev = («@name»_event_t *) calloc(1, sizeof(«@name»_event_t));
vb@2838
    88
            assert(ev);
vb@2838
    89
            if (!ev)
vb@2838
    90
                return NULL;
vb@2838
    91
vb@2838
    92
            ev->fsm = fsm;
vb@2838
    93
            ev->event = event;
vb@2838
    94
            ev->msg = msg;
vb@2838
    95
vb@2838
    96
            if (msg) {
vb@2838
    97
                switch (fsm) {
vb@2838
    98
                    `` apply "fsm", 3, mode=event
vb@2838
    99
                    default:
vb@2838
   100
                        // unknown protocol
vb@2838
   101
                        free(ev);
vb@2838
   102
                        return NULL;
vb@2838
   103
                }
vb@2838
   104
            }
vb@2838
   105
vb@2838
   106
            return ev;
vb@2838
   107
        }
vb@2838
   108
vb@2899
   109
        void free_«@name»_event(«@name»_event_t *ev)
vb@2838
   110
        {
vb@2838
   111
            if (ev) {
vb@2838
   112
                free_«@name»_message(ev->msg);
vb@2838
   113
                free(ev);
vb@2838
   114
            }
vb@2838
   115
        }
vb@2838
   116
vb@2838
   117
        ||
vb@2838
   118
vb@2829
   119
        document "generated/{@name}_impl.h", "text" {
vb@2870
   120
            ||
vb@2870
   121
            // This file is under GNU General Public License 3.0
vb@2870
   122
            // see LICENSE.txt
krista@2271
   123
vb@2870
   124
            #pragma once
krista@2271
   125
vb@2870
   126
            #include "fsm_common.h"
vb@2889
   127
            #include "«@name»_event.h"
vb@2870
   128
            #include "message_api.h"
vb@3020
   129
            #include "../asn.1/«@name».h"
vb@2870
   130
            
vb@2909
   131
            #define «yml:ucase(@name)»_THRESHOLD «@threshold»
vb@2909
   132
            `` for "fsm" | #define «yml:ucase(@name)»_THRESHOLD «@threshold»
vb@2909
   133
vb@2870
   134
            #ifdef __cplusplus
vb@2870
   135
            extern "C" {
vb@2870
   136
            #endif
krista@2271
   137
vb@2870
   138
            // conditions
krista@2271
   139
vb@2870
   140
            ||
vb@2870
   141
            for "func:distinctName(*//condition)"
vb@2870
   142
                | PEP_STATUS «@name»(PEP_SESSION session, bool *result);
vb@2870
   143
            ||
vb@2834
   144
vb@2870
   145
            // actions
vb@2829
   146
vb@2870
   147
            ||
vb@2870
   148
            for "func:distinctName(*//action)"
vb@2870
   149
                | PEP_STATUS «@name»(PEP_SESSION session);
vb@2870
   150
            ||
vb@2829
   151
vb@2914
   152
            // timeout handler
vb@2914
   153
            
vb@2914
   154
            ||
vb@2914
   155
            for "fsm[@threshold > 0]"
vb@2914
   156
                | PEP_STATUS «@name»TimeoutHandler(PEP_SESSION session);
vb@2914
   157
            ||
vb@2914
   158
vb@2870
   159
            // send message about an event to communication partners using state
vb@2829
   160
vb@2870
   161
            PEP_STATUS send_«@name»_message(
vb@2870
   162
                    PEP_SESSION session, 
vb@2870
   163
                    «@name»_PR fsm,
vb@2870
   164
                    int message_type
vb@2870
   165
                );
vb@2829
   166
vb@2870
   167
            // receive message and store it in state
vb@2829
   168
vb@2870
   169
            PEP_STATUS recv_«@name»_event(
vb@2870
   170
                    PEP_SESSION session,
vb@2870
   171
                    «@name»_event_t *ev
vb@2870
   172
                );
vb@2870
   173
        
vb@2870
   174
            // state machine driver
vb@2870
   175
            // if fsm or event set to 0 use fields in src if present
vb@2829
   176
vb@2870
   177
            PEP_STATUS «@name»_driver(
vb@2870
   178
                    PEP_SESSION session,
vb@2870
   179
                    «@name»_PR fsm,
vb@2870
   180
                    int event
vb@2870
   181
                );
vb@2829
   182
vb@2888
   183
            // API being used by the engine internally
vb@2888
   184
vb@2888
   185
            // call this if you need to signal an external event
vb@2888
   186
vb@2880
   187
            PEP_STATUS signal_«@name»_event(
vb@2870
   188
                    PEP_SESSION session, 
vb@2870
   189
                    «@name»_PR fsm,
vb@2870
   190
                    int event
vb@2870
   191
                );
vb@2888
   192
            
vb@2889
   193
            // call this if you are a transport and are receiving
vb@2889
   194
            // a «@name» message
vb@2829
   195
vb@2888
   196
            PEP_STATUS signal_«@name»_message(
vb@2888
   197
                    PEP_SESSION session, 
vb@2888
   198
                    PEP_rating rating,
vb@2888
   199
                    const char *data,
vb@3143
   200
                    size_t size,
vb@3143
   201
                    const char *fpr
vb@2888
   202
                );
vb@2829
   203
vb@2870
   204
            #ifdef __cplusplus
vb@2870
   205
            }
vb@2870
   206
            #endif
vb@2829
   207
vb@2870
   208
            ||
vb@2829
   209
        }
vb@2829
   210
vb@2870
   211
        document "generated/{@name}_impl.c", "text" {
vb@2870
   212
            ||
vb@2870
   213
            // This file is under GNU General Public License 3.0
vb@2870
   214
            // see LICENSE.txt
vb@2870
   215
        
vb@2870
   216
            #include "«@name»_impl.h"
vb@2870
   217
            #include "pEp_internal.h"
vb@2870
   218
            #include "«@name»_event.h"
vb@2899
   219
            #include "«yml:lcase(@name)»_codec.h"
vb@2870
   220
            #include "baseprotocol.h"
vb@2870
   221
            `` for "fsm" | #include "«@name»_fsm.h"
vb@2829
   222
vb@2909
   223
            `` apply "fsm", 0, mode=timeout
vb@2870
   224
            PEP_STATUS «@name»_driver(
vb@2870
   225
                    PEP_SESSION session,
vb@2870
   226
                    «@name»_PR fsm,
vb@2870
   227
                    int event
vb@2870
   228
                )
vb@2870
   229
            {
vb@2910
   230
                assert(session);
vb@2910
   231
                if (!session)
vb@2870
   232
                    return PEP_ILLEGAL_VALUE;
vb@2829
   233
vb@2909
   234
                switch (fsm) {
vb@2910
   235
                    case None:
vb@2910
   236
                        if (!event) {
vb@2910
   237
                            // timeout occured
vb@2910
   238
                        `` for "fsm" |>>>> «../@name»_driver(session, «../@name»_PR_«yml:lcase(@name)», None);
vb@2910
   239
                            return PEP_STATUS_OK;
vb@2910
   240
                        }
vb@2910
   241
                        return PEP_ILLEGAL_VALUE;
vb@2910
   242
vb@2909
   243
                    `` apply "fsm", mode=reset_state_machine;
vb@2909
   244
                    default:
vb@2909
   245
                        return PEP_ILLEGAL_VALUE;
vb@2909
   246
                }
vb@2909
   247
vb@2870
   248
                int next_state = None;
vb@2870
   249
                do {
vb@2870
   250
                    switch (fsm) {
vb@2870
   251
                        `` apply "fsm", 3, mode=driver               
vb@2870
   252
                        default:
vb@2870
   253
                            return PEP_ILLEGAL_VALUE;
vb@2870
   254
                    }
vb@2870
   255
                }  while (next_state);
vb@2829
   256
vb@2870
   257
                return PEP_STATUS_OK;
vb@2829
   258
            }
vb@2829
   259
vb@2880
   260
            PEP_STATUS signal_«@name»_event(
vb@2870
   261
                    PEP_SESSION session, 
vb@2870
   262
                    «@name»_PR fsm,
vb@2870
   263
                    int event
vb@2870
   264
                )
vb@2870
   265
            {
vb@2870
   266
                «@name»_t *msg = NULL;
vb@2870
   267
                «@name»_event_t *ev = NULL;
vb@2870
   268
vb@2870
   269
                assert(session && fsm > 0 && event > None);
vb@2870
   270
                if (!(session && fsm > 0 && event > None))
vb@2870
   271
                    return PEP_ILLEGAL_VALUE;
vb@2870
   272
vb@2870
   273
                PEP_STATUS status = PEP_STATUS_OK;
vb@2870
   274
vb@2888
   275
                if (!session->inject_«yml:lcase(@name)»_event)
vb@2888
   276
                   return PEP_«yml:ucase(@name)»_NO_INJECT_CALLBACK;
vb@2870
   277
vb@2870
   278
                if (event < Extra) {
vb@2870
   279
                    msg = new_«@name»_message(fsm, event);
vb@2870
   280
                    if (!msg) {
vb@2870
   281
                        status = PEP_OUT_OF_MEMORY;
vb@2888
   282
                        goto the_end;
vb@2870
   283
                    }
vb@2870
   284
vb@2870
   285
                    status = update_«@name»_message(session, msg);
vb@2870
   286
                    if (status)
vb@2888
   287
                        goto the_end;
vb@2870
   288
                }
vb@2870
   289
vb@2888
   290
                ev = new_«@name»_event(fsm, event, msg);
vb@2870
   291
                if (!ev) {
vb@2870
   292
                    status = PEP_OUT_OF_MEMORY;
vb@2888
   293
                    goto the_end;
vb@2870
   294
                }
vb@2870
   295
vb@2870
   296
                int result = session->inject_«yml:lcase(@name)»_event(ev,
vb@2870
   297
                        session->«yml:lcase(@name)»_management);
vb@2870
   298
                if (result) {
vb@2870
   299
                    status = PEP_STATEMACHINE_ERROR;
vb@2888
   300
                    goto the_end;
vb@2870
   301
                }
vb@2888
   302
                return PEP_STATUS_OK;
vb@2870
   303
vb@2870
   304
            the_end:
vb@2888
   305
                free_«@name»_event(ev);
vb@2888
   306
                free_«@name»_message(msg);
vb@2870
   307
                return status;
vb@2870
   308
            }
vb@2870
   309
vb@2888
   310
            PEP_STATUS signal_«@name»_message(
vb@2870
   311
                    PEP_SESSION session, 
vb@2888
   312
                    PEP_rating rating,
vb@2888
   313
                    const char *data,
vb@3143
   314
                    size_t size,
vb@3143
   315
                    const char *fpr
vb@2870
   316
                )
vb@2870
   317
            {
vb@2888
   318
                assert(session && data && size);
vb@2888
   319
                if (!(session && data && size))
vb@2870
   320
                    return PEP_ILLEGAL_VALUE;
vb@2870
   321
vb@2888
   322
                if (!session->inject_«yml:lcase(@name)»_event)
vb@2888
   323
                   return PEP_«yml:ucase(@name)»_NO_INJECT_CALLBACK;
vb@2870
   324
vb@2888
   325
                «@name»_t *msg = NULL;
vb@2888
   326
                PEP_STATUS status = decode_«@name»_message(data, size, &msg);
vb@2888
   327
                if (status)
vb@2888
   328
                    return status;
vb@2888
   329
vb@2890
   330
                «@name»_event_t *ev = NULL;
vb@2890
   331
vb@3117
   332
                «@name»_PR fsm = msg->present;
vb@3118
   333
                int event = 0;
vb@3117
   334
vb@3117
   335
                switch (fsm) {
vb@2890
   336
                    `` apply "fsm", 2, mode=signal_message
vb@2890
   337
                    default:
vb@2890
   338
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2890
   339
                        goto the_end;
vb@2890
   340
                }
vb@2890
   341
vb@3143
   342
                if (session->«yml:lcase(@name)»_state.common.from->fpr)
vb@3143
   343
                    free(session->«yml:lcase(@name)»_state.common.from->fpr);
vb@3143
   344
                session->«yml:lcase(@name)»_state.common.from->fpr = strdup(fpr);
vb@3143
   345
                assert(session->«yml:lcase(@name)»_state.common.from->fpr);
vb@3143
   346
                if (!session->«yml:lcase(@name)»_state.common.from->fpr) {
vb@3143
   347
                    status = PEP_OUT_OF_MEMORY;
vb@3143
   348
                    goto the_end;
vb@3143
   349
                }
vb@3143
   350
vb@3117
   351
                ev = new_«@name»_event(fsm, event, msg);
vb@2888
   352
                if (!ev) {
vb@2829
   353
                    status = PEP_OUT_OF_MEMORY;
vb@2888
   354
                    goto the_end;
vb@2829
   355
                }
vb@2829
   356
vb@2888
   357
                int result = session->inject_«yml:lcase(@name)»_event(ev,
vb@2888
   358
                        session->«yml:lcase(@name)»_management);
vb@2888
   359
                if (result) {
vb@2888
   360
                    status = PEP_STATEMACHINE_ERROR;
vb@2888
   361
                    goto the_end;
vb@2888
   362
                }
vb@3143
   363
vb@2888
   364
                return PEP_STATUS_OK;
vb@2868
   365
vb@2870
   366
            the_end:
vb@2888
   367
                free_«@name»_event(ev);
vb@2888
   368
                free_«@name»_message(msg);
vb@2870
   369
                return status;
vb@2868
   370
            }
vb@2841
   371
vb@2870
   372
            PEP_STATUS send_«@name»_message(
vb@2870
   373
                    PEP_SESSION session, 
vb@2870
   374
                    «@name»_PR fsm,
vb@2870
   375
                    int message_type
vb@2870
   376
                )
vb@2870
   377
            {
vb@2870
   378
                PEP_STATUS status = PEP_STATUS_OK;
vb@2870
   379
vb@2870
   380
                assert(session && fsm > None && message_type > None);
vb@2870
   381
                if (!(session && fsm > None && message_type > None))
vb@2870
   382
                    return PEP_ILLEGAL_VALUE;
vb@2870
   383
                
vb@2870
   384
                «@name»_t *msg = new_«@name»_message(fsm, message_type);
vb@2870
   385
                if (!msg)
vb@2870
   386
                    return PEP_OUT_OF_MEMORY;
vb@2870
   387
vb@2870
   388
                char *data = NULL;
vb@2870
   389
                message *m = NULL;
vb@2870
   390
                identity_list *channels = NULL;
vb@2870
   391
vb@2870
   392
                status = update_«@name»_message(session, msg);
vb@2870
   393
                if (status)
vb@2870
   394
                    goto the_end;
vb@2870
   395
vb@2870
   396
                size_t size = 0;
vb@2870
   397
                status = encode_«@name»_message(msg, &data, &size);
vb@2870
   398
                if (status)
vb@2870
   399
                    goto the_end;
vb@2840
   400
vb@2870
   401
                switch (message_type) {
vb@2871
   402
                    // these messages are being broadcasted
vb@2877
   403
                    `` for "fsm/message[@type='broadcast']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2871
   404
                        status = _own_identities_retrieve(session, &channels, PEP_idf_not_for_«yml:lcase(@name)»);
vb@2875
   405
                        if (status)
vb@2870
   406
                            goto the_end;
vb@2871
   407
vb@2871
   408
                        if (!(channels && channels->ident)) {
vb@2871
   409
                            status = PEP_«yml:ucase(@name)»_NO_CHANNEL;
vb@2871
   410
                            goto the_end;
vb@2871
   411
                        }
vb@2870
   412
                        break;
vb@2829
   413
vb@2877
   414
                    // these go anycast; previously used address is sticky (unicast)
vb@2877
   415
                    `` for "fsm/message[@type='anycast']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2870
   416
                        if (!session->«yml:lcase(@name)»_state.common.from `> |`|
vb@2870
   417
                            (session->«yml:lcase(@name)»_state.common.from->flags &
vb@2871
   418
                            PEP_idf_not_for_«yml:lcase(@name)»)) {
vb@2870
   419
vb@2870
   420
                            // no address available yet, try to find one
vb@2871
   421
                            status = _own_identities_retrieve(session, &channels, PEP_idf_not_for_«yml:lcase(@name)»);
vb@2870
   422
                            if (!status)
vb@2870
   423
                                goto the_end;
vb@2870
   424
                            break;
vb@2829
   425
vb@2870
   426
                            if (channels && channels->ident) {
vb@2870
   427
                                // only need the first one
vb@2870
   428
                                free_identity_list(channels->next);
vb@2870
   429
                                channels->next = NULL;
vb@2870
   430
                            }
vb@2870
   431
                            else {
vb@2871
   432
                                status = PEP_«yml:ucase(@name)»_NO_CHANNEL;
vb@2870
   433
                                goto the_end;
vb@2870
   434
                            }
vb@2870
   435
                        }
vb@2870
   436
                        else {
vb@2870
   437
                            pEp_identity *channel = identity_dup(session->«yml:lcase(@name)»_state.common.from);
vb@2870
   438
                            if (!channel) {
vb@2870
   439
                                status = PEP_OUT_OF_MEMORY;
vb@2870
   440
                                goto the_end;
vb@2870
   441
                            }
vb@2829
   442
vb@2870
   443
                            channels = new_identity_list(channel);
vb@2870
   444
                            if (!channels) {
vb@2870
   445
                                status = PEP_OUT_OF_MEMORY;
vb@2870
   446
                                goto the_end;
vb@2870
   447
                            }
vb@2870
   448
                        }
vb@2877
   449
vb@2877
   450
                    default:
vb@2877
   451
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2877
   452
                        goto the_end;
vb@2829
   453
                }
vb@2870
   454
vb@2870
   455
                for (identity_list *li = channels; li && li->ident ; li = li->next) {
vb@2878
   456
                    message *_m = NULL;
vb@2944
   457
                    char *_data = NULL;
vb@2944
   458
                    
vb@2944
   459
                    _data = malloc(size);
vb@2944
   460
                    assert(_data);
vb@2944
   461
                    if (!_data) {
vb@2944
   462
                        status = PEP_OUT_OF_MEMORY;
vb@2944
   463
                        goto the_end;
vb@2944
   464
                    }
vb@2944
   465
                    memcpy(_data, data, size);
vb@2875
   466
vb@2878
   467
                    switch (message_type) {
vb@2878
   468
                    `` for "fsm/message[@security='unencrypted']" |>>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@3129
   469
                            status = base_prepare_message(
vb@3143
   470
                                    session,
vb@3129
   471
                                    li->ident,
vb@3129
   472
                                    li->ident,
vb@3129
   473
                                    _data,
vb@3129
   474
                                    size,
vb@3129
   475
                                    li->ident->fpr,
vb@3129
   476
                                    &_m
vb@3129
   477
                                );
vb@3129
   478
                            if (status) {
vb@3129
   479
                                free(_data);
vb@3129
   480
                                goto the_end;
vb@3129
   481
                            }
Thomas@3127
   482
                            attach_own_key(session, _m);
vb@2878
   483
                            m = _m;
vb@2878
   484
                            break;
vb@2878
   485
vb@2878
   486
                        default:
vb@3129
   487
                            status = base_prepare_message(
vb@3143
   488
                                    session,
vb@3129
   489
                                    li->ident,
vb@3129
   490
                                    li->ident,
vb@3129
   491
                                    _data,
vb@3129
   492
                                    size,
vb@3129
   493
                                    NULL,
vb@3129
   494
                                    &_m
vb@3129
   495
                                );
vb@3129
   496
                            if (status) {
vb@3129
   497
                                free(_data);
vb@3129
   498
                                goto the_end;
vb@3129
   499
                            }
vb@2878
   500
                            status = encrypt_message(session, _m, NULL, &m, PEP_enc_PEP, 0);
vb@2879
   501
                            if (status) {
vb@2899
   502
                                status = PEP_«yml:ucase(@name)»_CANNOT_ENCRYPT;
vb@2878
   503
                                goto the_end;
vb@2879
   504
                            }
vb@2878
   505
                            free_message(_m);
vb@2878
   506
                    }
vb@2878
   507
vb@2899
   508
                    status = session->messageToSend(m);
vb@2870
   509
                    m = NULL;
vb@2829
   510
                }
vb@2870
   511
vb@2870
   512
            the_end:
vb@2870
   513
                free_identity_list(channels);
vb@2870
   514
                free_message(m);
vb@2870
   515
                free(data);
vb@2870
   516
                free_«@name»_message(msg);
vb@2870
   517
                return status;
vb@2829
   518
            }
vb@2829
   519
vb@2870
   520
            PEP_STATUS recv_«@name»_event(
vb@2870
   521
                    PEP_SESSION session,
vb@2870
   522
                    «@name»_event_t *ev
vb@2870
   523
                )
vb@2870
   524
            {
vb@2870
   525
                assert(session && ev);
vb@2870
   526
                if (!(session && ev))
vb@2870
   527
                    return PEP_ILLEGAL_VALUE;
vb@2870
   528
vb@2870
   529
                PEP_STATUS status = PEP_STATUS_OK;
vb@2888
   530
                «@name»_PR fsm = (int) None;
vb@2888
   531
                int event = None;
vb@2870
   532
vb@2910
   533
                if (ev->event > None && ev->event < Extra) {
vb@2870
   534
                    status = update_«@name»_state(session, ev->msg, &fsm, &event);
vb@2870
   535
                    if (status)
vb@2888
   536
                        goto the_end;
vb@2829
   537
vb@2870
   538
                    if (ev->fsm) {
vb@2870
   539
                        if (ev->fsm != fsm |`> |` ev->event != event) {
vb@2870
   540
                            status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2888
   541
                            goto the_end;
vb@2870
   542
                        }
vb@2870
   543
                    }
vb@2888
   544
                    else if (ev->event) {
vb@2888
   545
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2888
   546
                        goto the_end;
vb@2870
   547
                    }
vb@2870
   548
                }
vb@2888
   549
                else {
vb@2888
   550
                    fsm = ev->fsm;
vb@2888
   551
                    event = ev->event;
vb@2888
   552
                }
vb@2870
   553
vb@2888
   554
                status = «@name»_driver(session, fsm, event);
vb@2870
   555
vb@2888
   556
            the_end:
vb@2888
   557
                free_«@name»_event(ev);
vb@2870
   558
                return status;
vb@2870
   559
            }
vb@2870
   560
vb@2870
   561
            ||
vb@2829
   562
        }
vb@2829
   563
vb@2829
   564
        apply "fsm", 0, mode=gen;
vb@2829
   565
    }
vb@2829
   566
vb@2909
   567
    template "fsm", mode=timeout
vb@2909
   568
    ||
vb@2909
   569
    static bool _«@name»_timeout(int state)
vb@2909
   570
    {
vb@2909
   571
        static int last_state = None;
vb@2909
   572
        static time_t switch_time = 0;
vb@2909
   573
vb@2909
   574
        if (state > Init) {
vb@2909
   575
            if (state == last_state) {
vb@2909
   576
                if (time(NULL) - switch_time > «yml:ucase(@name)»_THRESHOLD) {
vb@2909
   577
                    last_state = None;
vb@2909
   578
                    switch_time = 0;
vb@2909
   579
                    return true;
vb@2909
   580
                }
vb@2909
   581
            }
vb@2909
   582
            else {
vb@2909
   583
                last_state = state;
vb@2909
   584
                switch_time = time(NULL);
vb@2909
   585
            }
vb@2909
   586
        }
vb@2909
   587
        else {
vb@2909
   588
            last_state = None;
vb@2909
   589
            switch_time = 0;
vb@2909
   590
        }
vb@2909
   591
vb@2909
   592
        return false;
vb@2909
   593
    }
vb@2909
   594
vb@2909
   595
    ||
vb@2909
   596
vb@2909
   597
    template "fsm", mode=reset_state_machine
vb@2909
   598
    ||
vb@2909
   599
        case «../@name»_PR_«yml:lcase(@name)»: {
vb@2909
   600
            int state = session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state;
vb@2909
   601
            switch (state) {
vb@2909
   602
                `` for "state[@name!='InitState' and @timeout != 'off']" |>>> case «@name»:
vb@2909
   603
                    if (_«@name»_timeout(state)) {
vb@2909
   604
                        session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state = Init;
vb@2909
   605
                        event = Init;
vb@2914
   606
                        `` if "@threshold > 0" |>>>>> «@name»TimeoutHandler(session);
vb@2909
   607
                    }
vb@2909
   608
                    break;
vb@2909
   609
                
vb@2909
   610
                default:
vb@2909
   611
                    _«@name»_timeout(None);
vb@2909
   612
            }
vb@2909
   613
            break;
vb@2909
   614
        }
vb@2909
   615
vb@2909
   616
    ||
vb@2909
   617
vb@2890
   618
    template "fsm", mode=signal_message
vb@2890
   619
    {
vb@2890
   620
        ||
vb@2890
   621
        case «../@name»_PR_«yml:lcase(@name)»:
vb@3117
   622
            event = msg->choice.«yml:lcase(@name)».payload.present;
vb@3117
   623
            switch (event) {
vb@2891
   624
        ||
vb@2891
   625
        if "message[@security='unencrypted']" {
vb@2891
   626
            |         // these messages are going untested
vb@2891
   627
            for "message[@security='unencrypted']"
vb@2891
   628
                |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2891
   629
            ||
vb@3117
   630
                        break;
vb@2890
   631
vb@2891
   632
            ||
vb@2891
   633
        }
vb@2891
   634
        if "message[@security='untrusted']"
vb@2891
   635
        ||
vb@2890
   636
                // these messages must arrive encrypted
vb@2890
   637
        `` for "message[@security='untrusted']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2890
   638
                    if (rating < PEP_rating_reliable) {
vb@2890
   639
                        status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   640
                        goto the_end;
vb@2890
   641
                    }
vb@2890
   642
                    break;
vb@2890
   643
vb@2891
   644
        ||
vb@2891
   645
        if "message[@security='trusted']"
vb@2891
   646
        ||
vb@2890
   647
                // these messages must come through a trusted channel
vb@2890
   648
        `` for "message[@security='trusted']" |>> case «ancestor::fsm/@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2890
   649
                    if (rating < PEP_rating_trusted) {
vb@2890
   650
                        status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   651
                        goto the_end;
vb@2890
   652
                    }
vb@2890
   653
                    break;
vb@2890
   654
vb@2890
   655
                default:
vb@2890
   656
                    status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   657
                    goto the_end;
vb@2890
   658
            }
vb@2890
   659
            break;
vb@2890
   660
vb@2890
   661
        ||
vb@2890
   662
    }
vb@2890
   663
vb@2838
   664
    template "fsm", mode=event
vb@2838
   665
    {
vb@2838
   666
    ||
vb@2843
   667
    case «../@name»_PR_«yml:lcase(@name)»: {
vb@2839
   668
        switch (msg->choice.«yml:lcase(@name)».payload.present) {
vb@2838
   669
    ||
vb@2838
   670
    for "message"
vb@2838
   671
    ||
vb@2838
   672
            case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2838
   673
                ev->event = «@name»;
vb@2838
   674
                break;
vb@2838
   675
    ||
vb@2838
   676
    ||
vb@2838
   677
            default:
vb@2838
   678
                // unknown message type
vb@2838
   679
                free(ev);
vb@2838
   680
                return NULL;
vb@2838
   681
        }
vb@2838
   682
        break;
vb@2838
   683
    }
vb@2838
   684
vb@2838
   685
    ||
vb@2838
   686
    }
vb@2838
   687
vb@2829
   688
    template "fsm", mode=driver
vb@2829
   689
    ||
vb@2843
   690
    case «../@name»_PR_«yml:lcase(@name)»: {
vb@2839
   691
        int state = session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state;
vb@2839
   692
        next_state = fsm_«@name»(session, state, event);
vb@2838
   693
        if (next_state > None) {
vb@2838
   694
            session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state = next_state;
vb@2838
   695
            event = Init;
vb@2838
   696
        }
vb@2838
   697
        else if (next_state < None) {
vb@2829
   698
            return PEP_STATEMACHINE_ERROR - state;
vb@2838
   699
        }
vb@2829
   700
        break;
vb@2829
   701
    }
vb@2829
   702
vb@2829
   703
    ||
vb@2829
   704
vb@2829
   705
    template "fsm", mode=gen {
vb@2829
   706
        document "generated/{@name}_fsm.h", "text" {
vb@2829
   707
        ||
vb@2829
   708
        // This file is under GNU General Public License 3.0
vb@2829
   709
        // see LICENSE.txt
vb@2829
   710
vb@2829
   711
        #pragma once
vb@2829
   712
vb@2829
   713
        #include "«../@name»_impl.h"
vb@2829
   714
vb@2829
   715
        #ifdef __cplusplus
vb@2829
   716
        extern "C" {
vb@2829
   717
        #endif
vb@2829
   718
vb@2829
   719
        // state machine for «@name»
krista@2271
   720
krista@2271
   721
        // states
krista@2271
   722
krista@2271
   723
        typedef enum _«@name»_state {
vb@2829
   724
            «@name»_state_None = None,
vb@2829
   725
            «@name»_state_Init = Init,
vb@2829
   726
        ||
vb@2829
   727
        for "func:distinctName(state[not(@name='InitState')])"
vb@2829
   728
            |> «@name»`if "position()!=last()" > , `
vb@2829
   729
        ||
krista@2271
   730
        } «@name»_state;
krista@2271
   731
krista@2271
   732
        // events
krista@2271
   733
krista@2271
   734
        typedef enum _«@name»_event {
vb@2829
   735
            «@name»_event_None = None,
vb@2829
   736
            «@name»_event_Init = Init,
krista@2271
   737
        ||
vb@2829
   738
        for "func:distinctName(state/event[not(not(../../message/@name=@name))])" {
krista@2271
   739
            const "name", "@name";
vb@2829
   740
            |> «$name» = «/protocol/fsm/message[@name=$name]/@id»,
krista@2271
   741
        }
vb@2830
   742
        for "func:distinctName(state/event[not(not(../../external/@name=@name))])" {
vb@2830
   743
            const "name", "@name";
vb@2830
   744
            |> «$name» = «/protocol/fsm/external[@name=$name]/@id»,
vb@2830
   745
        }
vb@2829
   746
        |> «@name»_event_Extra = Extra,
vb@2830
   747
        for "func:distinctName(state/event[not(../../message/@name=@name or ../../external/@name=@name)])" {
vb@2829
   748
            if "@name!='Init'"
vb@2829
   749
                |> «@name»`if "position()!=last()" > , `
vb@2829
   750
        }
krista@2271
   751
        ||
krista@2271
   752
        } «@name»_event;
krista@2271
   753
vb@2829
   754
        // state machine
krista@2271
   755
vb@2829
   756
        const char *«@name»_state_name(int state);
vb@2881
   757
        const char *«@name»_event_name(int event);
krista@2271
   758
vb@2838
   759
        // the state machine function is returning the next state in case of a
vb@2838
   760
        // transition or None for staying
vb@2838
   761
krista@2271
   762
        «@name»_state fsm_«@name»(
krista@2271
   763
                PEP_SESSION session,
krista@2271
   764
                «@name»_state state,
vb@2829
   765
                «@name»_event event
krista@2271
   766
            );
krista@2271
   767
krista@2271
   768
        #ifdef __cplusplus
krista@2271
   769
        }
krista@2271
   770
        #endif
krista@2271
   771
krista@2271
   772
        ||
krista@2271
   773
        }
vb@2829
   774
vb@2829
   775
        document "generated/{@name}_fsm.c", "text" {
krista@2271
   776
        ||
vb@2829
   777
        // This file is under GNU General Public License 3.0
vb@2829
   778
        // see LICENSE.txt
vb@2829
   779
vb@2829
   780
        #include "«@name»_fsm.h"
vb@2847
   781
        #include <stdlib.h>
krista@2271
   782
vb@2829
   783
        const char *«@name»_state_name(int state)
vb@2829
   784
        {
vb@2829
   785
            switch (state) {
vb@2829
   786
                case End:
vb@2829
   787
                    return "End";
vb@2829
   788
                case None:
vb@2829
   789
                    return "None";
vb@2829
   790
                case Init:
vb@2829
   791
                    return "InitState";
vb@2829
   792
        ||
vb@2829
   793
        for "func:distinctName(state[not(@name='InitState')])" {
vb@2829
   794
            |>> case «@name»:
vb@2829
   795
            |>>> return "«@name»";
vb@2829
   796
        }
vb@2829
   797
        ||
vb@2829
   798
                default:
vb@2829
   799
                    return "unknown state";
vb@2829
   800
            }
vb@2829
   801
        }
vb@2829
   802
vb@2881
   803
        const char *«@name»_event_name(int event)
vb@2881
   804
        {
vb@2881
   805
            switch (event) {
vb@2881
   806
                case None:
vb@2881
   807
                    return "None";
vb@2881
   808
                case Init:
vb@2881
   809
                    return "Init";
vb@2881
   810
        ||
vb@2881
   811
        for "func:distinctName(state/event[not(@name='Init')])" {
vb@2881
   812
            |>> case «@name»:
vb@2881
   813
            |>>> return "«@name»";
vb@2881
   814
        }
vb@2881
   815
        ||
vb@2881
   816
                default:
vb@2881
   817
                    return "unknown event";
vb@2881
   818
            }
vb@2881
   819
        }
vb@2881
   820
vb@2881
   821
vb@2829
   822
        static char *_str(int n, bool hex)
vb@2829
   823
        {
vb@2829
   824
            char *buf = calloc(1, 24);
vb@2829
   825
            assert(buf);
vb@2829
   826
            if (!buf)
vb@2829
   827
                return NULL;
krista@2271
   828
vb@2829
   829
            if (hex)
vb@2829
   830
                snprintf(buf, 24, "%.4x", n);
vb@2829
   831
            else
vb@2829
   832
                snprintf(buf, 24, "%d", n);
vb@2829
   833
            return buf;
vb@2829
   834
        }
krista@2271
   835
vb@2829
   836
        #define «@name»_ERR_LOG(t, d) log_event(session, (t), "«@name»", (d), "error")
vb@2829
   837
vb@2829
   838
        static PEP_STATUS _«@name»_ERR_LOG_int(PEP_SESSION session, char *t, int n, bool hex)
vb@2829
   839
        {
vb@2829
   840
            char *_buf = _str(n, hex);
vb@2829
   841
            if (!_buf)
vb@2829
   842
                return PEP_OUT_OF_MEMORY;
vb@2829
   843
            PEP_STATUS status = «@name»_ERR_LOG(t, _buf);
vb@2829
   844
            free(_buf);
vb@2829
   845
            return status;
vb@2829
   846
        }
vb@2829
   847
vb@2829
   848
        #define «@name»_ERR_LOG_INT(t, n) _«@name»_ERR_LOG_int(session, (t), (n), false)
vb@2829
   849
        #define «@name»_ERR_LOG_HEX(t, n) _«@name»_ERR_LOG_int(session, (t), (n), true)
vb@2829
   850
vb@2829
   851
        #ifndef SERVICE_LOG
vb@2829
   852
        // SERVICE LOG is meant to check session->service_log in runtime config;
vb@2829
   853
        // for older engines log more than needed
vb@2829
   854
        #define SERVICE_LOG(session, t, n, d) log_event((session), (t), (n), (d), "service")
vb@2829
   855
        #endif 
vb@2829
   856
vb@2829
   857
        #define «@name»_SERVICE_LOG(t, d) SERVICE_LOG(session, (t), "«@name»", (d))
vb@2829
   858
vb@2829
   859
        «@name»_state fsm_«@name»(
krista@2271
   860
                PEP_SESSION session,
vb@2829
   861
                «@name»_state state,
vb@2829
   862
                «@name»_event event
krista@2271
   863
            )
krista@2271
   864
        {
krista@2271
   865
            assert(session);
krista@2271
   866
            if (!session)
vb@2829
   867
                return invalid_state;
krista@2271
   868
krista@2271
   869
            switch (state) {
vb@2829
   870
                case None:
vb@2838
   871
                    return «@name»_state_Init;
vb@2829
   872
                
vb@2829
   873
                `` apply "state", 2, mode=fsm
krista@2271
   874
                default:
vb@2838
   875
                    «@name»_ERR_LOG_INT("invalid state", state);
vb@2829
   876
                    return invalid_state;
krista@2271
   877
            }
vb@2829
   878
            
vb@2838
   879
            return None;
krista@2271
   880
        }
krista@2271
   881
krista@2271
   882
        ||
vb@2829
   883
        }
krista@2271
   884
    }
vb@2829
   885
    
vb@2829
   886
    template "state", mode=fsm {
vb@2829
   887
        choose {
vb@2829
   888
            when "@name='InitState'" | case «../@name»_state_Init:
vb@2829
   889
            otherwise | case «@name»:
vb@2829
   890
        }
krista@2271
   891
        ||
vb@2829
   892
            «../@name»_SERVICE_LOG("in state", "«@name»");
krista@2271
   893
vb@2829
   894
            switch (event) {
vb@2829
   895
                case None:
vb@2829
   896
                    «../@name»_SERVICE_LOG("received None event", "ignoring");
vb@2838
   897
                    break;
vb@2829
   898
     
vb@2838
   899
        ||
vb@2838
   900
        if "not(event[@name='Init'])"
vb@2838
   901
        ||
vb@2838
   902
                case Init:
vb@2838
   903
                    // nothing to do
vb@2838
   904
                    break;
vb@2838
   905
vb@2838
   906
        ||
vb@2838
   907
        ||
vb@2829
   908
                `` apply "event", 2, mode=fsm
vb@2829
   909
                default:
vb@2885
   910
                    // ignore events not handled here
vb@2885
   911
                    «../@name»_SERVICE_LOG("ignoring event", KeySync_event_name(event));
vb@2885
   912
                    break;
vb@2829
   913
            }
vb@2829
   914
            break;
krista@2271
   915
krista@2271
   916
        ||
vb@2829
   917
    }
vb@2829
   918
vb@2829
   919
    template "event", mode=fsm {
vb@2829
   920
        | case «@name»: {
vb@2865
   921
        if "condition|action|send" |> PEP_STATUS status;
vb@2829
   922
        if "condition" |> bool result = false;
vb@2865
   923
        if "condition|action|send" |
vb@2829
   924
        ||
vb@2829
   925
            «../../@name»_SERVICE_LOG("received event", "«@name»");
vb@2907
   926
            `` apply "transition|action|condition|else|send";
vb@2829
   927
        ||
vb@2829
   928
        if "name(*[last()])!='transition'" {
vb@2829
   929
            |
vb@2843
   930
            |> «../../@name»_SERVICE_LOG("remaining in state", "«../@name»");
vb@2829
   931
            |> break;
vb@2829
   932
        }
vb@2829
   933
        ||
vb@2829
   934
        }
vb@2829
   935
        
vb@2829
   936
        ||
vb@2829
   937
    }
vb@2829
   938
vb@2829
   939
    template "transition" {
vb@2865
   940
        const "fsm", "ancestor::fsm";
krista@2271
   941
        ||
krista@2271
   942
vb@2829
   943
        «$fsm/@name»_SERVICE_LOG("transition to state", "«@target»");
vb@2838
   944
        return «@target»;
krista@2271
   945
        ||
vb@2829
   946
    }
vb@2829
   947
vb@2865
   948
    template "send" {
vb@2865
   949
        const "fsm", "ancestor::fsm";
vb@2865
   950
        const "protocol", "ancestor::protocol";
vb@2865
   951
        ||
krista@2271
   952
vb@2865
   953
        «$fsm/@name»_SERVICE_LOG("send message", "«@name»");
vb@2865
   954
        status = send_«$protocol/@name»_message(session, «$fsm/@id», «$fsm/@name»__payload_PR_«yml:mixedCase(@name)»);
vb@3089
   955
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   956
            return out_of_memory;
vb@3089
   957
        if (status) {
vb@3089
   958
            «$fsm/@name»_ERR_LOG_HEX("sending «@name» failed", status);
vb@3089
   959
            return cannot_send;
vb@3089
   960
        }
vb@2865
   961
        ||
vb@2865
   962
    }
krista@2271
   963
vb@2865
   964
    template "action" {
vb@2865
   965
        const "fsm", "ancestor::fsm";
krista@2271
   966
        ||
vb@2865
   967
vb@2865
   968
        «$fsm/@name»_SERVICE_LOG("do action", "«@name»");
vb@2865
   969
        status = «@name»(session);
vb@3089
   970
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   971
            return out_of_memory;
vb@2829
   972
        if (status) {
vb@2829
   973
            «$fsm/@name»_ERR_LOG_HEX("executing action «@name»() failed", status);
vb@2829
   974
            return invalid_action;
krista@2271
   975
        }
krista@2271
   976
        ||
krista@2271
   977
    }
krista@2271
   978
vb@2829
   979
    template "condition" {
vb@2865
   980
        const "fsm", "ancestor::fsm";
krista@2271
   981
        ||
krista@2271
   982
vb@2829
   983
        status = «@name»(session, &result);
vb@3089
   984
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   985
            return out_of_memory;
vb@2829
   986
        if (status) {
vb@2829
   987
            «$fsm/@name»_ERR_LOG_HEX("computing condition «@name» failed", status);
vb@2829
   988
            return invalid_condition;
krista@2271
   989
        }
vb@2829
   990
        if (result) {
vb@2843
   991
            «$fsm/@name»_SERVICE_LOG("condition applies", "«@name»");
vb@2829
   992
        ||
vb@2907
   993
        apply "transition|action|condition|else|send";
vb@2907
   994
        | }
vb@2907
   995
    }
vb@2907
   996
vb@2907
   997
    template "else" {
vb@2907
   998
        if "not(name(preceding-sibling::*[last()]) = 'condition')"
vb@2907
   999
            error "else without if";
vb@2907
  1000
vb@2907
  1001
        | else {
vb@2907
  1002
        |> «ancestor::fsm/@name»_SERVICE_LOG("condition does not apply", "«preceding-sibling::*[last()]/@name»");
vb@2907
  1003
        apply "transition|action|condition|else|send";
krista@2271
  1004
        | }
krista@2271
  1005
    }
krista@2271
  1006
}
krista@2271
  1007