File: messageEncoding.cpp

package info (click to toggle)
intel-graphics-compiler 1.0.12504.6-1%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 83,912 kB
  • sloc: cpp: 910,147; lisp: 202,655; ansic: 15,197; python: 4,025; yacc: 2,241; lex: 1,570; pascal: 244; sh: 104; makefile: 25
file content (823 lines) | stat: -rw-r--r-- 39,055 bytes parent folder | download | duplicates (3)
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
/*========================== begin_copyright_notice ============================

Copyright (C) 2017-2021 Intel Corporation

SPDX-License-Identifier: MIT

============================= end_copyright_notice ===========================*/

#include "Compiler/CISACodeGen/messageEncoding.hpp"
#include "Compiler/CISACodeGen/helper.h"
#include "Compiler/CISACodeGen/CISACodeGen.h"
#include "common/Types.hpp"
#include "Probe/Assertion.h"

/***********************************************************************************
This File contains all the helper functions to generate the message descriptor for the different
messages we use for 3D compiler, once the messages are implemented in C-ISA we can get rid of this.
Most likely some messages will stay encoded manually by the code generator

*************************************************************************************/


namespace IGC
{
    EU_SAMPLER_SIMD_MODE samplerSimdMode(SIMDMode simd)
    {
        if (simd == SIMDMode::SIMD8)
        {
            return EU_SAMPLER_SIMD_SIMD8;
        }
        else if (simd == SIMDMode::SIMD16)
        {
            return EU_SAMPLER_SIMD_SIMD16;
        }
        IGC_ASSERT(0);
        return EU_SAMPLER_SIMD_SIMD8;
    }

    uint Sampler(
        uint messageLength,
        uint responseLength,
        bool  headerPresent,
        EU_SAMPLER_SIMD_MODE executionMode,
        EU_GEN6_SAMPLER_MESSAGE_TYPE messageType,
        uint samplerIndex,
        uint resourceIndex,
        bool endOfThread,
        bool FP16Input,
        bool FP16Return)
    {
        IGC_ASSERT(resourceIndex < 256);
        IGC_ASSERT(samplerIndex < 16);
        IGC_ASSERT(messageType >= 0);
        IGC_ASSERT(int(messageType) < 32);
        IGC_ASSERT(executionMode >= 0);
        IGC_ASSERT(int(executionMode) < 4);
        IGC_ASSERT(responseLength < 9);
        IGC_ASSERT(messageLength > 0);
        IGC_ASSERT(messageLength < 16);

        // if endOfThread == true, responseLength needs to be 0
        IGC_ASSERT(!endOfThread || responseLength == 0);

        SEUSamplerMessageDescriptorGen7 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.BindingTableIndex = resourceIndex;
        messageDescriptor.DW0.All.SamplerIndex = samplerIndex;
        messageDescriptor.DW0.All.MessageType = messageType;
        messageDescriptor.DW0.All.SIMDMode = executionMode;
        messageDescriptor.DW0.All.HeaderPresent = headerPresent;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.FP16Input = FP16Input;
        messageDescriptor.DW0.All.FP16Return = FP16Return;
        messageDescriptor.DW0.All.EndOfThread = endOfThread;

        return messageDescriptor.DW0.Value;
    }

    EU_DATA_PORT_ATOMIC_OPERATION_TYPE getHwAtomicOpEnum(AtomicOp op)
    {
        switch (op)
        {
        case EATOMIC_AND:
            return EU_DATA_PORT_ATOMIC_OPERATION_AND;
        case EATOMIC_DEC:
            return EU_DATA_PORT_ATOMIC_OPERATION_DEC;
        case EATOMIC_IADD:
            return EU_DATA_PORT_ATOMIC_OPERATION_ADD;
        case EATOMIC_IMAX:
            return EU_DATA_PORT_ATOMIC_OPERATION_IMAX;
        case EATOMIC_IMIN:
            return EU_DATA_PORT_ATOMIC_OPERATION_IMIN;
        case EATOMIC_INC:
            return EU_DATA_PORT_ATOMIC_OPERATION_INC;
        case EATOMIC_MAX:
            return EU_DATA_PORT_ATOMIC_OPERATION_IMAX;
        case EATOMIC_MIN:
            return EU_DATA_PORT_ATOMIC_OPERATION_IMIN;
        case EATOMIC_OR:
            return EU_DATA_PORT_ATOMIC_OPERATION_OR;
        case EATOMIC_SUB:
            return EU_DATA_PORT_ATOMIC_OPERATION_SUB;
        case EATOMIC_UMAX:
            return EU_DATA_PORT_ATOMIC_OPERATION_UMAX;
        case EATOMIC_UMIN:
            return EU_DATA_PORT_ATOMIC_OPERATION_UMIN;
        case EATOMIC_CMPXCHG:
            return EU_DATA_PORT_ATOMIC_OPERATION_CMPWR;
        case EATOMIC_XCHG:
            return EU_DATA_PORT_ATOMIC_OPERATION_MOV;
        case EATOMIC_XOR:
            return EU_DATA_PORT_ATOMIC_OPERATION_XOR;
        case EATOMIC_PREDEC:
            return EU_DATA_PORT_ATOMIC_OPERATION_PREDEC;
        case EATOMIC_FMIN:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_FMIN;
        case EATOMIC_FMAX:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_FMAX;
        case EATOMIC_FCMPWR:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_FCMPWR;
            // 64 Bit
        case EATOMIC_AND64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_AND;
        case EATOMIC_DEC64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_DEC;
        case EATOMIC_IADD64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_ADD;
        case EATOMIC_IMAX64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_IMAX;
        case EATOMIC_IMIN64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_IMIN;
        case EATOMIC_INC64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_INC;
        case EATOMIC_OR64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_OR;
        case EATOMIC_SUB64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_SUB;
        case EATOMIC_UMAX64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_UMAX;
        case EATOMIC_UMIN64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_UMIN;
        case EATOMIC_CMPXCHG64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_CMPWR;
        case EATOMIC_XCHG64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_MOV;
        case EATOMIC_XOR64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_XOR;
        case EATOMIC_PREDEC64:
            return EU_DATA_PORT_A64_ATOMIC_OPERATION_PREDEC;
        default:
            IGC_ASSERT_MESSAGE(0, "Other atomic operations not implemented");
            break;
        }

        return EU_DATA_PORT_ATOMIC_OPERATION_AND;
    }

    uint encodeMessageDescriptorForAtomicUnaryOp(
        const unsigned int  messageLength,
        const unsigned int  responseLength,
        bool headerPresent,
        const uint message_type,
        const bool returnData,
        const SIMDMode simdMode,
        EU_DATA_PORT_ATOMIC_OPERATION_TYPE atomic_op_type,
        uint binding_table_index)
    {
        SEUDataPortMessageDescriptorGen8_0 messageDescriptor = { 0 };

        uint messageSpecificControl = 0;

        messageSpecificControl |= atomic_op_type;

        if ((message_type == EU_GEN7_5_DATA_CACHE_1_MESSAGE_TYPE_ATOMIC_COUNTER_OPERATION ||
            message_type == EU_GEN7_5_DATA_CACHE_1_MESSAGE_TYPE_UNTYPED_ATOMIC_OPERATION) &&
            simdMode == SIMDMode::SIMD8)
        {
            messageSpecificControl |= (1 << 4);
        }

        messageDescriptor.DW0.All.BindingTableIndex = binding_table_index;
        messageDescriptor.DW0.All.EndOfThread = false;
        messageDescriptor.DW0.All.HeaderPresent = headerPresent;
        messageDescriptor.DW0.All.MessageLength = messageLength;

        switch (atomic_op_type)
        {

        case EU_DATA_PORT_A64_ATOMIC_OPERATION_FMIN:
        {
            messageDescriptor.DW0.All.MessageSpecificControl = 2;//FMIN
            messageDescriptor.DW0.All.MessageType = EU_GEN8_DATA_PORT_1_MESSAGE_TYPE_UNTYPED_ATOMIC_FLOAT;
        }
        break;
        case EU_DATA_PORT_A64_ATOMIC_OPERATION_FMAX:
        {
            messageSpecificControl |= (1 << 13);
            messageDescriptor.DW0.All.MessageSpecificControl = 1;//FMAX
            messageDescriptor.DW0.All.MessageType = EU_GEN8_DATA_PORT_1_MESSAGE_TYPE_UNTYPED_ATOMIC_FLOAT;
        }
        break;
        case EU_DATA_PORT_A64_ATOMIC_OPERATION_FCMPWR:
        {
            messageSpecificControl |= (1 << 13);
            messageDescriptor.DW0.All.MessageSpecificControl = 3;//FCMPWR
            messageDescriptor.DW0.All.MessageType = EU_GEN8_DATA_PORT_1_MESSAGE_TYPE_UNTYPED_ATOMIC_FLOAT;
        }
        break;
        default:
        {
            messageSpecificControl |= (returnData << 5);
            messageDescriptor.DW0.All.MessageSpecificControl = messageSpecificControl;
            messageDescriptor.DW0.All.MessageType = message_type;
        }
        break;
        }

        messageDescriptor.DW0.All.ResponseLength = responseLength;

        return messageDescriptor.DW0.Value;
    }

    /// Currently this is a bad design since we are overloading both the functions doing the same thing.
    /// Discriminated Unions was an idea but this one needs more thought. Templates are terrible for
    /// dealing with multiple enum types and hence wasn't used.
    uint encodeMessageSpecificControlForReadWrite(
        const EU_DATA_PORT_READ_MESSAGE_TYPE messageType,
        const VISAChannelMask mask,
        const SIMDMode simdMode)
    {
        uint messageSpecificControl = 0;
        // We need only the lowest 4 bits
        messageSpecificControl |= (~mask & 0xF);

        if (messageType == EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ)
        {
            TODO("message encoding for message specific control has to be improved.");
            switch (simdMode)
            {
            case SIMDMode::SIMD8:
                // Hate magic numbers but for now we need a quick solution. Refer to Spec
                messageSpecificControl |= (2 << 4); // 12 is where the bits for SIMD mode start.. So 8 bits
                                                    // are in the structure already so we have to subtract 8
                                                    // for all our calculations
                break;
            case SIMDMode::SIMD16:
                messageSpecificControl |= (1 << 4);
                break;
            default:
                IGC_ASSERT_MESSAGE(0, "Other SIMD modes are not allowed");
                break;
            }
        }

        return messageSpecificControl;
    }

    uint encodeMessageSpecificControlForReadWrite(
        const EU_DATA_PORT_WRITE_MESSAGE_TYPE messageType,
        const VISAChannelMask mask,
        const SIMDMode simdMode)
    {
        uint messageSpecificControl = 0;
        // We need only the lowest 4 bits
        messageSpecificControl |= (~mask & 0xF);

        if (messageType == EU_DATA_PORT_WRITE_MESSAGE_TYPE_UNTYPED_SURFACE_WRITE)
        {
            TODO("message encoding for message specific control has to be improved.");
            switch (simdMode)
            {
            case SIMDMode::SIMD8:
                // Hate magic numbers but for now we need a quick solution. Refer to Spec
                messageSpecificControl |= (2 << 4); // 12 is where the bits for SIMD mode start.. So 8 bits
                                                    // are in the structure already so we have to subtract 8
                                                    // for all our calculations
                break;
            case SIMDMode::SIMD16:
                messageSpecificControl |= (1 << 4);
                break;
            default:
                IGC_ASSERT_MESSAGE(0, "Other SIMD modes are not allowed");
                break;
            }
        }
        else
        {
            IGC_ASSERT_MESSAGE(0, "Other message types haven't been implemented yet.");
        }

        return messageSpecificControl;
    }

    uint DataPortRead(
        const uint messageLength,
        const uint responseLength,
        const bool headerPresent,
        const EU_DATA_PORT_READ_MESSAGE_TYPE messageType,
        const uint messageSpecificControl,
        const bool invalidateAfterReadEnableHint,
        const DATA_PORT_TARGET_CACHE targetCache,
        const uint bindingTableIndex)
    {
        static_assert(0 == DATA_PORT_TARGET_DATA_CACHE, "Table index order");
        static_assert(1 == DATA_PORT_TARGET_RENDER_CACHE, "Table index order");
        static_assert(2 == DATA_PORT_TARGET_SAMPLER_CACHE, "Table index order");
        static_assert(3 == DATA_PORT_TARGET_CONSTANT_CACHE, "Table index order");
        static_assert(4 == DATA_PORT_TARGET_DATA_CACHE_1, "Table index order");
        IGC_ASSERT_MESSAGE(0 <= targetCache, "Table index bounds check");
        IGC_ASSERT_MESSAGE(targetCache <= 4, "Table index bounds check");
        static const uint cConvertMessageType[][NUM_EU_DATA_PORT_READ_MESSAGE_TYPES] =
        {
            // DATA_PORT_TARGET_DATA_CACHE
            {
                EU_GEN7_DATA_CACHE_MESSAGE_TYPE_OWORD_BLOCK_READ,               // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_BLOCK_READ
                EU_GEN7_DATA_CACHE_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ,          // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_MEDIA_BLOCK_READ
                EU_GEN7_DATA_CACHE_MESSAGE_TYPE_DWORD_SCATTERED_READ,           // EU_DATA_PORT_READ_MESSAGE_TYPE_DWORD_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDERTARGET_UNORM_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_AVC_LOOPFILTER_READ
                EU_GEN7_DATA_CACHE_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ,     // EU_DATA_PORT_READ_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ
                EU_GEN7_DATA_CACHE_MESSAGE_TYPE_BYTE_SCATTERED_READ,            // EU_DATA_PORT_READ_MESSAGE_TYPE_BYTE_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TRANSPOSE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDER_TARGET_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_SURFACE_INFO_READ
            },
            // DATA_PORT_TARGET_RENDER_CACHE
            {
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_MEDIA_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_DWORD_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDERTARGET_UNORM_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_AVC_LOOPFILTER_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_BYTE_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TRANSPOSE_READ
                EU_GEN9_RENDER_CACHE_MESSAGE_TYPE_RENDER_TARGET_READ,           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDER_TARGET_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_SURFACE_INFO_READ
            },
            // DATA_PORT_TARGET_SAMPLER_CACHE
            {
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ
                EU_GEN7_SAMPLER_CACHE_MESSAGE_TYPE_MEDIA_BLOCK_READ,            // EU_DATA_PORT_READ_MESSAGE_TYPE_MEDIA_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_DWORD_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDERTARGET_UNORM_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_AVC_LOOPFILTER_READ
                EU_GEN7_SAMPLER_CACHE_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ,  // EU_DATA_PORT_READ_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_BYTE_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TRANSPOSE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDER_TARGET_READ
                EU_GEN8_SAMPLER_CACHE_MESSAGE_TYPE_SURFACE_INFO,                // EU_DATA_PORT_READ_MESSAGE_TYPE_SURFACE_INFO_READ
            },
            // DATA_PORT_TARGET_CONSTANT_CACHE
            {
                EU_GEN7_CONSTANT_CACHE_MESSAGE_TYPE_OWORD_BLOCK_READ,           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_BLOCK_READ
                EU_GEN7_CONSTANT_CACHE_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ,      // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_MEDIA_BLOCK_READ
                EU_GEN7_CONSTANT_CACHE_MESSAGE_TYPE_DWORD_SCATTERED_READ,       // EU_DATA_PORT_READ_MESSAGE_TYPE_DWORD_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDERTARGET_UNORM_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_AVC_LOOPFILTER_READ
                EU_GEN7_CONSTANT_CACHE_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ, // EU_DATA_PORT_READ_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_BYTE_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TRANSPOSE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDER_TARGET_READ
                EU_GEN9_CONSTANT_CACHE_MESSAGE_SURFACE_INFO,                    // EU_DATA_PORT_READ_MESSAGE_TYPE_SURFACE_INFO_READ
            },
            // DATA_PORT_TARGET_DATA_CACHE_1
            {
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_OWORD_DUAL_BLOCK_READ
                EU_GEN7_5_DATA_CACHE_1_MESSAGE_TYPE_MEDIA_BLOCK_READ,           // EU_DATA_PORT_READ_MESSAGE_TYPE_MEDIA_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_DWORD_SCATTERED_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDERTARGET_UNORM_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_AVC_LOOPFILTER_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_UNALIGNED_OWORD_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_BYTE_SCATTERED_READ
                EU_GEN7_5_DATA_CACHE_1_MESSAGE_TYPE_UNTYPED_SURFACE_READ,       // EU_DATA_PORT_READ_MESSAGE_TYPE_UNTYPED_SURFACE_READ
                EU_GEN7_5_DATA_CACHE_1_MESSAGE_TYPE_TYPED_SURFACE_READ,         // EU_DATA_PORT_READ_MESSAGE_TYPE_TYPED_SURFACE_READ
                EU_GEN8_DATA_CACHE_1_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ,     // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_UNTYPED_SURFACE_READ
                EU_GEN8_DATA_CACHE_1_MESSAGE_TYPE_A64_SCATTERED_READ,           // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_SCATTERED_READ
                EU_GEN8_DATA_CACHE_1_MESSAGE_TYPE_A64_BLOCK_READ,               // EU_DATA_PORT_READ_MESSAGE_TYPE_A64_BLOCK_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_TRANSPOSE_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_RENDER_TARGET_READ
                INVALID_MESSAGE_TYPE,                                           // EU_DATA_PORT_READ_MESSAGE_TYPE_SURFACE_INFO_READ
            }
        };


        uint hwMessageType = cConvertMessageType[targetCache][messageType];
        SEUDataPortMessageDescriptorGen8_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.BindingTableIndex = bindingTableIndex;
        messageDescriptor.DW0.All.MessageSpecificControl = messageSpecificControl |
            (invalidateAfterReadEnableHint ? EU_DATA_PORT_INVALIDATE_AFTER_READ_ENABLE : 0);
        messageDescriptor.DW0.All.MessageType = hwMessageType;
        messageDescriptor.DW0.All.HeaderPresent = headerPresent;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.EndOfThread = false;

        return messageDescriptor.DW0.Value;
    }

    uint DataPortWrite(
        const uint   messageLength,
        const uint   responseLength,
        const bool   headerPresent,
        const bool   endOfThread,
        const EU_DATA_PORT_WRITE_MESSAGE_TYPE messageType,
        const uint   messageSpecificControl,
        const bool   invalidateAfterReadEnable,
        const uint   bindingTableIndex)
    {
        IGC_ASSERT(messageLength > 0);
        IGC_ASSERT(messageLength < 16);
        IGC_ASSERT(responseLength < 9);

        SEUDataPortMessageDescriptorGen8_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.BindingTableIndex = bindingTableIndex;
        messageDescriptor.DW0.All.MessageSpecificControl = messageSpecificControl;
        messageDescriptor.DW0.All.MessageType =
            cConvertDataPortWriteMessageType[messageType];
        messageDescriptor.DW0.All.HeaderPresent = headerPresent;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;

        return messageDescriptor.DW0.Value;
    }

    uint PixelDataPort(
        const bool   precisionSubType,
        const uint   messageLength,
        const uint   responseLength,
        const bool   headerPresent,
        const bool   perCoarse,
        const bool   perSample,
        const bool   lastRT,
        const bool   secondHalf,
        const EU_GEN6_DATA_PORT_RENDER_TARGET_WRITE_CONTROL messageSubType,
        const uint   bindingTableIndex)
    {
        IGC_ASSERT(messageLength > 0);
        IGC_ASSERT(messageLength < 16);
        IGC_ASSERT(responseLength < 9);

        SEUPixelDataPortMessageDescriptorGen8_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.BindingTableIndex = bindingTableIndex;
        messageDescriptor.DW0.All.MessageSubType = messageSubType;
        messageDescriptor.DW0.All.Slot = secondHalf;
        messageDescriptor.DW0.All.LastRT = lastRT;
        messageDescriptor.DW0.All.PerSample = perSample;
        messageDescriptor.DW0.All.MessageType = EU_GEN9_RENDER_CACHE_MESSAGE_TYPE_RENDER_TARGET_WRITE;
        messageDescriptor.DW0.All.PerCoarse = perCoarse;
        messageDescriptor.DW0.All.HeaderPresent = headerPresent;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.PrecisionSubType = precisionSubType;

        return messageDescriptor.DW0.Value;
    }

    uint UrbMessage(
        const uint  messageLength,
        const uint  responseLength,
        const bool   endOfThread,
        const bool   perSlotOffset,
        const bool   channelMaskPresent,
        const uint  globalOffset,
        const EU_URB_OPCODE urbOpcode)
    {
        SEUURBMessageDescriptorGen8_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.Simd8.URBOpcode = urbOpcode;
        messageDescriptor.DW0.Simd8.GlobalOffset = globalOffset;
        messageDescriptor.DW0.Simd8.ChannelMaskPresent = channelMaskPresent;
        messageDescriptor.DW0.Simd8.PerSlotOffset = perSlotOffset;
        messageDescriptor.DW0.Simd8.ResponseLength = responseLength;
        messageDescriptor.DW0.Simd8.MessageLength = messageLength;
        messageDescriptor.DW0.Simd8.HeaderPresent = true;

        return messageDescriptor.DW0.Value;
    }

    uint CBTILayout::GetSystemThreadBindingTableIndex(void) const
    {
        return m_pLayout->systemThreadIdx;
    }

    uint CBTILayout::GetBindingTableEntryCount(void) const
    {
        return m_pLayout->maxBTsize;
    }

    uint CBTILayout::GetTextureIndex(uint index) const
    {
        uint idx = m_pLayout->minResourceIdx + index;
        return idx;
    }

    uint CBTILayout::GetNullSurfaceIdx() const
    {
        return m_pLayout->NULLSurfaceIdx;
    }

    uint CBTILayout::GetUavIndex(uint index) const
    {
        uint idx = m_pLayout->minUAVIdx + index;
        return idx;
    }

    uint CBTILayout::GetRenderTargetIndex(uint index) const
    {
        uint idx = m_pLayout->minColorBufferIdx + index;

        IGC_ASSERT(m_ColorBufferMappings.size() == 0 || idx < m_ColorBufferMappings.size());
        if (idx < m_ColorBufferMappings.size())
        {
            idx = m_ColorBufferMappings[idx];
        }

        return idx;
    }

    uint CBTILayout::GetConstantBufferIndex(uint index) const
    {
        uint idx = m_pLayout->minConstantBufferIdx + index;
        return idx;
    }

    uint CBTILayout::GetTGSMIndex() const
    {
        return m_pLayout->TGSMIdx;
    }

    uint CBTILayout::GetScratchSurfaceBindingTableIndex() const
    {
        IGC_ASSERT(m_pLayout != NULL);
        return SCRATCH_SPACE_BTI;
    }

    uint CBTILayout::GetStatelessBindingTableIndex() const
    {
        IGC_ASSERT(m_pLayout != NULL);
        return STATELESS_BTI;
    }

    uint CBTILayout::GetImmediateConstantBufferOffset() const
    {
        IGC_ASSERT(m_pLayout != NULL);
        return m_pLayout->immediateConstantBufferOffset;
    }

    uint CBTILayout::GetDrawIndirectBufferIndex() const
    {
        IGC_ASSERT(m_pLayout != NULL);
        return m_pLayout->indirectBufferOffset;
    }

    USC::SShaderStageBTLayout* COCLBTILayout::getModifiableLayout()
    {
        return const_cast<USC::SShaderStageBTLayout*>(m_pLayout);
    }

    EU_PIXEL_INTERPOLATOR_SIMD_MODE pixelInterpolatorSimDMode(SIMDMode simd)
    {
        if (simd == SIMDMode::SIMD8)
        {
            return EU_PI_MESSAGE_SIMD8;
        }
        else if (simd == SIMDMode::SIMD16)
        {
            return EU_PI_MESSAGE_SIMD16;
        }
        IGC_ASSERT(0);
        return EU_PI_MESSAGE_SIMD8;
    }

    unsigned int PixelInterpolator(
        unsigned int messageLength,
        unsigned int responseLength,
        unsigned int pass,
        EU_PIXEL_INTERPOLATOR_SIMD_MODE executionMode,
        EU_PIXEL_INTERPOLATOR_MESSAGE_TYPE messageType,
        EU_PIXEL_INTERPOLATOR_INTERPOLATION_MODE interpolationMode,
        const unsigned int sampleindex)
    {
        IGC_ASSERT(messageType >= 0);
        IGC_ASSERT(int(messageType) < 4);
        IGC_ASSERT(executionMode >= 0);
        IGC_ASSERT(int(executionMode) < 4);

        SEUPixelInterpolatorSampleIndexMessageDescriptorGen7_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.SampleIndex = sampleindex;
        messageDescriptor.DW0.All.MessageType = messageType;
        messageDescriptor.DW0.All.InterpolationMode = interpolationMode;
        messageDescriptor.DW0.All.SIMDMode = executionMode;
        messageDescriptor.DW0.All.HeaderPresent = false;
        messageDescriptor.DW0.All.SlotGroupSelect = pass;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.EndOfThread = false;

        return messageDescriptor.DW0.Value;
    }

    unsigned int PixelInterpolator(
        unsigned int messageLength,
        unsigned int responseLength,
        unsigned int pass,
        EU_PIXEL_INTERPOLATOR_SIMD_MODE executionMode,
        EU_PIXEL_INTERPOLATOR_MESSAGE_TYPE messageType,
        EU_PIXEL_INTERPOLATOR_INTERPOLATION_MODE interpolationMode,
        unsigned int perMessageXOffset,
        unsigned int perMessageYOffset)
    {
        IGC_ASSERT(messageType >= 0);
        IGC_ASSERT(int(messageType) < 4);
        IGC_ASSERT(executionMode >= 0);
        IGC_ASSERT(int(executionMode) < 4);

        SEUPixelInterpolatorOffsetMessageDescriptorGen7_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.MessageType = messageType;
        messageDescriptor.DW0.All.PerMessageXOffset = perMessageXOffset;
        messageDescriptor.DW0.All.PerMessageYOffset = perMessageYOffset;
        messageDescriptor.DW0.All.InterpolationMode = interpolationMode;
        messageDescriptor.DW0.All.SlotGroupSelect = pass;
        messageDescriptor.DW0.All.SIMDMode = executionMode;
        messageDescriptor.DW0.All.HeaderPresent = false;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.EndOfThread = false;

        return messageDescriptor.DW0.Value;
    }

    unsigned int PixelInterpolator(
        const DWORD messageLength,
        const DWORD responseLength,
        const DWORD pass,
        bool  IsCoarse,
        EU_PIXEL_INTERPOLATOR_SIMD_MODE executionMode,
        EU_PIXEL_INTERPOLATOR_MESSAGE_TYPE messageType,
        EU_PIXEL_INTERPOLATOR_INTERPOLATION_MODE interpolationMode)
    {
        SEUPixelInterpolatorMessageDescriptorGen7_0 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.MessageType = messageType;
        messageDescriptor.DW0.All.InterpolationMode = interpolationMode;
        messageDescriptor.DW0.All.SlotGroupSelect = pass;
        messageDescriptor.DW0.All.SIMDMode = executionMode;
        messageDescriptor.DW0.All.HeaderPresent = false;
        messageDescriptor.DW0.All.ResponseLength = responseLength;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        messageDescriptor.DW0.All.EndOfThread = false;
        messageDescriptor.DW0.All.ShadingRate = IsCoarse ? 1 : 0;

        return messageDescriptor.DW0.Value;
    }

    uint32_t VMEDescriptor(
        COMMON_ISA_VME_STREAM_MODE streamMode,
        const uint32_t bti,
        const uint32_t msgType,
        const uint32_t regs2snd,
        const uint32_t regs2rcv
    )
    {
        VMEMessageDescriptorGen8_0 messageDescriptor = { 0 };

        messageDescriptor.DW0.All.BindingTableIndex = bti;
        messageDescriptor.DW0.All.MessageType = msgType;
        messageDescriptor.DW0.All.StreamOutEnable = (streamMode == VME_STREAM_IN_OUT) || (streamMode == VME_STREAM_OUT);
        messageDescriptor.DW0.All.StreamInEnable = (streamMode == VME_STREAM_IN_OUT) || (streamMode == VME_STREAM_IN);
        messageDescriptor.DW0.All.HeaderPresent = true;
        messageDescriptor.DW0.All.MessageLength = regs2snd;
        messageDescriptor.DW0.All.ResponseLength = regs2rcv;

        return messageDescriptor.DW0.Value;
    }


    unsigned int PIPullPixelPayload(
        EU_PIXEL_INTERPOLATOR_SIMD_MODE executionMode,
        DWORD responseLength,
        DWORD messageLenght,
        bool inputCoverage,
        bool linearCentroidBary,
        bool linearCenterBary,
        bool perspectiveCentroid,
        bool perspectiveCenter,
        bool OutputCoverageMask)
    {
        union CoarseToPixelMappingMessageDescriptor
        {
            struct
            {
                unsigned int InputConverage : BITFIELD_BIT(0);
                unsigned int LinearCentroidBary : BITFIELD_BIT(1);
                unsigned int LinearCenterBary : BITFIELD_BIT(2);
                unsigned int PerspectiveCentroid : BITFIELD_BIT(3);
                unsigned int PerspectiveCenter : BITFIELD_BIT(4);
                unsigned int OutputCoverageMask : BITFIELD_BIT(5);
                unsigned int                        : BITFIELD_RANGE(6, 7);
                unsigned int PixelShaderPhase : BITFIELD_RANGE(8, 11);
                unsigned int MessageType : BITFIELD_RANGE(12, 13);
                unsigned int InterpolationMode : BITFIELD_BIT(14);
                unsigned int ShadingRate : BITFIELD_BIT(15);
                unsigned int SimdMode : BITFIELD_BIT(16);
                unsigned int                   : BITFIELD_RANGE(17, 18);
                unsigned int HeaderPresent : BITFIELD_BIT(19);
                unsigned int ResponseLength : BITFIELD_RANGE(20, 24);
                unsigned int MessageLength : BITFIELD_RANGE(25, 28);
                unsigned int                   : BITFIELD_RANGE(29, 30);
                unsigned int EndOfThread : BITFIELD_BIT(31);
            } All;

            unsigned int Value;
        };

        CoarseToPixelMappingMessageDescriptor messageDesc;
        messageDesc.Value = 0;
        messageDesc.All.ShadingRate = 1; // Coarse rate
        messageDesc.All.SimdMode = executionMode;
        messageDesc.All.InputConverage = inputCoverage;
        messageDesc.All.LinearCentroidBary = linearCentroidBary;
        messageDesc.All.LinearCenterBary = linearCenterBary;
        messageDesc.All.PerspectiveCentroid = perspectiveCentroid;
        messageDesc.All.PerspectiveCenter = perspectiveCenter;
        messageDesc.All.OutputCoverageMask = OutputCoverageMask;
        messageDesc.All.MessageLength = messageLenght;
        messageDesc.All.ResponseLength = responseLength;

        return messageDesc.Value;
    }

    uint URBFence()
    {
        URBFenceGen12 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.URBOpcode = EU_URB_OPCODE_FENCE;
        messageDescriptor.DW0.All.ResponseLength = 1;
        messageDescriptor.DW0.All.MessageLength = 1;

        return messageDescriptor.DW0.Value;
    }

    uint EOTGateway(const EU_GW_FENCE_PORTS fencePorts)
    {
        EOTMessageDescriptorGen12 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        // The only one subfunction is available so far.
        messageDescriptor.DW0.All.EOTSubfunction = 0;
        messageDescriptor.DW0.All.FenceDataPorts = fencePorts;
        messageDescriptor.DW0.All.ResponseLength = 0;
        messageDescriptor.DW0.All.MessageLength = 1;

        return messageDescriptor.DW0.Value;
    }

    uint BindlessThreadDispatch(
        const uint   messageLength,
        const uint   SIMDMode,
        const bool   IsTraceMessage,
        const bool   IsRayQueryMessage)
    {
        // TODO: move this to vISA
        IGC_ASSERT(messageLength > 0);
        IGC_ASSERT(messageLength < 16);

        TraceRayBTDMessageDescriptorGen12 messageDescriptor;
        memset(&messageDescriptor, 0, sizeof(messageDescriptor));

        messageDescriptor.DW0.All.SIMDMode = SIMDMode;
        messageDescriptor.DW0.All.MessageType = IsTraceMessage ? 0x0 : 0x1;
        // 'HeaderPresent' Must be programmed to 0
        messageDescriptor.DW0.All.HeaderPresent = 0;
        messageDescriptor.DW0.All.MessageLength = messageLength;
        // isRayQueryMessage can be set only for TraceRayMessage
        IGC_ASSERT(IsTraceMessage || !IsRayQueryMessage);
        messageDescriptor.DW0.All.ResponseLength = IsRayQueryMessage ? 1 : 0;

        return messageDescriptor.DW0.Value;
    }


} // namespace IGC