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
|
/*
* Copyright © 2018 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#include "nir.h"
#include "gl_nir_linker.h"
#include "compiler/glsl/ir_uniform.h" /* for gl_uniform_storage */
#include "linker_util.h"
#include "main/context.h"
#include "main/mtypes.h"
/**
* This file do the common link for GLSL uniforms, using NIR, instead of IR as
* the counter-part glsl/link_uniforms.cpp
*/
#define UNMAPPED_UNIFORM_LOC ~0u
/**
* Built-in / reserved GL variables names start with "gl_"
*/
static inline bool
is_gl_identifier(const char *s)
{
return s && s[0] == 'g' && s[1] == 'l' && s[2] == '_';
}
static void
nir_setup_uniform_remap_tables(struct gl_context *ctx,
struct gl_shader_program *prog)
{
prog->UniformRemapTable = rzalloc_array(prog,
struct gl_uniform_storage *,
prog->NumUniformRemapTable);
union gl_constant_value *data =
rzalloc_array(prog->data,
union gl_constant_value, prog->data->NumUniformDataSlots);
if (!prog->UniformRemapTable || !data) {
linker_error(prog, "Out of memory during linking.\n");
return;
}
prog->data->UniformDataSlots = data;
prog->data->UniformDataDefaults =
rzalloc_array(prog->data->UniformDataSlots,
union gl_constant_value, prog->data->NumUniformDataSlots);
unsigned data_pos = 0;
/* Reserve all the explicit locations of the active uniforms. */
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
if (uniform->is_shader_storage ||
glsl_get_base_type(uniform->type) == GLSL_TYPE_SUBROUTINE)
continue;
if (prog->data->UniformStorage[i].remap_location == UNMAPPED_UNIFORM_LOC)
continue;
/* How many new entries for this uniform? */
const unsigned entries = MAX2(1, uniform->array_elements);
unsigned num_slots = glsl_get_component_slots(uniform->type);
uniform->storage = &data[data_pos];
/* Set remap table entries point to correct gl_uniform_storage. */
for (unsigned j = 0; j < entries; j++) {
unsigned element_loc = uniform->remap_location + j;
prog->UniformRemapTable[element_loc] = uniform;
data_pos += num_slots;
}
}
/* Reserve locations for rest of the uniforms. */
link_util_update_empty_uniform_locations(prog);
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
if (uniform->is_shader_storage ||
glsl_get_base_type(uniform->type) == GLSL_TYPE_SUBROUTINE)
continue;
/* Built-in uniforms should not get any location. */
if (uniform->builtin)
continue;
/* Explicit ones have been set already. */
if (uniform->remap_location != UNMAPPED_UNIFORM_LOC)
continue;
/* How many entries for this uniform? */
const unsigned entries = MAX2(1, uniform->array_elements);
unsigned location =
link_util_find_empty_block(prog, &prog->data->UniformStorage[i]);
if (location == -1 || location + entries >= prog->NumUniformRemapTable) {
unsigned new_entries = entries;
if (location == -1)
location = prog->NumUniformRemapTable;
else
new_entries = location - prog->NumUniformRemapTable + entries;
/* resize remap table to fit new entries */
prog->UniformRemapTable =
reralloc(prog,
prog->UniformRemapTable,
struct gl_uniform_storage *,
prog->NumUniformRemapTable + new_entries);
prog->NumUniformRemapTable += new_entries;
}
/* set the base location in remap table for the uniform */
uniform->remap_location = location;
unsigned num_slots = glsl_get_component_slots(uniform->type);
if (uniform->block_index == -1)
uniform->storage = &data[data_pos];
/* Set remap table entries point to correct gl_uniform_storage. */
for (unsigned j = 0; j < entries; j++) {
unsigned element_loc = uniform->remap_location + j;
prog->UniformRemapTable[element_loc] = uniform;
if (uniform->block_index == -1)
data_pos += num_slots;
}
}
/* Reserve all the explicit locations of the active subroutine uniforms. */
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
if (glsl_get_base_type(uniform->type) != GLSL_TYPE_SUBROUTINE)
continue;
if (prog->data->UniformStorage[i].remap_location == UNMAPPED_UNIFORM_LOC)
continue;
/* How many new entries for this uniform? */
const unsigned entries =
MAX2(1, prog->data->UniformStorage[i].array_elements);
uniform->storage = &data[data_pos];
unsigned num_slots = glsl_get_component_slots(uniform->type);
unsigned mask = prog->data->linked_stages;
while (mask) {
const int j = u_bit_scan(&mask);
struct gl_program *p = prog->_LinkedShaders[j]->Program;
if (!prog->data->UniformStorage[i].opaque[j].active)
continue;
/* Set remap table entries point to correct gl_uniform_storage. */
for (unsigned k = 0; k < entries; k++) {
unsigned element_loc =
prog->data->UniformStorage[i].remap_location + k;
p->sh.SubroutineUniformRemapTable[element_loc] =
&prog->data->UniformStorage[i];
data_pos += num_slots;
}
}
}
/* reserve subroutine locations */
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
if (glsl_get_base_type(uniform->type) != GLSL_TYPE_SUBROUTINE)
continue;
if (prog->data->UniformStorage[i].remap_location !=
UNMAPPED_UNIFORM_LOC)
continue;
const unsigned entries =
MAX2(1, prog->data->UniformStorage[i].array_elements);
uniform->storage = &data[data_pos];
unsigned num_slots = glsl_get_component_slots(uniform->type);
unsigned mask = prog->data->linked_stages;
while (mask) {
const int j = u_bit_scan(&mask);
struct gl_program *p = prog->_LinkedShaders[j]->Program;
if (!prog->data->UniformStorage[i].opaque[j].active)
continue;
p->sh.SubroutineUniformRemapTable =
reralloc(p,
p->sh.SubroutineUniformRemapTable,
struct gl_uniform_storage *,
p->sh.NumSubroutineUniformRemapTable + entries);
for (unsigned k = 0; k < entries; k++) {
p->sh.SubroutineUniformRemapTable[p->sh.NumSubroutineUniformRemapTable + k] =
&prog->data->UniformStorage[i];
data_pos += num_slots;
}
prog->data->UniformStorage[i].remap_location =
p->sh.NumSubroutineUniformRemapTable;
p->sh.NumSubroutineUniformRemapTable += entries;
}
}
}
static void
mark_stage_as_active(struct gl_uniform_storage *uniform,
unsigned stage)
{
uniform->active_shader_mask |= 1 << stage;
}
/* Used to build a tree representing the glsl_type so that we can have a place
* to store the next index for opaque types. Array types are expanded so that
* they have a single child which is used for all elements of the array.
* Struct types have a child for each member. The tree is walked while
* processing a uniform so that we can recognise when an opaque type is
* encountered a second time in order to reuse the same range of indices that
* was reserved the first time. That way the sampler indices can be arranged
* so that members of an array are placed sequentially even if the array is an
* array of structs containing other opaque members.
*/
struct type_tree_entry {
/* For opaque types, this will be the next index to use. If we haven’t
* encountered this member yet, it will be UINT_MAX.
*/
unsigned next_index;
unsigned array_size;
struct type_tree_entry *parent;
struct type_tree_entry *next_sibling;
struct type_tree_entry *children;
};
struct nir_link_uniforms_state {
/* per-whole program */
unsigned num_hidden_uniforms;
unsigned num_values;
unsigned max_uniform_location;
unsigned next_subroutine;
/* per-shader stage */
unsigned next_image_index;
unsigned next_sampler_index;
unsigned num_shader_samplers;
unsigned num_shader_images;
unsigned num_shader_uniform_components;
unsigned shader_samplers_used;
unsigned shader_shadow_samplers;
unsigned shader_storage_blocks_write_access;
struct gl_program_parameter_list *params;
/* per-variable */
nir_variable *current_var;
const struct glsl_type *current_ifc_type;
int offset;
bool var_is_in_block;
bool set_top_level_array;
int top_level_array_size;
int top_level_array_stride;
struct type_tree_entry *current_type;
struct hash_table *uniform_hash;
};
static void
add_parameter(struct gl_uniform_storage *uniform,
struct gl_context *ctx,
struct gl_shader_program *prog,
const struct glsl_type *type,
struct nir_link_uniforms_state *state)
{
if (!state->params || uniform->is_shader_storage || glsl_contains_opaque(type))
return;
unsigned num_params = glsl_get_aoa_size(type);
num_params = MAX2(num_params, 1);
num_params *= glsl_get_matrix_columns(glsl_without_array(type));
bool is_dual_slot = glsl_type_is_dual_slot(glsl_without_array(type));
if (is_dual_slot)
num_params *= 2;
struct gl_program_parameter_list *params = state->params;
int base_index = params->NumParameters;
_mesa_reserve_parameter_storage(params, num_params);
if (ctx->Const.PackedDriverUniformStorage) {
for (unsigned i = 0; i < num_params; i++) {
unsigned dmul = glsl_type_is_64bit(glsl_without_array(type)) ? 2 : 1;
unsigned comps = glsl_get_vector_elements(glsl_without_array(type)) * dmul;
if (is_dual_slot) {
if (i & 0x1)
comps -= 4;
else
comps = 4;
}
_mesa_add_parameter(params, PROGRAM_UNIFORM, uniform->name, comps,
glsl_get_gl_type(type), NULL, NULL, false);
}
} else {
for (unsigned i = 0; i < num_params; i++) {
_mesa_add_parameter(params, PROGRAM_UNIFORM, uniform->name, 4,
glsl_get_gl_type(type), NULL, NULL, true);
}
}
/* Each Parameter will hold the index to the backing uniform storage.
* This avoids relying on names to match parameters and uniform
* storages.
*/
for (unsigned i = 0; i < num_params; i++) {
struct gl_program_parameter *param = ¶ms->Parameters[base_index + i];
param->UniformStorageIndex = uniform - prog->data->UniformStorage;
param->MainUniformStorageIndex = state->current_var->data.location;
}
}
static unsigned
get_next_index(struct nir_link_uniforms_state *state,
const struct gl_uniform_storage *uniform,
unsigned *next_index, bool *initialised)
{
/* If we’ve already calculated an index for this member then we can just
* offset from there.
*/
if (state->current_type->next_index == UINT_MAX) {
/* Otherwise we need to reserve enough indices for all of the arrays
* enclosing this member.
*/
unsigned array_size = 1;
for (const struct type_tree_entry *p = state->current_type;
p;
p = p->parent) {
array_size *= p->array_size;
}
state->current_type->next_index = *next_index;
*next_index += array_size;
*initialised = true;
} else
*initialised = false;
unsigned index = state->current_type->next_index;
state->current_type->next_index += MAX2(1, uniform->array_elements);
return index;
}
static bool
find_and_update_named_uniform_storage(struct gl_context *ctx,
struct gl_shader_program *prog,
struct nir_link_uniforms_state *state,
nir_variable *var, char **name,
size_t name_length,
const struct glsl_type *type,
unsigned stage, bool *first_element)
{
/* gl_uniform_storage can cope with one level of array, so if the type is a
* composite type or an array where each element occupies more than one
* location than we need to recursively process it.
*/
if (glsl_type_is_struct_or_ifc(type) ||
(glsl_type_is_array(type) &&
(glsl_type_is_array(glsl_get_array_element(type)) ||
glsl_type_is_struct_or_ifc(glsl_get_array_element(type))))) {
struct type_tree_entry *old_type = state->current_type;
state->current_type = old_type->children;
/* Shader storage block unsized arrays: add subscript [0] to variable
* names.
*/
unsigned length = glsl_get_length(type);
if (glsl_type_is_unsized_array(type))
length = 1;
bool result = false;
for (unsigned i = 0; i < length; i++) {
const struct glsl_type *field_type;
size_t new_length = name_length;
if (glsl_type_is_struct_or_ifc(type)) {
field_type = glsl_get_struct_field(type, i);
/* Append '.field' to the current variable name. */
if (name) {
ralloc_asprintf_rewrite_tail(name, &new_length, ".%s",
glsl_get_struct_elem_name(type, i));
}
} else {
field_type = glsl_get_array_element(type);
/* Append the subscript to the current variable name */
if (name)
ralloc_asprintf_rewrite_tail(name, &new_length, "[%u]", i);
}
result = find_and_update_named_uniform_storage(ctx, prog, state,
var, name, new_length,
field_type, stage,
first_element);
if (glsl_type_is_struct_or_ifc(type))
state->current_type = state->current_type->next_sibling;
if (!result) {
state->current_type = old_type;
return false;
}
}
state->current_type = old_type;
return result;
} else {
struct hash_entry *entry =
_mesa_hash_table_search(state->uniform_hash, *name);
if (entry) {
unsigned i = (unsigned) (intptr_t) entry->data;
mark_stage_as_active(&prog->data->UniformStorage[i], stage);
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
if (*first_element && !state->var_is_in_block) {
*first_element = false;
var->data.location = uniform - prog->data->UniformStorage;
}
unsigned values = glsl_get_component_slots(type);
const struct glsl_type *type_no_array = glsl_without_array(type);
if (glsl_type_is_sampler(type_no_array)) {
struct gl_linked_shader *sh = prog->_LinkedShaders[stage];
bool init_idx;
unsigned sampler_index =
get_next_index(state, uniform, &state->next_sampler_index,
&init_idx);
/* Samplers (bound or bindless) are counted as two components as
* specified by ARB_bindless_texture.
*/
state->num_shader_samplers += values / 2;
uniform->opaque[stage].active = true;
uniform->opaque[stage].index = sampler_index;
if (init_idx) {
const unsigned shadow =
glsl_sampler_type_is_shadow(type_no_array);
for (unsigned i = sampler_index;
i < MIN2(state->next_sampler_index, MAX_SAMPLERS);
i++) {
sh->Program->sh.SamplerTargets[i] =
glsl_get_sampler_target(type_no_array);
state->shader_samplers_used |= 1U << i;
state->shader_shadow_samplers |= shadow << i;
}
}
} else if (glsl_type_is_image(type_no_array)) {
struct gl_linked_shader *sh = prog->_LinkedShaders[stage];
int image_index = state->next_image_index;
/* TODO: handle structs when bindless support is added */
state->next_image_index += MAX2(1, uniform->array_elements);
/* Images (bound or bindless) are counted as two components as
* specified by ARB_bindless_texture.
*/
state->num_shader_images += values / 2;
uniform->opaque[stage].active = true;
uniform->opaque[stage].index = image_index;
/* Set image access qualifiers */
enum gl_access_qualifier image_access =
state->current_var->data.access;
const GLenum access =
(image_access & ACCESS_NON_WRITEABLE) ?
((image_access & ACCESS_NON_READABLE) ? GL_NONE :
GL_READ_ONLY) :
((image_access & ACCESS_NON_READABLE) ? GL_WRITE_ONLY :
GL_READ_WRITE);
for (unsigned i = image_index;
i < MIN2(state->next_image_index, MAX_IMAGE_UNIFORMS);
i++) {
sh->Program->sh.ImageAccess[i] = access;
}
}
uniform->active_shader_mask |= 1 << stage;
if (!state->var_is_in_block)
add_parameter(uniform, ctx, prog, type, state);
return true;
}
}
return false;
}
/**
* Finds, returns, and updates the stage info for any uniform in UniformStorage
* defined by @var. For GLSL this is done using the name, for SPIR-V in general
* is this done using the explicit location, except:
*
* * UBOs/SSBOs: as they lack explicit location, binding is used to locate
* them. That means that more that one entry at the uniform storage can be
* found. In that case all of them are updated, and the first entry is
* returned, in order to update the location of the nir variable.
*
* * Special uniforms: like atomic counters. They lack a explicit location,
* so they are skipped. They will be handled and assigned a location later.
*
*/
static bool
find_and_update_previous_uniform_storage(struct gl_context *ctx,
struct gl_shader_program *prog,
struct nir_link_uniforms_state *state,
nir_variable *var, char *name,
const struct glsl_type *type,
unsigned stage)
{
if (!prog->data->spirv) {
bool first_element = true;
char *name_tmp = ralloc_strdup(NULL, name);
bool r = find_and_update_named_uniform_storage(ctx, prog, state, var,
&name_tmp,
strlen(name_tmp), type,
stage, &first_element);
ralloc_free(name_tmp);
return r;
}
if (nir_variable_is_in_block(var)) {
struct gl_uniform_storage *uniform = NULL;
ASSERTED unsigned num_blks = nir_variable_is_in_ubo(var) ?
prog->data->NumUniformBlocks :
prog->data->NumShaderStorageBlocks;
struct gl_uniform_block *blks = nir_variable_is_in_ubo(var) ?
prog->data->UniformBlocks : prog->data->ShaderStorageBlocks;
bool result = false;
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
/* UniformStorage contains both variables from ubos and ssbos */
if ( prog->data->UniformStorage[i].is_shader_storage !=
nir_variable_is_in_ssbo(var))
continue;
int block_index = prog->data->UniformStorage[i].block_index;
if (block_index != -1) {
assert(block_index < num_blks);
if (var->data.binding == blks[block_index].Binding) {
if (!uniform)
uniform = &prog->data->UniformStorage[i];
mark_stage_as_active(&prog->data->UniformStorage[i],
stage);
result = true;
}
}
}
if (result)
var->data.location = uniform - prog->data->UniformStorage;
return result;
}
/* Beyond blocks, there are still some corner cases of uniforms without
* location (ie: atomic counters) that would have a initial location equal
* to -1. We just return on that case. Those uniforms will be handled
* later.
*/
if (var->data.location == -1)
return false;
/* TODO: following search can be problematic with shaders with a lot of
* uniforms. Would it be better to use some type of hash
*/
for (unsigned i = 0; i < prog->data->NumUniformStorage; i++) {
if (prog->data->UniformStorage[i].remap_location == var->data.location) {
mark_stage_as_active(&prog->data->UniformStorage[i], stage);
struct gl_uniform_storage *uniform = &prog->data->UniformStorage[i];
var->data.location = uniform - prog->data->UniformStorage;
add_parameter(uniform, ctx, prog, var->type, state);
return true;
}
}
return false;
}
static struct type_tree_entry *
build_type_tree_for_type(const struct glsl_type *type)
{
struct type_tree_entry *entry = malloc(sizeof *entry);
entry->array_size = 1;
entry->next_index = UINT_MAX;
entry->children = NULL;
entry->next_sibling = NULL;
entry->parent = NULL;
if (glsl_type_is_array(type)) {
entry->array_size = glsl_get_length(type);
entry->children = build_type_tree_for_type(glsl_get_array_element(type));
entry->children->parent = entry;
} else if (glsl_type_is_struct_or_ifc(type)) {
struct type_tree_entry *last = NULL;
for (unsigned i = 0; i < glsl_get_length(type); i++) {
const struct glsl_type *field_type = glsl_get_struct_field(type, i);
struct type_tree_entry *field_entry =
build_type_tree_for_type(field_type);
if (last == NULL)
entry->children = field_entry;
else
last->next_sibling = field_entry;
field_entry->parent = entry;
last = field_entry;
}
}
return entry;
}
static void
free_type_tree(struct type_tree_entry *entry)
{
struct type_tree_entry *p, *next;
for (p = entry->children; p; p = next) {
next = p->next_sibling;
free_type_tree(p);
}
free(entry);
}
static void
hash_free_uniform_name(struct hash_entry *entry)
{
free((void*)entry->key);
}
/**
* Creates the neccessary entries in UniformStorage for the uniform. Returns
* the number of locations used or -1 on failure.
*/
static int
nir_link_uniform(struct gl_context *ctx,
struct gl_shader_program *prog,
struct gl_program *stage_program,
gl_shader_stage stage,
const struct glsl_type *type,
unsigned index_in_parent,
int location,
struct nir_link_uniforms_state *state,
char **name, size_t name_length)
{
struct gl_uniform_storage *uniform = NULL;
if (state->set_top_level_array &&
nir_variable_is_in_ssbo(state->current_var)) {
/* Type is the top level SSBO member */
if (glsl_type_is_array(type) &&
(glsl_type_is_array(glsl_get_array_element(type)) ||
glsl_type_is_struct_or_ifc(glsl_get_array_element(type)))) {
/* Type is a top-level array (array of aggregate types) */
state->top_level_array_size = glsl_get_length(type);
state->top_level_array_stride = glsl_get_explicit_stride(type);
} else {
state->top_level_array_size = 1;
state->top_level_array_stride = 0;
}
state->set_top_level_array = false;
}
/* gl_uniform_storage can cope with one level of array, so if the type is a
* composite type or an array where each element occupies more than one
* location than we need to recursively process it.
*/
if (glsl_type_is_struct_or_ifc(type) ||
(glsl_type_is_array(type) &&
(glsl_type_is_array(glsl_get_array_element(type)) ||
glsl_type_is_struct_or_ifc(glsl_get_array_element(type))))) {
int location_count = 0;
struct type_tree_entry *old_type = state->current_type;
unsigned int struct_base_offset = state->offset;
state->current_type = old_type->children;
/* Shader storage block unsized arrays: add subscript [0] to variable
* names.
*/
unsigned length = glsl_get_length(type);
if (glsl_type_is_unsized_array(type))
length = 1;
for (unsigned i = 0; i < length; i++) {
const struct glsl_type *field_type;
size_t new_length = name_length;
if (glsl_type_is_struct_or_ifc(type)) {
field_type = glsl_get_struct_field(type, i);
/* Use the offset inside the struct only for variables backed by
* a buffer object. For variables not backed by a buffer object,
* offset is -1.
*/
if (state->var_is_in_block) {
if (prog->data->spirv) {
state->offset =
struct_base_offset + glsl_get_struct_field_offset(type, i);
} else if (glsl_get_struct_field_offset(type, i) != -1 &&
type == state->current_ifc_type) {
state->offset = glsl_get_struct_field_offset(type, i);
}
if (glsl_type_is_interface(type))
state->set_top_level_array = true;
}
/* Append '.field' to the current variable name. */
if (name) {
ralloc_asprintf_rewrite_tail(name, &new_length, ".%s",
glsl_get_struct_elem_name(type, i));
}
} else {
field_type = glsl_get_array_element(type);
/* Append the subscript to the current variable name */
if (name)
ralloc_asprintf_rewrite_tail(name, &new_length, "[%u]", i);
}
int entries = nir_link_uniform(ctx, prog, stage_program, stage,
field_type, i, location,
state, name, new_length);
if (entries == -1)
return -1;
if (location != -1)
location += entries;
location_count += entries;
if (glsl_type_is_struct_or_ifc(type))
state->current_type = state->current_type->next_sibling;
}
state->current_type = old_type;
return location_count;
} else {
/* Create a new uniform storage entry */
prog->data->UniformStorage =
reralloc(prog->data,
prog->data->UniformStorage,
struct gl_uniform_storage,
prog->data->NumUniformStorage + 1);
if (!prog->data->UniformStorage) {
linker_error(prog, "Out of memory during linking.\n");
return -1;
}
uniform = &prog->data->UniformStorage[prog->data->NumUniformStorage];
prog->data->NumUniformStorage++;
/* Initialize its members */
memset(uniform, 0x00, sizeof(struct gl_uniform_storage));
uniform->name =
name ? ralloc_strdup(prog->data->UniformStorage, *name) : NULL;
const struct glsl_type *type_no_array = glsl_without_array(type);
if (glsl_type_is_array(type)) {
uniform->type = type_no_array;
uniform->array_elements = glsl_get_length(type);
} else {
uniform->type = type;
uniform->array_elements = 0;
}
uniform->top_level_array_size = state->top_level_array_size;
uniform->top_level_array_stride = state->top_level_array_stride;
uniform->active_shader_mask |= 1 << stage;
if (location >= 0) {
/* Uniform has an explicit location */
uniform->remap_location = location;
} else {
uniform->remap_location = UNMAPPED_UNIFORM_LOC;
}
uniform->hidden = state->current_var->data.how_declared == nir_var_hidden;
if (uniform->hidden)
state->num_hidden_uniforms++;
uniform->is_shader_storage = nir_variable_is_in_ssbo(state->current_var);
/* Set fields whose default value depend on the variable being inside a
* block.
*
* From the OpenGL 4.6 spec, 7.3 Program objects:
*
* "For the property ARRAY_STRIDE, ... For active variables not declared
* as an array of basic types, zero is written to params. For active
* variables not backed by a buffer object, -1 is written to params,
* regardless of the variable type."
*
* "For the property MATRIX_STRIDE, ... For active variables not declared
* as a matrix or array of matrices, zero is written to params. For active
* variables not backed by a buffer object, -1 is written to params,
* regardless of the variable type."
*
* For the property IS_ROW_MAJOR, ... For active variables backed by a
* buffer object, declared as a single matrix or array of matrices, and
* stored in row-major order, one is written to params. For all other
* active variables, zero is written to params.
*/
uniform->array_stride = -1;
uniform->matrix_stride = -1;
uniform->row_major = false;
if (state->var_is_in_block) {
uniform->array_stride = glsl_type_is_array(type) ?
glsl_get_explicit_stride(type) : 0;
if (glsl_type_is_matrix(uniform->type)) {
uniform->matrix_stride = glsl_get_explicit_stride(uniform->type);
uniform->row_major = glsl_matrix_type_is_row_major(uniform->type);
} else {
uniform->matrix_stride = 0;
}
if (!prog->data->spirv) {
bool use_std430 = ctx->Const.UseSTD430AsDefaultPacking;
const enum glsl_interface_packing packing =
glsl_get_internal_ifc_packing(state->current_var->interface_type,
use_std430);
unsigned alignment =
glsl_get_std140_base_alignment(type, uniform->row_major);
if (packing == GLSL_INTERFACE_PACKING_STD430) {
alignment =
glsl_get_std430_base_alignment(type, uniform->row_major);
}
state->offset = glsl_align(state->offset, alignment);
}
}
uniform->offset = state->var_is_in_block ? state->offset : -1;
int buffer_block_index = -1;
/* If the uniform is inside a uniform block determine its block index by
* comparing the bindings, we can not use names.
*/
if (state->var_is_in_block) {
struct gl_uniform_block *blocks = nir_variable_is_in_ssbo(state->current_var) ?
prog->data->ShaderStorageBlocks : prog->data->UniformBlocks;
int num_blocks = nir_variable_is_in_ssbo(state->current_var) ?
prog->data->NumShaderStorageBlocks : prog->data->NumUniformBlocks;
if (!prog->data->spirv) {
bool is_interface_array =
glsl_without_array(state->current_var->type) == state->current_var->interface_type &&
glsl_type_is_array(state->current_var->type);
const char *ifc_name =
glsl_get_type_name(state->current_var->interface_type);
if (is_interface_array) {
unsigned l = strlen(ifc_name);
for (unsigned i = 0; i < num_blocks; i++) {
if (strncmp(ifc_name, blocks[i].Name, l) == 0 &&
blocks[i].Name[l] == '[') {
buffer_block_index = i;
break;
}
}
} else {
for (unsigned i = 0; i < num_blocks; i++) {
if (strcmp(ifc_name, blocks[i].Name) == 0) {
buffer_block_index = i;
break;
}
}
}
/* Compute the next offset. */
bool use_std430 = ctx->Const.UseSTD430AsDefaultPacking;
const enum glsl_interface_packing packing =
glsl_get_internal_ifc_packing(state->current_var->interface_type,
use_std430);
if (packing == GLSL_INTERFACE_PACKING_STD430)
state->offset += glsl_get_std430_size(type, uniform->row_major);
else
state->offset += glsl_get_std140_size(type, uniform->row_major);
} else {
for (unsigned i = 0; i < num_blocks; i++) {
if (state->current_var->data.binding == blocks[i].Binding) {
buffer_block_index = i;
break;
}
}
/* Compute the next offset. */
state->offset += glsl_get_explicit_size(type, true);
}
assert(buffer_block_index >= 0);
}
uniform->block_index = buffer_block_index;
/* @FIXME: the initialization of the following will be done as we
* implement support for their specific features, like SSBO, atomics,
* etc.
*/
uniform->builtin = is_gl_identifier(uniform->name);
uniform->atomic_buffer_index = -1;
uniform->is_bindless = false;
/* The following are not for features not supported by ARB_gl_spirv */
uniform->num_compatible_subroutines = 0;
unsigned entries = MAX2(1, uniform->array_elements);
unsigned values = glsl_get_component_slots(type);
if (glsl_type_is_sampler(type_no_array)) {
bool init_idx;
int sampler_index =
get_next_index(state, uniform, &state->next_sampler_index,
&init_idx);
/* Samplers (bound or bindless) are counted as two components as
* specified by ARB_bindless_texture.
*/
state->num_shader_samplers += values / 2;
uniform->opaque[stage].active = true;
uniform->opaque[stage].index = sampler_index;
if (init_idx) {
const unsigned shadow = glsl_sampler_type_is_shadow(type_no_array);
for (unsigned i = sampler_index;
i < MIN2(state->next_sampler_index, MAX_SAMPLERS);
i++) {
stage_program->sh.SamplerTargets[i] =
glsl_get_sampler_target(type_no_array);
state->shader_samplers_used |= 1U << i;
state->shader_shadow_samplers |= shadow << i;
}
}
state->num_values += values;
} else if (glsl_type_is_image(type_no_array)) {
/* @FIXME: image_index should match that of the same image
* uniform in other shaders. This means we need to match image
* uniforms by location (GLSL does it by variable name, but we
* want to avoid that).
*/
int image_index = state->next_image_index;
state->next_image_index += entries;
/* Images (bound or bindless) are counted as two components as
* specified by ARB_bindless_texture.
*/
state->num_shader_images += values / 2;
uniform->opaque[stage].active = true;
uniform->opaque[stage].index = image_index;
/* Set image access qualifiers */
enum gl_access_qualifier image_access =
state->current_var->data.access;
const GLenum access =
(image_access & ACCESS_NON_WRITEABLE) ?
((image_access & ACCESS_NON_READABLE) ? GL_NONE :
GL_READ_ONLY) :
((image_access & ACCESS_NON_READABLE) ? GL_WRITE_ONLY :
GL_READ_WRITE);
for (unsigned i = image_index;
i < MIN2(state->next_image_index, MAX_IMAGE_UNIFORMS);
i++) {
stage_program->sh.ImageAccess[i] = access;
}
if (!uniform->is_shader_storage) {
state->num_shader_uniform_components += values;
state->num_values += values;
}
} else {
if (glsl_get_base_type(type_no_array) == GLSL_TYPE_SUBROUTINE) {
uniform->opaque[stage].index = state->next_subroutine;
uniform->opaque[stage].active = true;
prog->_LinkedShaders[stage]->Program->sh.NumSubroutineUniforms++;
/* Increment the subroutine index by 1 for non-arrays and by the
* number of array elements for arrays.
*/
state->next_subroutine += MAX2(1, uniform->array_elements);
}
if (!state->var_is_in_block && !is_gl_identifier(uniform->name)) {
state->num_shader_uniform_components += values;
state->num_values += values;
}
}
if (uniform->remap_location != UNMAPPED_UNIFORM_LOC &&
state->max_uniform_location < uniform->remap_location + entries)
state->max_uniform_location = uniform->remap_location + entries;
if (!state->var_is_in_block)
add_parameter(uniform, ctx, prog, type, state);
if (name) {
_mesa_hash_table_insert(state->uniform_hash, strdup(*name),
(void *) (intptr_t)
(prog->data->NumUniformStorage - 1));
}
return MAX2(uniform->array_elements, 1);
}
}
bool
gl_nir_link_uniforms(struct gl_context *ctx,
struct gl_shader_program *prog,
bool fill_parameters)
{
/* First free up any previous UniformStorage items */
ralloc_free(prog->data->UniformStorage);
prog->data->UniformStorage = NULL;
prog->data->NumUniformStorage = 0;
/* Iterate through all linked shaders */
struct nir_link_uniforms_state state = {0,};
state.uniform_hash = _mesa_hash_table_create(NULL, _mesa_hash_string,
_mesa_key_string_equal);
for (unsigned shader_type = 0; shader_type < MESA_SHADER_STAGES; shader_type++) {
struct gl_linked_shader *sh = prog->_LinkedShaders[shader_type];
if (!sh)
continue;
nir_shader *nir = sh->Program->nir;
assert(nir);
state.next_image_index = 0;
state.next_sampler_index = 0;
state.num_shader_samplers = 0;
state.num_shader_images = 0;
state.num_shader_uniform_components = 0;
state.shader_storage_blocks_write_access = 0;
state.shader_samplers_used = 0;
state.shader_shadow_samplers = 0;
state.params = fill_parameters ? sh->Program->Parameters : NULL;
nir_foreach_variable(var, &nir->uniforms) {
state.current_var = var;
state.current_ifc_type = NULL;
state.offset = 0;
state.var_is_in_block = nir_variable_is_in_block(var);
state.set_top_level_array = false;
state.top_level_array_size = 0;
state.top_level_array_stride = 0;
/*
* From ARB_program_interface spec, issue (16):
*
* "RESOLVED: We will follow the default rule for enumerating block
* members in the OpenGL API, which is:
*
* * If a variable is a member of an interface block without an
* instance name, it is enumerated using just the variable name.
*
* * If a variable is a member of an interface block with an
* instance name, it is enumerated as "BlockName.Member", where
* "BlockName" is the name of the interface block (not the
* instance name) and "Member" is the name of the variable.
*
* For example, in the following code:
*
* uniform Block1 {
* int member1;
* };
* uniform Block2 {
* int member2;
* } instance2;
* uniform Block3 {
* int member3;
* } instance3[2]; // uses two separate buffer bindings
*
* the three uniforms (if active) are enumerated as "member1",
* "Block2.member2", and "Block3.member3"."
*
* Note that in the last example, with an array of ubo, only one
* uniform is generated. For that reason, while unrolling the
* uniforms of a ubo, or the variables of a ssbo, we need to treat
* arrays of instance as a single block.
*/
char *name;
const struct glsl_type *type = var->type;
if (state.var_is_in_block &&
((!prog->data->spirv && glsl_without_array(type) == var->interface_type) ||
(prog->data->spirv && type == var->interface_type))) {
type = glsl_without_array(var->type);
state.current_ifc_type = type;
name = ralloc_strdup(NULL, glsl_get_type_name(type));
} else {
state.set_top_level_array = true;
name = ralloc_strdup(NULL, var->name);
}
struct type_tree_entry *type_tree =
build_type_tree_for_type(type);
state.current_type = type_tree;
int location = var->data.location;
struct gl_uniform_block *blocks;
int num_blocks;
int buffer_block_index = -1;
if (!prog->data->spirv && state.var_is_in_block) {
/* If the uniform is inside a uniform block determine its block index by
* comparing the bindings, we can not use names.
*/
blocks = nir_variable_is_in_ssbo(state.current_var) ?
prog->data->ShaderStorageBlocks : prog->data->UniformBlocks;
num_blocks = nir_variable_is_in_ssbo(state.current_var) ?
prog->data->NumShaderStorageBlocks : prog->data->NumUniformBlocks;
bool is_interface_array =
glsl_without_array(state.current_var->type) == state.current_var->interface_type &&
glsl_type_is_array(state.current_var->type);
const char *ifc_name =
glsl_get_type_name(state.current_var->interface_type);
if (is_interface_array) {
unsigned l = strlen(ifc_name);
for (unsigned i = 0; i < num_blocks; i++) {
if (strncmp(ifc_name, blocks[i].Name, l) == 0 &&
blocks[i].Name[l] == '[') {
buffer_block_index = i;
blocks[i].stageref |= 1U << shader_type;
}
}
} else {
for (unsigned i = 0; i < num_blocks; i++) {
if (strcmp(ifc_name, blocks[i].Name) == 0) {
buffer_block_index = i;
blocks[i].stageref |= 1U << shader_type;
break;
}
}
}
if (nir_variable_is_in_ssbo(var) &&
!(var->data.access & ACCESS_NON_WRITEABLE)) {
unsigned array_size = is_interface_array ?
glsl_get_length(var->type) : 1;
STATIC_ASSERT(MAX_SHADER_STORAGE_BUFFERS <= 32);
/* Shaders that use too many SSBOs will fail to compile, which
* we don't care about.
*
* This is true for shaders that do not use too many SSBOs:
*/
if (buffer_block_index + array_size <= 32) {
state.shader_storage_blocks_write_access |=
u_bit_consecutive(buffer_block_index, array_size);
}
}
}
if (!prog->data->spirv && state.var_is_in_block &&
glsl_without_array(state.current_var->type) != state.current_var->interface_type) {
bool found = false;
char sentinel = '\0';
if (glsl_type_is_struct(state.current_var->type)) {
sentinel = '.';
} else if (glsl_type_is_array(state.current_var->type) &&
(glsl_type_is_array(glsl_get_array_element(state.current_var->type))
|| glsl_type_is_struct(glsl_without_array(state.current_var->type)))) {
sentinel = '[';
}
const unsigned l = strlen(state.current_var->name);
for (unsigned i = 0; i < num_blocks; i++) {
for (unsigned j = 0; j < blocks[i].NumUniforms; j++) {
if (sentinel) {
const char *begin = blocks[i].Uniforms[j].Name;
const char *end = strchr(begin, sentinel);
if (end == NULL)
continue;
if ((ptrdiff_t) l != (end - begin))
continue;
found = strncmp(state.current_var->name, begin, l) == 0;
} else {
found = strcmp(state.current_var->name, blocks[i].Uniforms[j].Name) == 0;
}
if (found) {
location = j;
blocks[i].stageref |= 1U << shader_type;
break;
}
}
if (found)
break;
}
assert(found);
const struct gl_uniform_block *const block =
&blocks[buffer_block_index];
assert(location != -1);
const struct gl_uniform_buffer_variable *const ubo_var =
&block->Uniforms[location];
state.offset = ubo_var->Offset;
var->data.location = location;
}
/* Check if the uniform has been processed already for
* other stage. If so, validate they are compatible and update
* the active stage mask.
*/
if (find_and_update_previous_uniform_storage(ctx, prog, &state, var,
name, type, shader_type)) {
ralloc_free(name);
free_type_tree(type_tree);
continue;
}
/* From now on the variable’s location will be its uniform index */
if (!state.var_is_in_block)
var->data.location = prog->data->NumUniformStorage;
else
location = -1;
int res = nir_link_uniform(ctx, prog, sh->Program, shader_type, type,
0, location,
&state,
!prog->data->spirv ? &name : NULL,
!prog->data->spirv ? strlen(name) : 0);
free_type_tree(type_tree);
ralloc_free(name);
if (res == -1)
return false;
}
if (state.num_shader_samplers >
ctx->Const.Program[shader_type].MaxTextureImageUnits) {
linker_error(prog, "Too many %s shader texture samplers\n",
_mesa_shader_stage_to_string(shader_type));
continue;
}
if (state.num_shader_images >
ctx->Const.Program[shader_type].MaxImageUniforms) {
linker_error(prog, "Too many %s shader image uniforms (%u > %u)\n",
_mesa_shader_stage_to_string(shader_type),
state.num_shader_images,
ctx->Const.Program[shader_type].MaxImageUniforms);
continue;
}
sh->Program->SamplersUsed = state.shader_samplers_used;
sh->Program->sh.ShaderStorageBlocksWriteAccess =
state.shader_storage_blocks_write_access;
sh->shadow_samplers = state.shader_shadow_samplers;
sh->Program->info.num_textures = state.num_shader_samplers;
sh->Program->info.num_images = state.num_shader_images;
sh->num_uniform_components = state.num_shader_uniform_components;
sh->num_combined_uniform_components = sh->num_uniform_components;
}
prog->data->NumHiddenUniforms = state.num_hidden_uniforms;
prog->NumUniformRemapTable = state.max_uniform_location;
prog->data->NumUniformDataSlots = state.num_values;
nir_setup_uniform_remap_tables(ctx, prog);
gl_nir_set_uniform_initializers(ctx, prog);
_mesa_hash_table_destroy(state.uniform_hash, hash_free_uniform_name);
return true;
}
|