sync/gen_statemachine.ysl2
author Volker Birk <vb@pep.foundation>
Sun, 21 Oct 2018 17:54:01 +0200
branchsync
changeset 3089 95d63a8d69bf
parent 3062 4ab13f23726f
child 3117 5614d2aeb84e
permissions -rw-r--r--
more error handling
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
vb@2870
   137
vb@2870
   138
            // conditions
vb@2870
   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@2870
   144
vb@2870
   145
            // actions
vb@2870
   146
vb@2870
   147
            ||
vb@2870
   148
            for "func:distinctName(*//action)"
vb@2870
   149
                | PEP_STATUS «@name»(PEP_SESSION session);
vb@2870
   150
            ||
vb@2870
   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@2870
   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@2870
   166
vb@2870
   167
            // receive message and store it in state
vb@2870
   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
                );
krista@2271
   173
        
vb@2870
   174
            // state machine driver
vb@2870
   175
            // if fsm or event set to 0 use fields in src if present
krista@2271
   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
                );
krista@2271
   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@2834
   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@2888
   200
                    size_t size
vb@2888
   201
                );
vb@2829
   202
vb@2870
   203
            #ifdef __cplusplus
vb@2870
   204
            }
vb@2870
   205
            #endif
vb@2829
   206
vb@2870
   207
            ||
vb@2829
   208
        }
vb@2829
   209
vb@2870
   210
        document "generated/{@name}_impl.c", "text" {
vb@2870
   211
            ||
vb@2870
   212
            // This file is under GNU General Public License 3.0
vb@2870
   213
            // see LICENSE.txt
vb@2870
   214
        
vb@2870
   215
            #include "«@name»_impl.h"
vb@2870
   216
            #include "pEp_internal.h"
vb@2870
   217
            #include "«@name»_event.h"
vb@2899
   218
            #include "«yml:lcase(@name)»_codec.h"
vb@2870
   219
            #include "baseprotocol.h"
vb@2870
   220
            `` for "fsm" | #include "«@name»_fsm.h"
vb@2829
   221
vb@2909
   222
            `` apply "fsm", 0, mode=timeout
vb@2870
   223
            PEP_STATUS «@name»_driver(
vb@2870
   224
                    PEP_SESSION session,
vb@2870
   225
                    «@name»_PR fsm,
vb@2870
   226
                    int event
vb@2870
   227
                )
vb@2870
   228
            {
vb@2910
   229
                assert(session);
vb@2910
   230
                if (!session)
vb@2870
   231
                    return PEP_ILLEGAL_VALUE;
vb@2829
   232
vb@2909
   233
                switch (fsm) {
vb@2910
   234
                    case None:
vb@2910
   235
                        if (!event) {
vb@2910
   236
                            // timeout occured
vb@2910
   237
                        `` for "fsm" |>>>> «../@name»_driver(session, «../@name»_PR_«yml:lcase(@name)», None);
vb@2910
   238
                            return PEP_STATUS_OK;
vb@2910
   239
                        }
vb@2910
   240
                        return PEP_ILLEGAL_VALUE;
vb@2910
   241
vb@2909
   242
                    `` apply "fsm", mode=reset_state_machine;
vb@2909
   243
                    default:
vb@2909
   244
                        return PEP_ILLEGAL_VALUE;
vb@2909
   245
                }
vb@2909
   246
vb@2870
   247
                int next_state = None;
vb@2870
   248
                do {
vb@2870
   249
                    switch (fsm) {
vb@2870
   250
                        `` apply "fsm", 3, mode=driver               
vb@2870
   251
                        default:
vb@2870
   252
                            return PEP_ILLEGAL_VALUE;
vb@2870
   253
                    }
vb@2870
   254
                }  while (next_state);
vb@2829
   255
vb@2870
   256
                return PEP_STATUS_OK;
vb@2829
   257
            }
vb@2829
   258
vb@2880
   259
            PEP_STATUS signal_«@name»_event(
vb@2870
   260
                    PEP_SESSION session, 
vb@2870
   261
                    «@name»_PR fsm,
vb@2870
   262
                    int event
vb@2870
   263
                )
vb@2870
   264
            {
vb@2870
   265
                «@name»_t *msg = NULL;
vb@2870
   266
                «@name»_event_t *ev = NULL;
vb@2870
   267
vb@2870
   268
                assert(session && fsm > 0 && event > None);
vb@2870
   269
                if (!(session && fsm > 0 && event > None))
vb@2870
   270
                    return PEP_ILLEGAL_VALUE;
vb@2870
   271
vb@2870
   272
                PEP_STATUS status = PEP_STATUS_OK;
vb@2870
   273
vb@2888
   274
                if (!session->inject_«yml:lcase(@name)»_event)
vb@2888
   275
                   return PEP_«yml:ucase(@name)»_NO_INJECT_CALLBACK;
vb@2870
   276
vb@2870
   277
                if (event < Extra) {
vb@2870
   278
                    msg = new_«@name»_message(fsm, event);
vb@2870
   279
                    if (!msg) {
vb@2870
   280
                        status = PEP_OUT_OF_MEMORY;
vb@2888
   281
                        goto the_end;
vb@2870
   282
                    }
vb@2870
   283
vb@2870
   284
                    status = update_«@name»_message(session, msg);
vb@2870
   285
                    if (status)
vb@2888
   286
                        goto the_end;
vb@2870
   287
                }
vb@2870
   288
vb@2888
   289
                ev = new_«@name»_event(fsm, event, msg);
vb@2870
   290
                if (!ev) {
vb@2870
   291
                    status = PEP_OUT_OF_MEMORY;
vb@2888
   292
                    goto the_end;
vb@2870
   293
                }
vb@2870
   294
vb@2870
   295
                int result = session->inject_«yml:lcase(@name)»_event(ev,
vb@2870
   296
                        session->«yml:lcase(@name)»_management);
vb@2870
   297
                if (result) {
vb@2870
   298
                    status = PEP_STATEMACHINE_ERROR;
vb@2888
   299
                    goto the_end;
vb@2870
   300
                }
vb@2888
   301
                return PEP_STATUS_OK;
vb@2870
   302
vb@2870
   303
            the_end:
vb@2888
   304
                free_«@name»_event(ev);
vb@2888
   305
                free_«@name»_message(msg);
vb@2870
   306
                return status;
vb@2870
   307
            }
vb@2870
   308
vb@2888
   309
            PEP_STATUS signal_«@name»_message(
vb@2870
   310
                    PEP_SESSION session, 
vb@2888
   311
                    PEP_rating rating,
vb@2888
   312
                    const char *data,
vb@2888
   313
                    size_t size
vb@2870
   314
                )
vb@2870
   315
            {
vb@2888
   316
                assert(session && data && size);
vb@2888
   317
                if (!(session && data && size))
vb@2870
   318
                    return PEP_ILLEGAL_VALUE;
vb@2870
   319
vb@2888
   320
                if (!session->inject_«yml:lcase(@name)»_event)
vb@2888
   321
                   return PEP_«yml:ucase(@name)»_NO_INJECT_CALLBACK;
vb@2870
   322
vb@2888
   323
                «@name»_t *msg = NULL;
vb@2888
   324
                PEP_STATUS status = decode_«@name»_message(data, size, &msg);
vb@2888
   325
                if (status)
vb@2888
   326
                    return status;
vb@2888
   327
vb@2890
   328
                «@name»_event_t *ev = NULL;
vb@2890
   329
vb@2890
   330
                switch (msg->present) {
vb@2890
   331
                    `` apply "fsm", 2, mode=signal_message
vb@2890
   332
                    default:
vb@2890
   333
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2890
   334
                        goto the_end;
vb@2890
   335
                }
vb@2890
   336
vb@2890
   337
                ev = new_«@name»_event(None, None, msg);
vb@2888
   338
                if (!ev) {
vb@2829
   339
                    status = PEP_OUT_OF_MEMORY;
vb@2888
   340
                    goto the_end;
vb@2829
   341
                }
vb@2829
   342
vb@2888
   343
                int result = session->inject_«yml:lcase(@name)»_event(ev,
vb@2888
   344
                        session->«yml:lcase(@name)»_management);
vb@2888
   345
                if (result) {
vb@2888
   346
                    status = PEP_STATEMACHINE_ERROR;
vb@2888
   347
                    goto the_end;
vb@2888
   348
                }
vb@2888
   349
                return PEP_STATUS_OK;
vb@2870
   350
vb@2870
   351
            the_end:
vb@2888
   352
                free_«@name»_event(ev);
vb@2888
   353
                free_«@name»_message(msg);
vb@2870
   354
                return status;
vb@2829
   355
            }
vb@2829
   356
vb@2870
   357
            PEP_STATUS send_«@name»_message(
vb@2870
   358
                    PEP_SESSION session, 
vb@2870
   359
                    «@name»_PR fsm,
vb@2870
   360
                    int message_type
vb@2870
   361
                )
vb@2870
   362
            {
vb@2870
   363
                PEP_STATUS status = PEP_STATUS_OK;
vb@2829
   364
vb@2870
   365
                assert(session && fsm > None && message_type > None);
vb@2870
   366
                if (!(session && fsm > None && message_type > None))
vb@2870
   367
                    return PEP_ILLEGAL_VALUE;
vb@2870
   368
                
vb@2870
   369
                «@name»_t *msg = new_«@name»_message(fsm, message_type);
vb@2870
   370
                if (!msg)
vb@2870
   371
                    return PEP_OUT_OF_MEMORY;
vb@2870
   372
vb@2870
   373
                char *data = NULL;
vb@2870
   374
                message *m = NULL;
vb@2870
   375
                identity_list *channels = NULL;
vb@2870
   376
vb@2870
   377
                status = update_«@name»_message(session, msg);
vb@2870
   378
                if (status)
vb@2870
   379
                    goto the_end;
vb@2870
   380
vb@2870
   381
                size_t size = 0;
vb@2870
   382
                status = encode_«@name»_message(msg, &data, &size);
vb@2870
   383
                if (status)
vb@2870
   384
                    goto the_end;
vb@2870
   385
vb@2870
   386
                switch (message_type) {
vb@2871
   387
                    // these messages are being broadcasted
vb@2877
   388
                    `` for "fsm/message[@type='broadcast']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2871
   389
                        status = _own_identities_retrieve(session, &channels, PEP_idf_not_for_«yml:lcase(@name)»);
vb@2875
   390
                        if (status)
vb@2870
   391
                            goto the_end;
vb@2871
   392
vb@2871
   393
                        if (!(channels && channels->ident)) {
vb@2871
   394
                            status = PEP_«yml:ucase(@name)»_NO_CHANNEL;
vb@2871
   395
                            goto the_end;
vb@2871
   396
                        }
vb@2870
   397
                        break;
vb@2870
   398
vb@2877
   399
                    // these go anycast; previously used address is sticky (unicast)
vb@2877
   400
                    `` for "fsm/message[@type='anycast']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2870
   401
                        if (!session->«yml:lcase(@name)»_state.common.from `> |`|
vb@2870
   402
                            (session->«yml:lcase(@name)»_state.common.from->flags &
vb@2871
   403
                            PEP_idf_not_for_«yml:lcase(@name)»)) {
vb@2870
   404
vb@2870
   405
                            // no address available yet, try to find one
vb@2871
   406
                            status = _own_identities_retrieve(session, &channels, PEP_idf_not_for_«yml:lcase(@name)»);
vb@2870
   407
                            if (!status)
vb@2870
   408
                                goto the_end;
vb@2870
   409
                            break;
vb@2870
   410
vb@2870
   411
                            if (channels && channels->ident) {
vb@2870
   412
                                // only need the first one
vb@2870
   413
                                free_identity_list(channels->next);
vb@2870
   414
                                channels->next = NULL;
vb@2870
   415
                            }
vb@2870
   416
                            else {
vb@2871
   417
                                status = PEP_«yml:ucase(@name)»_NO_CHANNEL;
vb@2870
   418
                                goto the_end;
vb@2870
   419
                            }
vb@2870
   420
                        }
vb@2870
   421
                        else {
vb@2870
   422
                            pEp_identity *channel = identity_dup(session->«yml:lcase(@name)»_state.common.from);
vb@2870
   423
                            if (!channel) {
vb@2870
   424
                                status = PEP_OUT_OF_MEMORY;
vb@2870
   425
                                goto the_end;
vb@2870
   426
                            }
vb@2870
   427
vb@2870
   428
                            channels = new_identity_list(channel);
vb@2870
   429
                            if (!channels) {
vb@2870
   430
                                status = PEP_OUT_OF_MEMORY;
vb@2870
   431
                                goto the_end;
vb@2870
   432
                            }
vb@2870
   433
                        }
vb@2877
   434
vb@2877
   435
                    default:
vb@2877
   436
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2877
   437
                        goto the_end;
vb@2870
   438
                }
vb@2870
   439
vb@2870
   440
                for (identity_list *li = channels; li && li->ident ; li = li->next) {
vb@2878
   441
                    message *_m = NULL;
vb@2944
   442
                    char *_data = NULL;
vb@2944
   443
                    
vb@2944
   444
                    _data = malloc(size);
vb@2944
   445
                    assert(_data);
vb@2944
   446
                    if (!_data) {
vb@2944
   447
                        status = PEP_OUT_OF_MEMORY;
vb@2944
   448
                        goto the_end;
vb@2944
   449
                    }
vb@2944
   450
                    memcpy(_data, data, size);
vb@2870
   451
                    status = base_prepare_message(
vb@2870
   452
                            li->ident,
vb@2870
   453
                            li->ident,
vb@2944
   454
                            _data,
vb@2870
   455
                            size,
vb@2878
   456
                            &_m
vb@2870
   457
                        );
vb@2944
   458
                    if (status) {
vb@2944
   459
                        free(_data);
vb@2870
   460
                        goto the_end;
vb@2944
   461
                    }
vb@2875
   462
vb@2878
   463
                    switch (message_type) {
vb@2878
   464
                    `` for "fsm/message[@security='unencrypted']" |>>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2878
   465
                            m = _m;
vb@2878
   466
                            break;
vb@2878
   467
vb@2878
   468
                        default:
vb@2878
   469
                            status = encrypt_message(session, _m, NULL, &m, PEP_enc_PEP, 0);
vb@2879
   470
                            if (status) {
vb@2899
   471
                                status = PEP_«yml:ucase(@name)»_CANNOT_ENCRYPT;
vb@2878
   472
                                goto the_end;
vb@2879
   473
                            }
vb@2878
   474
                            free_message(_m);
vb@2878
   475
                    }
vb@2878
   476
vb@2899
   477
                    status = session->messageToSend(m);
vb@2870
   478
                    m = NULL;
vb@2870
   479
                }
vb@2870
   480
vb@2870
   481
            the_end:
vb@2870
   482
                free_identity_list(channels);
vb@2870
   483
                free_message(m);
vb@2870
   484
                free(data);
vb@2870
   485
                free_«@name»_message(msg);
vb@2870
   486
                return status;
vb@2829
   487
            }
vb@2829
   488
vb@2870
   489
            PEP_STATUS recv_«@name»_event(
vb@2870
   490
                    PEP_SESSION session,
vb@2870
   491
                    «@name»_event_t *ev
vb@2870
   492
                )
vb@2870
   493
            {
vb@2870
   494
                assert(session && ev);
vb@2870
   495
                if (!(session && ev))
vb@2870
   496
                    return PEP_ILLEGAL_VALUE;
vb@2829
   497
vb@2870
   498
                PEP_STATUS status = PEP_STATUS_OK;
vb@2888
   499
                «@name»_PR fsm = (int) None;
vb@2888
   500
                int event = None;
vb@2829
   501
vb@2910
   502
                if (ev->event > None && ev->event < Extra) {
vb@2870
   503
                    status = update_«@name»_state(session, ev->msg, &fsm, &event);
vb@2870
   504
                    if (status)
vb@2888
   505
                        goto the_end;
vb@2829
   506
vb@2870
   507
                    if (ev->fsm) {
vb@2870
   508
                        if (ev->fsm != fsm |`> |` ev->event != event) {
vb@2870
   509
                            status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2888
   510
                            goto the_end;
vb@2870
   511
                        }
vb@2870
   512
                    }
vb@2888
   513
                    else if (ev->event) {
vb@2888
   514
                        status = PEP_«yml:ucase(@name)»_ILLEGAL_MESSAGE;
vb@2888
   515
                        goto the_end;
vb@2870
   516
                    }
vb@2870
   517
                }
vb@2888
   518
                else {
vb@2888
   519
                    fsm = ev->fsm;
vb@2888
   520
                    event = ev->event;
vb@2888
   521
                }
vb@2829
   522
vb@2888
   523
                status = «@name»_driver(session, fsm, event);
vb@2870
   524
vb@2888
   525
            the_end:
vb@2888
   526
                free_«@name»_event(ev);
vb@2870
   527
                return status;
vb@2829
   528
            }
vb@2829
   529
vb@2870
   530
            ||
vb@2829
   531
        }
vb@2829
   532
vb@2829
   533
        apply "fsm", 0, mode=gen;
vb@2829
   534
    }
vb@2829
   535
vb@2909
   536
    template "fsm", mode=timeout
vb@2909
   537
    ||
vb@2909
   538
    static bool _«@name»_timeout(int state)
vb@2909
   539
    {
vb@2909
   540
        static int last_state = None;
vb@2909
   541
        static time_t switch_time = 0;
vb@2909
   542
vb@2909
   543
        if (state > Init) {
vb@2909
   544
            if (state == last_state) {
vb@2909
   545
                if (time(NULL) - switch_time > «yml:ucase(@name)»_THRESHOLD) {
vb@2909
   546
                    last_state = None;
vb@2909
   547
                    switch_time = 0;
vb@2909
   548
                    return true;
vb@2909
   549
                }
vb@2909
   550
            }
vb@2909
   551
            else {
vb@2909
   552
                last_state = state;
vb@2909
   553
                switch_time = time(NULL);
vb@2909
   554
            }
vb@2909
   555
        }
vb@2909
   556
        else {
vb@2909
   557
            last_state = None;
vb@2909
   558
            switch_time = 0;
vb@2909
   559
        }
vb@2909
   560
vb@2909
   561
        return false;
vb@2909
   562
    }
vb@2909
   563
vb@2909
   564
    ||
vb@2909
   565
vb@2909
   566
    template "fsm", mode=reset_state_machine
vb@2909
   567
    ||
vb@2909
   568
        case «../@name»_PR_«yml:lcase(@name)»: {
vb@2909
   569
            int state = session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state;
vb@2909
   570
            switch (state) {
vb@2909
   571
                `` for "state[@name!='InitState' and @timeout != 'off']" |>>> case «@name»:
vb@2909
   572
                    if (_«@name»_timeout(state)) {
vb@2909
   573
                        session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state = Init;
vb@2909
   574
                        event = Init;
vb@2914
   575
                        `` if "@threshold > 0" |>>>>> «@name»TimeoutHandler(session);
vb@2909
   576
                    }
vb@2909
   577
                    break;
vb@2909
   578
                
vb@2909
   579
                default:
vb@2909
   580
                    _«@name»_timeout(None);
vb@2909
   581
            }
vb@2909
   582
            break;
vb@2909
   583
        }
vb@2909
   584
vb@2909
   585
    ||
vb@2909
   586
vb@2890
   587
    template "fsm", mode=signal_message
vb@2890
   588
    {
vb@2890
   589
        ||
vb@2890
   590
        case «../@name»_PR_«yml:lcase(@name)»:
vb@2890
   591
            switch (msg->choice.«yml:lcase(@name)».payload.present) {
vb@2891
   592
        ||
vb@2891
   593
        if "message[@security='unencrypted']" {
vb@2891
   594
            |         // these messages are going untested
vb@2891
   595
            for "message[@security='unencrypted']"
vb@2891
   596
                |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2891
   597
            ||
vb@2891
   598
                       break;
vb@2890
   599
vb@2891
   600
            ||
vb@2891
   601
        }
vb@2891
   602
        if "message[@security='untrusted']"
vb@2891
   603
        ||
vb@2890
   604
                // these messages must arrive encrypted
vb@2890
   605
        `` for "message[@security='untrusted']" |>> case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2890
   606
                    if (rating < PEP_rating_reliable) {
vb@2890
   607
                        status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   608
                        goto the_end;
vb@2890
   609
                    }
vb@2890
   610
                    break;
vb@2890
   611
vb@2891
   612
        ||
vb@2891
   613
        if "message[@security='trusted']"
vb@2891
   614
        ||
vb@2890
   615
                // these messages must come through a trusted channel
vb@2890
   616
        `` for "message[@security='trusted']" |>> case «ancestor::fsm/@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2890
   617
                    if (rating < PEP_rating_trusted) {
vb@2890
   618
                        status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   619
                        goto the_end;
vb@2890
   620
                    }
vb@2890
   621
                    break;
vb@2890
   622
vb@2890
   623
                default:
vb@2890
   624
                    status = PEP_«yml:ucase(ancestor::protocol/@name)»_ILLEGAL_MESSAGE;
vb@2890
   625
                    goto the_end;
vb@2890
   626
            }
vb@2890
   627
            break;
vb@2890
   628
vb@2890
   629
        ||
vb@2890
   630
    }
vb@2890
   631
vb@2838
   632
    template "fsm", mode=event
vb@2838
   633
    {
vb@2838
   634
    ||
vb@2843
   635
    case «../@name»_PR_«yml:lcase(@name)»: {
vb@2839
   636
        switch (msg->choice.«yml:lcase(@name)».payload.present) {
vb@2838
   637
    ||
vb@2838
   638
    for "message"
vb@2838
   639
    ||
vb@2838
   640
            case «../@name»__payload_PR_«yml:mixedCase(@name)»:
vb@2838
   641
                ev->event = «@name»;
vb@2838
   642
                break;
vb@2838
   643
    ||
vb@2838
   644
    ||
vb@2838
   645
            default:
vb@2838
   646
                // unknown message type
vb@2838
   647
                free(ev);
vb@2838
   648
                return NULL;
vb@2838
   649
        }
vb@2838
   650
        break;
vb@2838
   651
    }
vb@2838
   652
vb@2838
   653
    ||
vb@2838
   654
    }
vb@2838
   655
vb@2829
   656
    template "fsm", mode=driver
vb@2829
   657
    ||
vb@2843
   658
    case «../@name»_PR_«yml:lcase(@name)»: {
vb@2839
   659
        int state = session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state;
vb@2839
   660
        next_state = fsm_«@name»(session, state, event);
vb@2838
   661
        if (next_state > None) {
vb@2838
   662
            session->«yml:lcase(../@name)»_state.«yml:lcase(@name)».state = next_state;
vb@2838
   663
            event = Init;
vb@2838
   664
        }
vb@2838
   665
        else if (next_state < None) {
vb@2829
   666
            return PEP_STATEMACHINE_ERROR - state;
vb@2838
   667
        }
vb@2829
   668
        break;
vb@2829
   669
    }
vb@2829
   670
vb@2829
   671
    ||
vb@2829
   672
vb@2829
   673
    template "fsm", mode=gen {
vb@2829
   674
        document "generated/{@name}_fsm.h", "text" {
vb@2829
   675
        ||
vb@2829
   676
        // This file is under GNU General Public License 3.0
vb@2829
   677
        // see LICENSE.txt
vb@2829
   678
vb@2829
   679
        #pragma once
vb@2829
   680
vb@2829
   681
        #include "«../@name»_impl.h"
vb@2829
   682
vb@2829
   683
        #ifdef __cplusplus
vb@2829
   684
        extern "C" {
vb@2829
   685
        #endif
vb@2829
   686
vb@2829
   687
        // state machine for «@name»
krista@2271
   688
krista@2271
   689
        // states
krista@2271
   690
krista@2271
   691
        typedef enum _«@name»_state {
vb@2829
   692
            «@name»_state_None = None,
vb@2829
   693
            «@name»_state_Init = Init,
vb@2829
   694
        ||
vb@2829
   695
        for "func:distinctName(state[not(@name='InitState')])"
vb@2829
   696
            |> «@name»`if "position()!=last()" > , `
vb@2829
   697
        ||
krista@2271
   698
        } «@name»_state;
krista@2271
   699
krista@2271
   700
        // events
krista@2271
   701
krista@2271
   702
        typedef enum _«@name»_event {
vb@2829
   703
            «@name»_event_None = None,
vb@2829
   704
            «@name»_event_Init = Init,
krista@2271
   705
        ||
vb@2829
   706
        for "func:distinctName(state/event[not(not(../../message/@name=@name))])" {
krista@2271
   707
            const "name", "@name";
vb@2829
   708
            |> «$name» = «/protocol/fsm/message[@name=$name]/@id»,
krista@2271
   709
        }
vb@2830
   710
        for "func:distinctName(state/event[not(not(../../external/@name=@name))])" {
vb@2830
   711
            const "name", "@name";
vb@2830
   712
            |> «$name» = «/protocol/fsm/external[@name=$name]/@id»,
vb@2830
   713
        }
vb@2829
   714
        |> «@name»_event_Extra = Extra,
vb@2830
   715
        for "func:distinctName(state/event[not(../../message/@name=@name or ../../external/@name=@name)])" {
vb@2829
   716
            if "@name!='Init'"
vb@2829
   717
                |> «@name»`if "position()!=last()" > , `
vb@2829
   718
        }
krista@2271
   719
        ||
krista@2271
   720
        } «@name»_event;
krista@2271
   721
vb@2829
   722
        // state machine
krista@2271
   723
vb@2829
   724
        const char *«@name»_state_name(int state);
vb@2881
   725
        const char *«@name»_event_name(int event);
krista@2271
   726
vb@2838
   727
        // the state machine function is returning the next state in case of a
vb@2838
   728
        // transition or None for staying
vb@2838
   729
krista@2271
   730
        «@name»_state fsm_«@name»(
krista@2271
   731
                PEP_SESSION session,
krista@2271
   732
                «@name»_state state,
vb@2829
   733
                «@name»_event event
krista@2271
   734
            );
krista@2271
   735
krista@2271
   736
        #ifdef __cplusplus
krista@2271
   737
        }
krista@2271
   738
        #endif
krista@2271
   739
krista@2271
   740
        ||
krista@2271
   741
        }
vb@2829
   742
vb@2829
   743
        document "generated/{@name}_fsm.c", "text" {
krista@2271
   744
        ||
vb@2829
   745
        // This file is under GNU General Public License 3.0
vb@2829
   746
        // see LICENSE.txt
krista@2271
   747
vb@2829
   748
        #include "«@name»_fsm.h"
vb@2847
   749
        #include <stdlib.h>
krista@2271
   750
vb@2829
   751
        const char *«@name»_state_name(int state)
vb@2829
   752
        {
vb@2829
   753
            switch (state) {
vb@2829
   754
                case End:
vb@2829
   755
                    return "End";
vb@2829
   756
                case None:
vb@2829
   757
                    return "None";
vb@2829
   758
                case Init:
vb@2829
   759
                    return "InitState";
vb@2829
   760
        ||
vb@2829
   761
        for "func:distinctName(state[not(@name='InitState')])" {
vb@2829
   762
            |>> case «@name»:
vb@2829
   763
            |>>> return "«@name»";
vb@2829
   764
        }
vb@2829
   765
        ||
vb@2829
   766
                default:
vb@2829
   767
                    return "unknown state";
vb@2829
   768
            }
vb@2829
   769
        }
krista@2271
   770
vb@2881
   771
        const char *«@name»_event_name(int event)
vb@2881
   772
        {
vb@2881
   773
            switch (event) {
vb@2881
   774
                case None:
vb@2881
   775
                    return "None";
vb@2881
   776
                case Init:
vb@2881
   777
                    return "Init";
vb@2881
   778
        ||
vb@2881
   779
        for "func:distinctName(state/event[not(@name='Init')])" {
vb@2881
   780
            |>> case «@name»:
vb@2881
   781
            |>>> return "«@name»";
vb@2881
   782
        }
vb@2881
   783
        ||
vb@2881
   784
                default:
vb@2881
   785
                    return "unknown event";
vb@2881
   786
            }
vb@2881
   787
        }
vb@2881
   788
vb@2881
   789
vb@2829
   790
        static char *_str(int n, bool hex)
vb@2829
   791
        {
vb@2829
   792
            char *buf = calloc(1, 24);
vb@2829
   793
            assert(buf);
vb@2829
   794
            if (!buf)
vb@2829
   795
                return NULL;
vb@2829
   796
vb@2829
   797
            if (hex)
vb@2829
   798
                snprintf(buf, 24, "%.4x", n);
vb@2829
   799
            else
vb@2829
   800
                snprintf(buf, 24, "%d", n);
vb@2829
   801
            return buf;
vb@2829
   802
        }
vb@2829
   803
vb@2829
   804
        #define «@name»_ERR_LOG(t, d) log_event(session, (t), "«@name»", (d), "error")
vb@2829
   805
vb@2829
   806
        static PEP_STATUS _«@name»_ERR_LOG_int(PEP_SESSION session, char *t, int n, bool hex)
vb@2829
   807
        {
vb@2829
   808
            char *_buf = _str(n, hex);
vb@2829
   809
            if (!_buf)
vb@2829
   810
                return PEP_OUT_OF_MEMORY;
vb@2829
   811
            PEP_STATUS status = «@name»_ERR_LOG(t, _buf);
vb@2829
   812
            free(_buf);
vb@2829
   813
            return status;
vb@2829
   814
        }
vb@2829
   815
vb@2829
   816
        #define «@name»_ERR_LOG_INT(t, n) _«@name»_ERR_LOG_int(session, (t), (n), false)
vb@2829
   817
        #define «@name»_ERR_LOG_HEX(t, n) _«@name»_ERR_LOG_int(session, (t), (n), true)
vb@2829
   818
vb@2829
   819
        #ifndef SERVICE_LOG
vb@2829
   820
        // SERVICE LOG is meant to check session->service_log in runtime config;
vb@2829
   821
        // for older engines log more than needed
vb@2829
   822
        #define SERVICE_LOG(session, t, n, d) log_event((session), (t), (n), (d), "service")
vb@2829
   823
        #endif 
vb@2829
   824
vb@2829
   825
        #define «@name»_SERVICE_LOG(t, d) SERVICE_LOG(session, (t), "«@name»", (d))
vb@2829
   826
vb@2829
   827
        «@name»_state fsm_«@name»(
krista@2271
   828
                PEP_SESSION session,
vb@2829
   829
                «@name»_state state,
vb@2829
   830
                «@name»_event event
krista@2271
   831
            )
krista@2271
   832
        {
krista@2271
   833
            assert(session);
krista@2271
   834
            if (!session)
vb@2829
   835
                return invalid_state;
krista@2271
   836
krista@2271
   837
            switch (state) {
vb@2829
   838
                case None:
vb@2838
   839
                    return «@name»_state_Init;
vb@2829
   840
                
vb@2829
   841
                `` apply "state", 2, mode=fsm
krista@2271
   842
                default:
vb@2838
   843
                    «@name»_ERR_LOG_INT("invalid state", state);
vb@2829
   844
                    return invalid_state;
krista@2271
   845
            }
vb@2829
   846
            
vb@2838
   847
            return None;
krista@2271
   848
        }
krista@2271
   849
krista@2271
   850
        ||
vb@2829
   851
        }
vb@2829
   852
    }
vb@2829
   853
    
vb@2829
   854
    template "state", mode=fsm {
vb@2829
   855
        choose {
vb@2829
   856
            when "@name='InitState'" | case «../@name»_state_Init:
vb@2829
   857
            otherwise | case «@name»:
vb@2829
   858
        }
vb@2829
   859
        ||
vb@2829
   860
            «../@name»_SERVICE_LOG("in state", "«@name»");
vb@2829
   861
vb@2829
   862
            switch (event) {
vb@2829
   863
                case None:
vb@2829
   864
                    «../@name»_SERVICE_LOG("received None event", "ignoring");
vb@2838
   865
                    break;
vb@2829
   866
     
vb@2838
   867
        ||
vb@2838
   868
        if "not(event[@name='Init'])"
vb@2838
   869
        ||
vb@2838
   870
                case Init:
vb@2838
   871
                    // nothing to do
vb@2838
   872
                    break;
vb@2838
   873
vb@2838
   874
        ||
vb@2838
   875
        ||
vb@2829
   876
                `` apply "event", 2, mode=fsm
vb@2829
   877
                default:
vb@2885
   878
                    // ignore events not handled here
vb@2885
   879
                    «../@name»_SERVICE_LOG("ignoring event", KeySync_event_name(event));
vb@2885
   880
                    break;
vb@2829
   881
            }
vb@2829
   882
            break;
vb@2829
   883
vb@2829
   884
        ||
krista@2271
   885
    }
krista@2271
   886
vb@2829
   887
    template "event", mode=fsm {
vb@2829
   888
        | case «@name»: {
vb@2865
   889
        if "condition|action|send" |> PEP_STATUS status;
vb@2829
   890
        if "condition" |> bool result = false;
vb@2865
   891
        if "condition|action|send" |
krista@2271
   892
        ||
vb@2829
   893
            «../../@name»_SERVICE_LOG("received event", "«@name»");
vb@2907
   894
            `` apply "transition|action|condition|else|send";
vb@2829
   895
        ||
vb@2829
   896
        if "name(*[last()])!='transition'" {
vb@2829
   897
            |
vb@2843
   898
            |> «../../@name»_SERVICE_LOG("remaining in state", "«../@name»");
vb@2829
   899
            |> break;
vb@2829
   900
        }
vb@2829
   901
        ||
vb@2829
   902
        }
vb@2829
   903
        
vb@2829
   904
        ||
vb@2829
   905
    }
vb@2829
   906
vb@2829
   907
    template "transition" {
vb@2865
   908
        const "fsm", "ancestor::fsm";
krista@2271
   909
        ||
krista@2271
   910
vb@2829
   911
        «$fsm/@name»_SERVICE_LOG("transition to state", "«@target»");
vb@2838
   912
        return «@target»;
krista@2271
   913
        ||
vb@2829
   914
    }
krista@2271
   915
vb@2865
   916
    template "send" {
vb@2865
   917
        const "fsm", "ancestor::fsm";
vb@2865
   918
        const "protocol", "ancestor::protocol";
vb@2865
   919
        ||
vb@2865
   920
vb@2865
   921
        «$fsm/@name»_SERVICE_LOG("send message", "«@name»");
vb@2865
   922
        status = send_«$protocol/@name»_message(session, «$fsm/@id», «$fsm/@name»__payload_PR_«yml:mixedCase(@name)»);
vb@3089
   923
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   924
            return out_of_memory;
vb@3089
   925
        if (status) {
vb@3089
   926
            «$fsm/@name»_ERR_LOG_HEX("sending «@name» failed", status);
vb@3089
   927
            return cannot_send;
vb@3089
   928
        }
vb@2865
   929
        ||
vb@2865
   930
    }
vb@2865
   931
vb@2829
   932
    template "action" {
vb@2865
   933
        const "fsm", "ancestor::fsm";
vb@2865
   934
        ||
vb@2829
   935
vb@2865
   936
        «$fsm/@name»_SERVICE_LOG("do action", "«@name»");
vb@2865
   937
        status = «@name»(session);
vb@3089
   938
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   939
            return out_of_memory;
vb@2829
   940
        if (status) {
vb@2829
   941
            «$fsm/@name»_ERR_LOG_HEX("executing action «@name»() failed", status);
vb@2829
   942
            return invalid_action;
krista@2271
   943
        }
krista@2271
   944
        ||
krista@2271
   945
    }
krista@2271
   946
vb@2829
   947
    template "condition" {
vb@2865
   948
        const "fsm", "ancestor::fsm";
krista@2271
   949
        ||
krista@2271
   950
vb@2829
   951
        status = «@name»(session, &result);
vb@3089
   952
        if (status == PEP_OUT_OF_MEMORY)
vb@3089
   953
            return out_of_memory;
vb@2829
   954
        if (status) {
vb@2829
   955
            «$fsm/@name»_ERR_LOG_HEX("computing condition «@name» failed", status);
vb@2829
   956
            return invalid_condition;
krista@2271
   957
        }
vb@2829
   958
        if (result) {
vb@2843
   959
            «$fsm/@name»_SERVICE_LOG("condition applies", "«@name»");
krista@2271
   960
        ||
vb@2907
   961
        apply "transition|action|condition|else|send";
vb@2907
   962
        | }
vb@2907
   963
    }
vb@2907
   964
vb@2907
   965
    template "else" {
vb@2907
   966
        if "not(name(preceding-sibling::*[last()]) = 'condition')"
vb@2907
   967
            error "else without if";
vb@2907
   968
vb@2907
   969
        | else {
vb@2907
   970
        |> «ancestor::fsm/@name»_SERVICE_LOG("condition does not apply", "«preceding-sibling::*[last()]/@name»");
vb@2907
   971
        apply "transition|action|condition|else|send";
krista@2271
   972
        | }
krista@2271
   973
    }
krista@2271
   974
}
krista@2271
   975