summaryrefslogtreecommitdiffstats
path: root/src/stateless/cp/trex_stream_vm.h
blob: 135047032e5459b43d3fd40b2a9912d392a72bb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
/*
 Itay Marom
 Cisco Systems, Inc.
*/

/*
Copyright (c) 2015-2015 Cisco Systems, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#ifndef __TREX_STREAM_VM_API_H__
#define __TREX_STREAM_VM_API_H__

#include <string>
#include <stdint.h>
#include <vector>
#include <unordered_map>
#include <assert.h>
#include <common/Network/Packet/IPHeader.h>
#include "pal_utl.h"
#include "mbuf.h"



//https://software.intel.com/en-us/articles/fast-random-number-generator-on-the-intel-pentiumr-4-processor/

//Used to seed the generator.
inline void fast_srand(uint32_t &g_seed, int seed ){
  g_seed = seed;
}


//fastrand routine returns one integer, similar output value range as C lib.

inline int fastrand(uint32_t &g_seed)
{
  g_seed = (214013*g_seed+2531011);
  return (g_seed>>16)&0x7FFF;
}         

static inline void vm_srand(uint32_t * per_thread_seed,uint64_t seedval)
{
    fast_srand( *per_thread_seed,seedval );
}

static inline uint32_t vm_rand16(uint32_t * per_thread_seed)
{
	return ( fastrand(*per_thread_seed));
}

static inline uint32_t vm_rand32(uint32_t * per_thread_seed)
{
	return ( (vm_rand16(per_thread_seed)<<16)+vm_rand16(per_thread_seed));
}

static inline uint64_t vm_rand64(uint32_t * per_thread_seed)
{
    uint64_t res;

    res=((uint64_t)vm_rand32(per_thread_seed)<<32)+vm_rand32(per_thread_seed);

    return (res);
}
                          

class StreamVm;


/* in memory program */

struct StreamDPOpFlowVar8 {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint8_t m_min_val;
    uint8_t m_max_val;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint8_t *p = (flow_var + m_flow_offset);
        if (*p == m_max_val) {
            *p = m_min_val;
        } else {
            *p = *p + 1;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint8_t *p = (flow_var + m_flow_offset);
        if (*p == m_min_val) {
            *p = m_max_val;
        } else {
            *p = *p - 1;
        }
    }

    inline void run_rand(uint8_t * flow_var,uint32_t *per_thread_random) {
        uint8_t * p=(flow_var+m_flow_offset);
        *p= m_min_val + (vm_rand16(per_thread_random)  % (int)(m_max_val - m_min_val + 1));
    }


} __attribute__((packed)) ;

struct StreamDPOpFlowVar16 {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint16_t m_min_val;
    uint16_t m_max_val;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint16_t *p = (uint16_t *)(flow_var + m_flow_offset);
        if (*p == m_max_val) {
            *p = m_min_val;
        } else {
            *p = *p + 1;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint16_t *p = (uint16_t *)(flow_var + m_flow_offset);
        if (*p == m_min_val) {
            *p = m_max_val;
        } else {
            *p = *p - 1;
        }
    }

    inline void run_rand(uint8_t * flow_var,uint32_t *per_thread_random) {
        uint16_t * p=(uint16_t *)(flow_var+m_flow_offset);
        *p= m_min_val + (vm_rand16(per_thread_random) % (int)(m_max_val - m_min_val + 1));
    }



} __attribute__((packed)) ;

struct StreamDPOpFlowVar32 {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint32_t m_min_val;
    uint32_t m_max_val;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint32_t *p = (uint32_t *)(flow_var + m_flow_offset);
        if (*p == m_max_val) {
            *p = m_min_val;
        } else {
            *p = *p + 1;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint32_t *p = (uint32_t *)(flow_var + m_flow_offset);
        if (*p == m_min_val) {
            *p = m_max_val;
        } else {
            *p = *p - 1;
        }
    }

    inline void run_rand(uint8_t * flow_var,uint32_t *per_thread_random) {
        uint32_t * p=(uint32_t *)(flow_var+m_flow_offset);
        *p= m_min_val + (vm_rand32(per_thread_random) % (int)(m_max_val - m_min_val + 1));
    }

} __attribute__((packed)) ;

struct StreamDPOpFlowVar64 {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint64_t m_min_val;
    uint64_t m_max_val;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint64_t *p = (uint64_t *)(flow_var + m_flow_offset);
        if (*p == m_max_val) {
            *p = m_min_val;
        } else {
            *p = *p + 1;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint64_t *p = (uint64_t *)(flow_var + m_flow_offset);
        if (*p == m_min_val) {
            *p = m_max_val;
        } else {
            *p = *p - 1;
        }
    }

    inline void run_rand(uint8_t * flow_var,uint32_t *per_thread_random) {
        uint64_t * p=(uint64_t *)(flow_var+m_flow_offset);
        *p= m_min_val + ( vm_rand64(per_thread_random)  % (int)(m_max_val - m_min_val + 1));
    }


} __attribute__((packed)) ;



struct StreamDPOpFlowVar8Step {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint8_t m_min_val;
    uint8_t m_max_val;
    uint8_t m_step;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint8_t *p = (flow_var + m_flow_offset);
        if (*p >= (m_max_val-m_step)) {
            *p = m_min_val;
        } else {
            *p = *p + m_step;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint8_t *p = (flow_var + m_flow_offset);
        if (*p <= (m_min_val+m_step)) {
            *p = m_max_val;
        } else {
            *p = *p - m_step;
        }
    }

} __attribute__((packed)) ;

struct StreamDPOpFlowVar16Step {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint16_t m_min_val;
    uint16_t m_max_val;
    uint16_t m_step;

public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint16_t *p = (uint16_t *)(flow_var + m_flow_offset);
        if (*p >= (m_max_val-m_step)) {
            *p = m_min_val;
        } else {
            *p = *p + m_step;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint16_t *p = (uint16_t *)(flow_var + m_flow_offset);
        if (*p <= (m_min_val+m_step)) {
            *p = m_max_val;
        } else {
            *p = *p - m_step;
        }
    }

} __attribute__((packed)) ;

struct StreamDPOpFlowVar32Step {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint32_t m_min_val;
    uint32_t m_max_val;
    uint32_t m_step;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint32_t *p = (uint32_t *)(flow_var + m_flow_offset);
        if (*p >= (m_max_val-m_step)) {
            *p = m_min_val;
        } else {
            *p = *p + m_step;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint32_t *p = (uint32_t *)(flow_var + m_flow_offset);
        if (*p <= (m_min_val+m_step)) {
            *p = m_max_val;
        } else {
            *p = *p - m_step;
        }
    }

} __attribute__((packed)) ;

struct StreamDPOpFlowVar64Step {
    uint8_t m_op;
    uint8_t m_flow_offset;
    uint64_t m_min_val;
    uint64_t m_max_val;
    uint64_t m_step;
public:
    void dump(FILE *fd,std::string opt);

    inline void run_inc(uint8_t * flow_var) {
        uint64_t *p = (uint64_t *)(flow_var + m_flow_offset);
        if (*p >= (m_max_val-m_step) ) {
            *p = m_min_val;
        } else {
            *p = *p + m_step;
        }
    }

    inline void run_dec(uint8_t * flow_var) {
        uint64_t *p = (uint64_t *)(flow_var + m_flow_offset);
        if (*p <= m_min_val+m_step) {
            *p = m_max_val;
        } else {
            *p = *p - m_step;
        }
    }


} __attribute__((packed)) ;

///////////////////////////////////////////////////////////////////////


struct StreamDPOpPktWrBase {
    enum {
        PKT_WR_IS_BIG = 1
    }; /* for flags */

    uint8_t m_op;
    uint8_t m_flags;
    uint8_t  m_offset; 

public:
    bool is_big(){
        return ( (m_flags &StreamDPOpPktWrBase::PKT_WR_IS_BIG) == StreamDPOpPktWrBase::PKT_WR_IS_BIG ?true:false);
    }

} __attribute__((packed)) ;


struct StreamDPOpPktWr8 : public StreamDPOpPktWrBase {
    int8_t  m_val_offset;
    uint16_t m_pkt_offset;

public:
    void dump(FILE *fd,std::string opt);

    inline void wr(uint8_t * flow_var_base,uint8_t * pkt_base) {
        uint8_t * p_pkt      = (pkt_base+m_pkt_offset);
        uint8_t * p_flow_var = (flow_var_base+m_offset);
        *p_pkt=(*p_flow_var+m_val_offset);

    }


} __attribute__((packed)) ;


struct StreamDPOpPktWr16 : public StreamDPOpPktWrBase {
    uint16_t m_pkt_offset;
    int16_t  m_val_offset;
public:
    void dump(FILE *fd,std::string opt);

    inline void wr(uint8_t * flow_var_base,uint8_t * pkt_base) {
        uint16_t * p_pkt      = (uint16_t*)(pkt_base+m_pkt_offset);
        uint16_t * p_flow_var = (uint16_t*)(flow_var_base+m_offset);

        if ( likely(is_big())){
            *p_pkt=PKT_HTONS((*p_flow_var+m_val_offset));
        }else{
            *p_pkt=(*p_flow_var+m_val_offset);
        }

    }
} __attribute__((packed));

struct StreamDPOpPktWr32 : public StreamDPOpPktWrBase {
    uint16_t m_pkt_offset;
    int32_t  m_val_offset;
public:
    void dump(FILE *fd,std::string opt);

    inline void wr(uint8_t * flow_var_base,uint8_t * pkt_base) {
        uint32_t * p_pkt      = (uint32_t*)(pkt_base+m_pkt_offset);
        uint32_t * p_flow_var = (uint32_t*)(flow_var_base+m_offset);
        if ( likely(is_big())){
            *p_pkt=PKT_HTONL((*p_flow_var+m_val_offset));
        }else{
            *p_pkt=(*p_flow_var+m_val_offset);
        }
    }

} __attribute__((packed));

struct StreamDPOpPktWr64 : public StreamDPOpPktWrBase {
    uint16_t m_pkt_offset;
    int64_t  m_val_offset;

public:
    void dump(FILE *fd,std::string opt);

    inline void wr(uint8_t * flow_var_base,uint8_t * pkt_base) {
        uint64_t * p_pkt      = (uint64_t*)(pkt_base+m_pkt_offset);
        uint64_t * p_flow_var = (uint64_t*)(flow_var_base+m_offset);
        if ( likely(is_big())){
            *p_pkt=pal_ntohl64((*p_flow_var+m_val_offset));
        }else{
            *p_pkt=(*p_flow_var+m_val_offset);
        }
    }


} __attribute__((packed));


struct StreamDPOpPktWrMask  {

    enum {
        MASK_PKT_WR_IS_BIG = 1
    }; /* for flags */

    uint8_t  m_op;
    uint8_t  m_flags;
    uint8_t  m_var_offset; 
    int8_t   m_shift;    
    uint8_t  m_pkt_cast_size; 
    uint8_t  m_flowv_cast_size; /* 1,2,4 */
    uint16_t m_pkt_offset;
    uint32_t m_mask;
    bool is_big(){
        return ( (m_flags &StreamDPOpPktWrMask::MASK_PKT_WR_IS_BIG) == StreamDPOpPktWrMask::MASK_PKT_WR_IS_BIG ?true:false);
    }


public:
    void dump(FILE *fd,std::string opt);

    void wr(uint8_t * flow_var_base,
                   uint8_t * pkt_base) ;

} __attribute__((packed));




struct StreamDPOpIpv4Fix {
    uint8_t m_op;
    uint16_t  m_offset;
public:
    void dump(FILE *fd,std::string opt);
    void run(uint8_t * pkt_base){
        IPHeader *      ipv4=  (IPHeader *)(pkt_base+m_offset);
        ipv4->updateCheckSum();
    }

} __attribute__((packed));


/* flow varible of Client command */
struct StreamDPFlowClient {
    uint32_t cur_ip;
    uint16_t cur_port;
    uint32_t cur_flow_id;
} __attribute__((packed));


struct StreamDPOpClientsLimit {
    uint8_t m_op;
    uint8_t m_flow_offset; /* offset into the flow var  bytes */
    uint8_t m_flags;
    uint8_t m_pad;
    uint16_t    m_min_port;
    uint16_t    m_max_port;

    uint32_t    m_min_ip;
    uint32_t    m_max_ip;
    uint32_t    m_limit_flows; /* limit the number of flows */

public:
    void dump(FILE *fd,std::string opt);
    inline void run(uint8_t * flow_var_base) {
        StreamDPFlowClient * lp= (StreamDPFlowClient *)(flow_var_base+m_flow_offset);
        lp->cur_ip++;
        if (lp->cur_ip > m_max_ip ) {
            lp->cur_ip= m_min_ip;
            lp->cur_port++;
            if (lp->cur_port > m_max_port) {
                lp->cur_port = m_min_port;
            }
        }

        if (m_limit_flows) {
            lp->cur_flow_id++;
            if ( lp->cur_flow_id > m_limit_flows ){
                /* reset to the first flow */
                lp->cur_flow_id = 1;
                lp->cur_ip      =  m_min_ip;
                lp->cur_port    =  m_min_port;
            }
        }
    }


} __attribute__((packed));

struct StreamDPOpClientsUnLimit {
    enum __MIN_PORT {
        CLIENT_UNLIMITED_MIN_PORT = 1025
    };

    uint8_t m_op;
    uint8_t m_flow_offset; /* offset into the flow var  bytes */
    uint8_t m_flags;
    uint8_t m_pad;
    uint32_t    m_min_ip;
    uint32_t    m_max_ip;

public:
    void dump(FILE *fd,std::string opt);
    inline void run(uint8_t * flow_var_base) {
        StreamDPFlowClient * lp= (StreamDPFlowClient *)(flow_var_base+m_flow_offset);
        lp->cur_ip++;
        if (lp->cur_ip > m_max_ip ) {
            lp->cur_ip= m_min_ip;
            lp->cur_port++;
            if (lp->cur_port == 0) {
                lp->cur_port = StreamDPOpClientsUnLimit::CLIENT_UNLIMITED_MIN_PORT;
            }
        }
    }

} __attribute__((packed));


struct StreamDPOpPktSizeChange  {
    uint8_t  m_op;
    uint8_t  m_flow_offset; /* offset to the flow var */

    inline void run(uint8_t * flow_var_base,uint16_t & new_size) {
        uint16_t * p_flow_var = (uint16_t*)(flow_var_base+m_flow_offset);
        new_size  = (*p_flow_var);
    }

    void dump(FILE *fd,std::string opt);


} __attribute__((packed)); ;


/* datapath instructions */
class StreamDPVmInstructions {
public:
    enum INS_TYPE {
        ditINC8     =7 ,
        ditINC16        ,
        ditINC32        ,
        ditINC64        ,

        ditDEC8         ,
        ditDEC16        ,
        ditDEC32        ,
        ditDEC64        ,

        ditRANDOM8      ,
        ditRANDOM16     ,
        ditRANDOM32     ,
        ditRANDOM64     ,

        ditFIX_IPV4_CS  ,

        itPKT_WR8       ,
        itPKT_WR16       ,
        itPKT_WR32       ,
        itPKT_WR64       ,
        itCLIENT_VAR       ,
        itCLIENT_VAR_UNLIMIT ,
        itPKT_SIZE_CHANGE ,

        /* inc/dec with step*/
        ditINC8_STEP         ,
        ditINC16_STEP        ,
        ditINC32_STEP        ,
        ditINC64_STEP        ,

        ditDEC8_STEP         ,
        ditDEC16_STEP        ,
        ditDEC32_STEP        ,
        ditDEC64_STEP        ,
        itPKT_WR_MASK


    };


public:
    void clear();
    void add_command(void *buffer,uint16_t size);
    uint8_t * get_program();
    uint32_t get_program_size();


    void Dump(FILE *fd);


private:
    std::vector<uint8_t> m_inst_list;
};


class StreamDPVmInstructionsRunner {
public:
    StreamDPVmInstructionsRunner(){
        m_new_pkt_size=0;;

    }

    void   slow_commands(uint8_t op_code,
                           uint8_t * flow_var, /* flow var */
                           uint8_t * pkt,
                           uint8_t * & p);

    inline void run(uint32_t * per_thread_random,
                    uint32_t program_size,
                    uint8_t * program,  /* program */
                    uint8_t * flow_var, /* flow var */
                    uint8_t * pkt);      /* pkt */

    inline uint16_t get_new_pkt_size(){
        return (m_new_pkt_size);
    }
private:
    uint16_t    m_new_pkt_size;
};


typedef union  ua_ {
        StreamDPOpFlowVar8  *lpv8;
        StreamDPOpFlowVar16 *lpv16;
        StreamDPOpFlowVar32 *lpv32;
        StreamDPOpFlowVar64 *lpv64;
        StreamDPOpIpv4Fix   *lpIpv4Fix;
        StreamDPOpPktWr8     *lpw8;
        StreamDPOpPktWr16    *lpw16;
        StreamDPOpPktWr32    *lpw32;
        StreamDPOpPktWr64    *lpw64;
        StreamDPOpPktSizeChange    *lpw_pkt_size;

        StreamDPOpClientsLimit      *lpcl;
        StreamDPOpClientsUnLimit    *lpclu;

        StreamDPOpFlowVar8Step  *lpv8s;
        StreamDPOpFlowVar16Step *lpv16s;
        StreamDPOpFlowVar32Step *lpv32s;
        StreamDPOpFlowVar64Step *lpv64s;
        StreamDPOpPktWrMask     *lpwr_mask;

} ua_t ;



inline void StreamDPVmInstructionsRunner::run(uint32_t * per_thread_random,
                                              uint32_t program_size,
                                              uint8_t * program,  /* program */
                                              uint8_t * flow_var, /* flow var */
                                              uint8_t * pkt
                                              ){

    uint8_t * p=program;
    uint8_t * p_end=p+program_size;

    ua_t ua;

    while ( p < p_end) {
        uint8_t op_code=*p;
        switch (op_code) {

        case  StreamDPVmInstructions::itCLIENT_VAR :      
            ua.lpcl =(StreamDPOpClientsLimit *)p;
            ua.lpcl->run(flow_var);
            p+=sizeof(StreamDPOpClientsLimit);
            break;

        case  StreamDPVmInstructions::itCLIENT_VAR_UNLIMIT :      
            ua.lpclu =(StreamDPOpClientsUnLimit *)p;
            ua.lpclu->run(flow_var);
            p+=sizeof(StreamDPOpClientsUnLimit);
            break;

        case   StreamDPVmInstructions::ditINC8  :
            ua.lpv8 =(StreamDPOpFlowVar8 *)p;
            ua.lpv8->run_inc(flow_var);
            p+=sizeof(StreamDPOpFlowVar8);
            break;

        case  StreamDPVmInstructions::ditINC16  :
            ua.lpv16 =(StreamDPOpFlowVar16 *)p;
            ua.lpv16->run_inc(flow_var);
            p+=sizeof(StreamDPOpFlowVar16);
            break;
        case  StreamDPVmInstructions::ditINC32 :
            ua.lpv32 =(StreamDPOpFlowVar32 *)p;
            ua.lpv32->run_inc(flow_var);
            p+=sizeof(StreamDPOpFlowVar32);
             break;
        case  StreamDPVmInstructions::ditINC64 :
            ua.lpv64 =(StreamDPOpFlowVar64 *)p;
            ua.lpv64->run_inc(flow_var);
            p+=sizeof(StreamDPOpFlowVar64);
            break;

        case  StreamDPVmInstructions::ditDEC8 :
            ua.lpv8 =(StreamDPOpFlowVar8 *)p;
            ua.lpv8->run_dec(flow_var);
            p+=sizeof(StreamDPOpFlowVar8);
            break;
        case  StreamDPVmInstructions::ditDEC16 :
            ua.lpv16 =(StreamDPOpFlowVar16 *)p;
            ua.lpv16->run_dec(flow_var);
            p+=sizeof(StreamDPOpFlowVar16);
            break;
        case  StreamDPVmInstructions::ditDEC32 :
            ua.lpv32 =(StreamDPOpFlowVar32 *)p;
            ua.lpv32->run_dec(flow_var);
            p+=sizeof(StreamDPOpFlowVar32);
            break;
        case  StreamDPVmInstructions::ditDEC64 :
            ua.lpv64 =(StreamDPOpFlowVar64 *)p;
            ua.lpv64->run_dec(flow_var);
            p+=sizeof(StreamDPOpFlowVar64);
            break;

        case  StreamDPVmInstructions::ditRANDOM8 :
            ua.lpv8 =(StreamDPOpFlowVar8 *)p;
            ua.lpv8->run_rand(flow_var,per_thread_random);
            p+=sizeof(StreamDPOpFlowVar8);
            break;
        case  StreamDPVmInstructions::ditRANDOM16 :
            ua.lpv16 =(StreamDPOpFlowVar16 *)p;
            ua.lpv16->run_rand(flow_var,per_thread_random);
            p+=sizeof(StreamDPOpFlowVar16);
            break;
        case  StreamDPVmInstructions::ditRANDOM32 :
            ua.lpv32 =(StreamDPOpFlowVar32 *)p;
            ua.lpv32->run_rand(flow_var,per_thread_random);
            p+=sizeof(StreamDPOpFlowVar32);
            break;
        case  StreamDPVmInstructions::ditRANDOM64 :
            ua.lpv64 =(StreamDPOpFlowVar64 *)p;
            ua.lpv64->run_rand(flow_var,per_thread_random);
            p+=sizeof(StreamDPOpFlowVar64);
            break;

        case  StreamDPVmInstructions::ditFIX_IPV4_CS :
            ua.lpIpv4Fix =(StreamDPOpIpv4Fix *)p;
            ua.lpIpv4Fix->run(pkt);
            p+=sizeof(StreamDPOpIpv4Fix);
            break;

        case  StreamDPVmInstructions::itPKT_WR8  :
            ua.lpw8 =(StreamDPOpPktWr8 *)p;
            ua.lpw8->wr(flow_var,pkt);
            p+=sizeof(StreamDPOpPktWr8);
            break;

        case  StreamDPVmInstructions::itPKT_WR16 :
            ua.lpw16 =(StreamDPOpPktWr16 *)p;
            ua.lpw16->wr(flow_var,pkt);
            p+=sizeof(StreamDPOpPktWr16);
            break;

        case  StreamDPVmInstructions::itPKT_WR32 :
            ua.lpw32 =(StreamDPOpPktWr32 *)p;
            ua.lpw32->wr(flow_var,pkt);
            p+=sizeof(StreamDPOpPktWr32);
            break;

        case  StreamDPVmInstructions::itPKT_WR64 :      
            ua.lpw64 =(StreamDPOpPktWr64 *)p;
            ua.lpw64->wr(flow_var,pkt);
            p+=sizeof(StreamDPOpPktWr64);
            break;

        case  StreamDPVmInstructions::itPKT_SIZE_CHANGE :      
            ua.lpw_pkt_size =(StreamDPOpPktSizeChange *)p;
            ua.lpw_pkt_size->run(flow_var,m_new_pkt_size);
            p+=sizeof(StreamDPOpPktSizeChange);
            break;
        
        default:
            slow_commands(op_code,flow_var,pkt,p);
            break;
        }
    };
};




/**
 * interface for stream VM instruction
 * 
 */
class StreamVmInstruction {
public:

    enum INS_TYPE {
        itNONE         = 0,
        itFIX_IPV4_CS  = 4,
        itFLOW_MAN     = 5,
        itPKT_WR       = 6,
        itFLOW_CLIENT  = 7 ,
        itPKT_SIZE_CHANGE = 8,
        itPKT_WR_MASK     = 9

    };

    typedef uint8_t instruction_type_t ;

    virtual instruction_type_t get_instruction_type() const = 0;

    virtual ~StreamVmInstruction();

    virtual void Dump(FILE *fd)=0;
    
    virtual StreamVmInstruction * clone() = 0;

    /* by default an instruction is not splitable */
    virtual bool is_splitable() const {
        return false;
    }

private:
    static const std::string m_name;
};

/**
 * abstract class that defines a flow var
 * 
 * @author imarom (23-Dec-15)
 */
class StreamVmInstructionVar : public StreamVmInstruction {

public:

    StreamVmInstructionVar(const std::string &var_name) : m_var_name(var_name) {

    }

    const std::string & get_var_name() {
        return m_var_name;
    }

    virtual bool is_splitable() const {
        return true;
    }

    /**
     * what is the split range for this var
     * 
     */
    virtual uint64_t get_splitable_range() const = 0;

public:
    
    /* flow var name */
    const std::string m_var_name;
};

/**
 * fix checksum for ipv4
 * 
 */
class StreamVmInstructionFixChecksumIpv4 : public StreamVmInstruction {
public:
    StreamVmInstructionFixChecksumIpv4(uint16_t offset) : m_pkt_offset(offset) {

    }

    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itFIX_IPV4_CS);
    }

    virtual void Dump(FILE *fd);

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionFixChecksumIpv4(m_pkt_offset);
    }

public:
    uint16_t m_pkt_offset; /* the offset of IPv4 header from the start of the packet  */
};

/**
 * flow manipulation instruction
 * 
 * @author imarom (07-Sep-15)
 */
class StreamVmInstructionFlowMan : public StreamVmInstructionVar {

public:

    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itFLOW_MAN);
    }

    virtual bool is_valid_for_split() const {
        return (m_step==1?true:false);
    }


    virtual uint64_t get_splitable_range() const {
        return (m_max_value - m_min_value + 1);
    }

    /**
     * different types of operations on the object
     */
    enum flow_var_op_e {
        FLOW_VAR_OP_INC,
        FLOW_VAR_OP_DEC,
        FLOW_VAR_OP_RANDOM
    };


    /**
     * for BSS we take one previous value 
     * because the VM will be executed before writing to pkt 
     * so the init value is one step's advanced 
     * 
     */
    uint64_t get_bss_init_value() const {
        uint64_t init = m_init_value;

        switch (m_op) {
        case FLOW_VAR_OP_INC:
            return (init == m_min_value ? m_max_value : (init - 1));

        case FLOW_VAR_OP_DEC:
            return (init == m_max_value ? m_min_value : (init + 1));

        default:
            return init;
        }

    }

    StreamVmInstructionFlowMan(const std::string &var_name,
                               uint8_t size,
                               flow_var_op_e op,
                               uint64_t init_value,
                               uint64_t min_value,
                               uint64_t max_value,
                               uint64_t step=1) : StreamVmInstructionVar(var_name) {

        m_op = op;
        m_size_bytes = size;
        m_init_value = init_value;
        m_min_value  = min_value;
        m_max_value  = max_value;
        m_step       = step;

    }

    virtual void Dump(FILE *fd);

    void sanity_check(uint32_t ins_id,StreamVm *lp);

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionFlowMan(m_var_name,
                                              m_size_bytes,
                                              m_op,
                                              m_init_value,
                                              m_min_value,
                                              m_max_value,
                                              m_step);
    }

private:
    void sanity_check_valid_range(uint32_t ins_id,StreamVm *lp);
    void sanity_check_valid_size(uint32_t ins_id,StreamVm *lp);
    void sanity_check_valid_opt(uint32_t ins_id,StreamVm *lp);

public:

    /* flow var size */
    uint8_t       m_size_bytes;

    /* type of op */
    flow_var_op_e m_op;

    /* range */
    uint64_t m_init_value;
    uint64_t m_min_value;
    uint64_t m_max_value;

    uint64_t m_step;
};


/**
 * write flow-write-mask  to packet, hhaim
 * 
 *  uint32_t var_tmp=(uint32_t )(flow_var_t size )flow_var;
 *  if (shift){
 *     var_tmp=var_tmp<<shift
 *  }else{
 *      var_tmp=var_tmp>>shift
 *  }
 *  
 *  pkt_data=read_pkt_size()
 *  pkt_data =  (pkt_data & ~mask) |(var_tmp & mask)   
 *  write_pkt(pkt_data)
 * 
 */
class StreamVmInstructionWriteMaskToPkt : public StreamVmInstruction {
public:

    StreamVmInstructionWriteMaskToPkt(const std::string &flow_var_name,
                                  uint16_t           pkt_offset,
                                  uint8_t            pkt_cast_size, /* valid 1,2,4 */
                                  uint32_t           mask,
                                  int                shift,       /* positive is shift left, negetive shift right */
                                  bool               is_big_endian = true) :
                                                        m_flow_var_name(flow_var_name),
                                                        m_pkt_offset(pkt_offset),
                                                        m_pkt_cast_size(pkt_cast_size), 
                                                        m_mask(mask),
                                                        m_shift(shift),       
                                                        m_is_big_endian(is_big_endian) {}

    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itPKT_WR_MASK);
    }

    virtual void Dump(FILE *fd);

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionWriteMaskToPkt(m_flow_var_name,
                                                     m_pkt_offset,
                                                     m_pkt_cast_size,
                                                     m_mask,
                                                     m_shift,
                                                     m_is_big_endian);
    }

public:

    /* flow var name to write */
    std::string   m_flow_var_name;

    /* where to write */
    uint16_t      m_pkt_offset;
    uint8_t       m_pkt_cast_size; /* valid 1,2,4 */

    uint32_t      m_mask;
    int           m_shift;       
    bool          m_is_big_endian;
};




/**
 * flow client instruction - save state for client range and port range 
 * 
 * @author hhaim
 */
class StreamVmInstructionFlowClient : public StreamVmInstructionVar {

public:
    enum client_flags_e {
        CLIENT_F_UNLIMITED_FLOWS=1, /* unlimited number of flow, don't care about ports  */
    };


    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itFLOW_CLIENT);
    }


    StreamVmInstructionFlowClient(const std::string &var_name,
                               uint32_t client_min_value,
                               uint32_t client_max_value,
                               uint16_t port_min,
                               uint16_t port_max,
                               uint32_t limit_num_flows, /* zero means don't limit */
                               uint16_t flags
                               ) : StreamVmInstructionVar(var_name) { 

        m_client_min = client_min_value;
        m_client_max = client_max_value;

        m_port_min   = port_min;
        m_port_max   = port_max;

        m_limit_num_flows = limit_num_flows;
        m_flags = flags;
    }

    virtual void Dump(FILE *fd);

    static uint8_t get_flow_var_size(){
        return  (4+2+4);
    }

    uint32_t get_ip_range() const {
        return (m_client_max - m_client_min + 1);
    }

    uint16_t get_port_range() const {
        return (m_port_max - m_port_min + 1);
    }

    virtual uint64_t get_splitable_range() const {
        return get_ip_range();
    }

    bool is_unlimited_flows(){
        return ( (m_flags &   StreamVmInstructionFlowClient::CLIENT_F_UNLIMITED_FLOWS ) == 
                  StreamVmInstructionFlowClient::CLIENT_F_UNLIMITED_FLOWS );
    }

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionFlowClient(m_var_name,
                                                 m_client_min,
                                                 m_client_max,
                                                 m_port_min,
                                                 m_port_max,
                                                 m_limit_num_flows,
                                                 m_flags);
    }

public:

    uint32_t m_client_min;  // min ip 
    uint32_t m_client_max;  // max ip 
    uint16_t m_port_min;  // start port 
    uint16_t m_port_max;  // start port 
    uint32_t m_limit_num_flows;   // number of flows
    uint16_t m_flags;
};



class VmFlowVarRec {
public:
    uint32_t    m_offset;
    union {
        StreamVmInstructionFlowMan * m_ins_flowv;
        StreamVmInstructionFlowClient * m_ins_flow_client;
    } m_ins;
    uint8_t    m_size_bytes;
};




/**
 * write flow var to packet, hhaim
 * 
 */
class StreamVmInstructionWriteToPkt : public StreamVmInstruction {
public:

      StreamVmInstructionWriteToPkt(const std::string &flow_var_name,
                                    uint16_t           pkt_offset,
                                    int32_t            add_value = 0,
                                    bool               is_big_endian = true) :

                                                        m_flow_var_name(flow_var_name),
                                                        m_pkt_offset(pkt_offset),
                                                        m_add_value(add_value),
                                                        m_is_big_endian(is_big_endian) {}

    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itPKT_WR);
    }

    virtual void Dump(FILE *fd);

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionWriteToPkt(m_flow_var_name,
                                                 m_pkt_offset,
                                                 m_add_value,
                                                 m_is_big_endian);
    }

public:

    /* flow var name to write */
    std::string   m_flow_var_name;

    /* where to write */
    uint16_t      m_pkt_offset;

    /* add/dec value from field when writing */
    int32_t       m_add_value;

    /* writing endian */
    bool         m_is_big_endian;
};



/**
 * change packet size,  
 * 
 */
class StreamVmInstructionChangePktSize : public StreamVmInstruction {
public:

    StreamVmInstructionChangePktSize(const std::string &flow_var_name) :

                                                        m_flow_var_name(flow_var_name)
                                                        {}

    virtual instruction_type_t get_instruction_type() const {
        return ( StreamVmInstruction::itPKT_SIZE_CHANGE );
    }

    virtual void Dump(FILE *fd);

    virtual StreamVmInstruction * clone() {
        return new StreamVmInstructionChangePktSize(m_flow_var_name);
    }

public:

    /* flow var name to write */
    std::string   m_flow_var_name;
};


/**
 * describes a VM program for DP 
 * 
 */

class StreamVmDp {
public:
    StreamVmDp(){
        m_bss_ptr=NULL; 
        m_program_ptr =NULL ;
        m_bss_size=0;
        m_program_size=0;
        m_max_pkt_offset_change=0;
        m_prefix_size = 0;
        m_is_pkt_size_var=false;
    }

    StreamVmDp( uint8_t * bss,
                uint16_t bss_size,
                uint8_t * prog,
                uint16_t prog_size,
                uint16_t max_pkt_offset,
                uint16_t prefix_size,
                bool a_is_pkt_size_var
                ){

        if (bss) {
            assert(bss_size);
            m_bss_ptr=(uint8_t*)malloc(bss_size);
            assert(m_bss_ptr);
            memcpy(m_bss_ptr,bss,bss_size);
            m_bss_size=bss_size;
        }else{
            m_bss_ptr=NULL; 
            m_bss_size=0;
        }

        if (prog) {
            assert(prog_size);
            m_program_ptr=(uint8_t*)malloc(prog_size);
            memcpy(m_program_ptr,prog,prog_size);
            m_program_size = prog_size;
        }else{
            m_program_ptr = NULL;
            m_program_size=0;
        }

        m_max_pkt_offset_change = max_pkt_offset;
        m_prefix_size = prefix_size;
        m_is_pkt_size_var=a_is_pkt_size_var;
    }

    ~StreamVmDp(){
        if (m_bss_ptr) {
            free(m_bss_ptr);
            m_bss_ptr=0;
            m_bss_size=0;
        }
        if (m_program_ptr) {
            free(m_program_ptr);
            m_program_size=0;
            m_program_ptr=0;
        }
    }

    StreamVmDp * clone() const {
        StreamVmDp * lp = new StreamVmDp(m_bss_ptr,
                                         m_bss_size,
                                         m_program_ptr,
                                         m_program_size,
                                         m_max_pkt_offset_change,
                                         m_prefix_size,
                                         m_is_pkt_size_var
                                         );
        assert(lp);
        return (lp);
    }

    uint8_t* clone_bss(){
        assert(m_bss_size>0);
        uint8_t *p=(uint8_t *)malloc(m_bss_size);
        assert(p);
        memcpy(p,m_bss_ptr,m_bss_size);
        return (p);
    }

    uint16_t get_bss_size(){
        return(m_bss_size);
    }

    uint8_t*  get_bss(){
        return (m_bss_ptr);
    }

    uint8_t*  get_program(){
        return (m_program_ptr);
    }

    uint16_t  get_program_size(){
        return (m_program_size);
    }

    uint16_t get_max_packet_update_offset(){
        return (m_max_pkt_offset_change);
    }

    uint16_t get_prefix_size() {
        return m_prefix_size;
    }

    void set_prefix_size(uint16_t prefix_size) {
        m_prefix_size = prefix_size;
    }

    void set_pkt_size_is_var(bool pkt_size_var){
        m_is_pkt_size_var=pkt_size_var;
    }
    bool is_pkt_size_var(){
        return (m_is_pkt_size_var);
    }


private:
    uint8_t *  m_bss_ptr; /* pointer to the data section */
    uint8_t *  m_program_ptr; /* pointer to the program */
    uint16_t   m_bss_size;
    uint16_t   m_program_size; /* program size*/
    uint16_t   m_max_pkt_offset_change;
    uint16_t   m_prefix_size;
    bool       m_is_pkt_size_var;

};


/**
 * describes a VM program
 * 
 */
class StreamVm {

public:
    enum STREAM_VM {
        svMAX_FLOW_VAR   = 64, /* maximum flow varible */
        svMAX_PACKET_OFFSET_CHANGE = 512
    };



    StreamVm(){
        m_prefix_size=0;
        m_bss=0;
        m_pkt_size=0;
        m_expected_pkt_size=0;
        m_cur_var_offset=0;

        m_is_random_var=false;
        m_is_change_pkt_size=false;

        m_split_instr=NULL;
        m_is_compiled = false;
    }


    /**
     * calculate the expected packet size 
     * might be different from regular_pkt_size 
     * if the VM changes the packet length (random) 
     * 
     */
    uint16_t calc_expected_pkt_size(uint16_t regular_pkt_size) const;



    void set_split_instruction(StreamVmInstructionVar *instr);

    StreamVmInstructionVar * get_split_instruction() {
        return m_split_instr;
    }

    StreamVmDp * generate_dp_object(){

        if (!m_is_compiled) {
            return NULL;
        }

        StreamVmDp * lp= new StreamVmDp(get_bss_ptr(),
                                        get_bss_size(),
                                        get_dp_instruction_buffer()->get_program(),
                                        get_dp_instruction_buffer()->get_program_size(),
                                        get_max_packet_update_offset(),
                                        get_prefix_size(),
                                        is_var_pkt_size()
                                        );
        assert(lp);
        return (lp);
        
    }

    /**
     * clone VM instructions
     * 
     */
    void copy_instructions(StreamVm &other) const;

    
    bool is_vm_empty() const {
        return (m_inst_list.size() == 0);
    }

    /**
     * add new instruction to the VM
     * 
     */
    void add_instruction(StreamVmInstruction *inst);

    /**
     * get const access to the instruction list
     * 
     */
    const std::vector<StreamVmInstruction *> & get_instruction_list();

    StreamDPVmInstructions  *           get_dp_instruction_buffer();

    uint16_t                                  get_bss_size(){
        return (m_cur_var_offset );
    }

    uint8_t *                                 get_bss_ptr(){
        return (m_bss );
    }


    uint16_t                                  get_max_packet_update_offset(){
        return ( m_max_field_update );
    }

    uint16_t get_prefix_size() {
        return m_prefix_size;
    }

    bool is_var_pkt_size(){
        return (m_is_change_pkt_size);
    }
    

    bool is_compiled() const {
        return m_is_compiled;
    }

    /**
     * compile the VM 
     * return true of success, o.w false 
     * 
     */
    void compile(uint16_t pkt_len);

    ~StreamVm();

    void Dump(FILE *fd);

    /* raise exception */
    void  err(const std::string &err);


    /**
     * return a pointer to a flow var / client var 
     * by name if exists, otherwise NULL 
     * 
     */
    StreamVmInstructionVar * lookup_var_by_name(const std::string &var_name);

private:

    /* lookup for varible offset, */
    bool var_lookup(const std::string &var_name,VmFlowVarRec & var);

    void  var_clear_table();

    bool  var_add(const std::string &var_name,VmFlowVarRec & var);

    uint16_t get_var_offset(const std::string &var_name);
    
    void build_flow_var_table() ;

    void build_bss();

    void build_program();

    void alloc_bss();

    void free_bss();

private:

    void clean_max_field_cnt();

    void add_field_cnt(uint16_t new_cnt);

private:
    bool                               m_is_random_var;
    bool                               m_is_change_pkt_size;
    bool                               m_is_compiled;
    uint16_t                           m_prefix_size;

    uint16_t                           m_pkt_size;
    uint16_t                           m_expected_pkt_size;

    uint16_t                           m_cur_var_offset;
    uint16_t                           m_max_field_update; /* the location of the last byte that is going to be changed in the packet */ 

    std::vector<StreamVmInstruction *> m_inst_list;
    std::unordered_map<std::string, VmFlowVarRec> m_flow_var_offset;
    uint8_t *                          m_bss;

    StreamDPVmInstructions             m_instructions;
    
    StreamVmInstructionVar             *m_split_instr;

    
    
};

#endif /* __TREX_STREAM_VM_API_H__ */