-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvn_protocol.py
More file actions
executable file
·1681 lines (1441 loc) · 58.5 KB
/
vn_protocol.py
File metadata and controls
executable file
·1681 lines (1441 loc) · 58.5 KB
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
#!/usr/bin/env python3
# Copyright 2020 Google LLC
# SPDX-License-Identifier: MIT
import argparse
import copy
from pathlib import Path
from mako.lookup import TemplateLookup
from mako.template import Template
from vkxml import VkRegistry, VkType, VkVariable
VN_PROTOCOL_DIR = Path(__file__).resolve().parent
VN_TEMPLATE_DIR = VN_PROTOCOL_DIR.joinpath('templates')
VN_TEMPLATE_LOOKUP = TemplateLookup(str(VN_TEMPLATE_DIR))
VN_PROTOCOL_VK_XML = VN_PROTOCOL_DIR.joinpath('xmls/vk.xml')
VN_PROTOCOL_PRIVATE_XMLS = [
VN_PROTOCOL_DIR.joinpath('xmls/VK_EXT_command_serialization.xml'),
VN_PROTOCOL_DIR.joinpath('xmls/VK_MESA_venus_protocol.xml'),
]
# This is bumped whenever a backward-incompatible change is made, and please
# ensure to clean up all the existing WAs before bumping this up.
VN_WIRE_FORMAT_VERSION = 1
# list of supported extensions
VK_XML_EXTENSION_LIST = [
# Venus extensions
'VK_EXT_command_serialization',
'VK_MESA_venus_protocol',
# promoted to VK_VERSION_1_1
'VK_KHR_16bit_storage',
'VK_KHR_bind_memory2',
'VK_KHR_dedicated_allocation',
'VK_KHR_descriptor_update_template',
'VK_KHR_device_group',
'VK_KHR_device_group_creation',
'VK_KHR_external_fence',
'VK_KHR_external_fence_capabilities',
'VK_KHR_external_memory',
'VK_KHR_external_memory_capabilities',
'VK_KHR_external_semaphore',
'VK_KHR_external_semaphore_capabilities',
'VK_KHR_get_memory_requirements2',
'VK_KHR_get_physical_device_properties2',
'VK_KHR_maintenance1',
'VK_KHR_maintenance2',
'VK_KHR_maintenance3',
'VK_KHR_multiview',
'VK_KHR_relaxed_block_layout',
'VK_KHR_sampler_ycbcr_conversion',
'VK_KHR_shader_draw_parameters',
'VK_KHR_storage_buffer_storage_class',
'VK_KHR_variable_pointers',
# promoted to VK_VERSION_1_2
'VK_KHR_8bit_storage',
'VK_KHR_buffer_device_address',
'VK_KHR_create_renderpass2',
'VK_KHR_depth_stencil_resolve',
'VK_KHR_draw_indirect_count',
'VK_KHR_driver_properties',
'VK_KHR_image_format_list',
'VK_KHR_imageless_framebuffer',
'VK_KHR_sampler_mirror_clamp_to_edge',
'VK_KHR_separate_depth_stencil_layouts',
'VK_KHR_shader_atomic_int64',
'VK_KHR_shader_float16_int8',
'VK_KHR_shader_float_controls',
'VK_KHR_shader_subgroup_extended_types',
'VK_KHR_spirv_1_4',
'VK_KHR_timeline_semaphore',
'VK_KHR_uniform_buffer_standard_layout',
'VK_KHR_vulkan_memory_model',
'VK_EXT_descriptor_indexing',
'VK_EXT_host_query_reset',
'VK_EXT_sampler_filter_minmax',
'VK_EXT_scalar_block_layout',
'VK_EXT_separate_stencil_usage',
'VK_EXT_shader_viewport_index_layer',
# promoted to VK_VERSION_1_3
'VK_KHR_copy_commands2',
'VK_KHR_dynamic_rendering',
'VK_KHR_format_feature_flags2',
'VK_KHR_maintenance4',
'VK_KHR_shader_integer_dot_product',
'VK_KHR_shader_non_semantic_info',
'VK_KHR_shader_terminate_invocation',
'VK_KHR_synchronization2',
'VK_KHR_zero_initialize_workgroup_memory',
'VK_EXT_4444_formats',
'VK_EXT_extended_dynamic_state',
'VK_EXT_extended_dynamic_state2',
'VK_EXT_image_robustness',
'VK_EXT_inline_uniform_block',
'VK_EXT_pipeline_creation_cache_control',
'VK_EXT_pipeline_creation_feedback',
'VK_EXT_private_data',
'VK_EXT_shader_demote_to_helper_invocation',
'VK_EXT_subgroup_size_control',
'VK_EXT_texel_buffer_alignment',
'VK_EXT_texture_compression_astc_hdr',
'VK_EXT_tooling_info',
'VK_EXT_ycbcr_2plane_444_formats',
# KHR extensions
'VK_KHR_external_fence_fd',
'VK_KHR_external_memory_fd',
'VK_KHR_external_semaphore_fd',
'VK_KHR_pipeline_library',
'VK_KHR_push_descriptor',
'VK_KHR_shader_clock',
# EXT extensions
'VK_EXT_border_color_swizzle',
'VK_EXT_calibrated_timestamps',
'VK_EXT_color_write_enable',
'VK_EXT_conditional_rendering',
'VK_EXT_conservative_rasterization',
'VK_EXT_custom_border_color',
'VK_EXT_depth_clip_control',
'VK_EXT_depth_clip_enable',
'VK_EXT_dynamic_rendering_unused_attachments',
'VK_EXT_extended_dynamic_state3',
'VK_EXT_external_memory_dma_buf',
'VK_EXT_fragment_shader_interlock',
'VK_EXT_graphics_pipeline_library',
'VK_EXT_image_2d_view_of_3d',
'VK_EXT_image_drm_format_modifier',
'VK_EXT_image_view_min_lod',
'VK_EXT_index_type_uint8',
'VK_EXT_line_rasterization',
'VK_EXT_load_store_op_none',
'VK_EXT_memory_budget',
'VK_EXT_multi_draw',
'VK_EXT_mutable_descriptor_type',
'VK_EXT_non_seamless_cube_map',
'VK_EXT_pci_bus_info',
'VK_EXT_primitive_topology_list_restart',
'VK_EXT_primitives_generated_query',
'VK_EXT_provoking_vertex',
'VK_EXT_queue_family_foreign',
'VK_EXT_rasterization_order_attachment_access',
'VK_EXT_robustness2',
'VK_EXT_shader_stencil_export',
'VK_EXT_shader_subgroup_ballot',
'VK_EXT_transform_feedback',
'VK_EXT_vertex_attribute_divisor',
'VK_EXT_vertex_input_dynamic_state',
# vendor extensions
'VK_VALVE_mutable_descriptor_type',
]
class Gen:
PRIMITIVE_TYPES = {
'float': 4,
'double': 8,
'uint8_t': 1,
'uint16_t': 2,
'uint32_t': 4,
'uint64_t': 8,
'int32_t': 4,
'int64_t': 8,
}
UNION_DEFAULT_TAGS = {
'VkClearColorValue': 2,
'VkClearValue': 0,
'VkPipelineExecutableStatisticValueKHR': 2,
}
def __init__(self, is_driver, reg):
self.is_driver = is_driver
self.reg = copy.deepcopy(reg)
self._fixup_registry()
self.supported_types = {}
self._init_supported_types()
# validate VkCommandTypeEXT
command_type_ty = self.reg.type_table['VkCommandTypeEXT']
enum_value_count = 0
for cmd in self.supported_types[VkType.COMMAND]:
key = 'VK_COMMAND_TYPE_' + cmd.name + '_EXT'
if key not in command_type_ty.enums.values:
raise KeyError('%s not defined for %s' % (key, command_type_ty.name))
for alias in cmd.aliases:
key = 'VK_COMMAND_TYPE_' + alias + '_EXT'
if key not in command_type_ty.enums.values:
raise KeyError('%s not defined for %s' % (key, command_type_ty.name))
enum_value_count += 1 + len(cmd.aliases)
assert enum_value_count == len(command_type_ty.enums.values)
def _set_type_needs(self, ty):
for var in ty.variables:
if var.ty.is_pointer() or var.ty.is_static_array():
var.ty.base.attrs['need_array'] = True
if var.ty.base.typedef:
var.ty.base.typedef.base.attrs['need_array'] = True
if 'var_in' in var.attrs:
if self.is_driver:
var.ty.set_attribute('need_encode', True)
else:
var.ty.set_attribute('need_decode', True)
if 'var_out' in var.attrs:
if self.is_driver:
var.ty.set_attribute('need_partial', True)
var.ty.set_attribute('need_decode', True)
else:
var.ty.set_attribute('need_partial', True)
var.ty.set_attribute('need_encode', True)
if ty.ret:
if ty.ret.ty.is_pointer() or ty.ret.ty.is_static_array():
ty.ret.ty.base.attrs['need_array'] = True
if ty.ret.ty.base.typedef:
ty.ret.ty.base.typedef.base.attrs['need_array'] = True
if self.is_driver:
ty.ret.ty.set_attribute('need_decode', True)
else:
ty.ret.ty.set_attribute('need_encode', True)
def _fixup_registry(self):
for ty in self.reg.type_table.values():
if ty.category == ty.COMMAND:
ty.attrs['c_type'] = 'VK_COMMAND_TYPE_' + ty.name + '_EXT'
if ty.ret:
ty.ret.attrs['var_out'] = True
for var in ty.variables:
# non-const pointers are considerer outs
if var.ty.is_pointer() and not var.ty.is_const_pointer():
var.attrs['var_out'] = True
else:
var.attrs['var_in'] = True
# outs appear in 'len_names' are in/out
for var in ty.variables:
for name in var.attrs.get('len_names', []):
v = ty.find_variables(name)
if v:
v = v[0]
if v and 'var_out' in v.attrs:
v.attrs['var_in'] = var
v.attrs['var_out'] = var
elif ty.category == ty.HANDLE:
objtype = 'VK_OBJECT_TYPE_' + self.reg.upper_name(ty.name[2:])
ty.attrs['c_objtype'] = objtype
self._set_type_needs(ty)
def _get_supported_types(self):
# collect types from features and extensions
types = []
for feat in self.reg.features:
types.extend(feat.types)
for ext in self.reg.extensions:
if ext.name not in VK_XML_EXTENSION_LIST:
continue
types.extend(ext.types)
for key in ext.optional_types:
if key in VK_XML_EXTENSION_LIST:
types.extend(ext.optional_types[key])
types_with_deps = set()
for ty in types:
if ty not in types_with_deps:
types_with_deps.update(ty.get_dependencies())
return types_with_deps
def _init_supported_types(self):
supported_types = self._get_supported_types()
# filter p_next
for ty in supported_types:
p_next = []
for tmp in ty.p_next:
if tmp in supported_types:
p_next.append(tmp)
ty.p_next = p_next
# keep type_table order
for ty in self.reg.type_table.values():
if ty not in supported_types:
continue
if ty.category not in self.supported_types:
self.supported_types[ty.category] = []
if ty not in self.supported_types[ty.category]:
self.supported_types[ty.category].append(ty)
def is_serializable(self, var):
if isinstance(var, VkType):
return self.is_serializable(VkVariable(var))
ty = var.ty.base
if ty.category == ty.BASETYPE:
if not ty.typedef:
return False
ty = ty.typedef
if ty.category in [ty.INCLUDE, ty.DEFINE, ty.FUNCPOINTER]:
return False
elif ty.category == ty.DEFAULT:
if ty.name in self.PRIMITIVE_TYPES:
return True
elif ty.name in ['char', 'size_t']:
return True
elif ty.name == 'void':
return var.is_blob()
return False
elif ty.category in [ty.HANDLE, ty.ENUM, ty.BITMASK]:
return True
elif ty.category == ty.UNION:
return ty.name in self.UNION_DEFAULT_TAGS
assert ty.category in [ty.STRUCT, ty.COMMAND]
if ty.category == ty.STRUCT:
if ty.name in ['VkBaseInStructure', 'VkBaseOutStructure']:
return False
elif ty.category == ty.COMMAND:
if ty.ret and not self.is_serializable(ty.ret):
return False
for var in ty.variables:
if var.maybe_null() or var.is_p_next():
continue
if not self.is_serializable(var):
return False
return True
def get_chain(self, ty):
types = []
skipped = []
for next_ty in ty.p_next:
if self.is_serializable(next_ty):
types.append(next_ty)
else:
skipped.append(next_ty)
return types, skipped
@staticmethod
def _api_number_to_version(num):
major, minor = num.split('.')
return 'VK_API_VERSION_' + major + '_' + minor
def get_type_condition(self, ty):
if not self.is_driver:
return None
# pNext chain support is required
COND_NONE = 0
# pNext chain depends on core api version
# cover only new types from core api
COND_API = 1
# pNext chain depends on extension(s) or extension pair(s)
# cover types from exts and promoted core exts
COND_EXT = 2
# type of condition
cond = COND_NONE
# api version e.g. '4206592'
api_version = 0
# map name to ext of exts in VK_XML_EXTENSION_LIST
ext_map = {}
# ext condition of the type
exts = []
# ext pair condition of the type
ext_pairs = []
for feat in self.reg.features:
if ty in feat.types:
# 1.2 is required for protocol
if feat.number in ['1.0', '1.1', '1.2']:
assert cond == COND_NONE
return None
api_version = self._api_number_to_version(feat.number)
cond = COND_API
break
for ext in self.reg.extensions:
if ext.name in VK_XML_EXTENSION_LIST:
ext_map[ext.name] = ext
for ext in ext_map.values():
if ty in ext.types:
# venus protocol versioning is not handled here
if ext.name == 'VK_MESA_venus_protocol':
assert cond == COND_NONE
return None
exts.append(ext)
cond = COND_EXT
elif ext.optional_types:
for key in ext.optional_types:
if key in ext_map and ty in ext.optional_types[key]:
ext_pairs.append((ext, ext_map[key]))
cond = COND_EXT
break
assert cond != COND_NONE
stmt = ''
if cond == COND_EXT:
ext_check = 'vn_cs_renderer_protocol_has_extension'
stmt_exts = ' && '.join(f'!{ext_check}({ext.number} /* {ext.name} */)'
for ext in exts)
stmt_ext_pairs = ' && '.join(
f'!({ext_check}({ext1.number} /* {ext1.name} */) && '
f'{ext_check}({ext2.number} /* {ext2.name} */))'
for ext1, ext2 in ext_pairs)
stmt = ' && '.join(filter(None, [stmt_exts, stmt_ext_pairs]))
else:
stmt = '!vn_cs_renderer_protocol_has_api_version(%s)' % api_version
return stmt
class LoopInfo:
"""Information needed to generate loops to access a variable."""
def __init__(self):
self.loops = []
def add_loop(self, iter_type, iter_count):
level = len(self.loops)
iter_name = chr(ord('i') + level)
loop = self.Loop(level, iter_type, iter_name, iter_count)
self.loops.append(loop)
def pop_loop(self):
return self.loops.pop()
def is_last(self, level):
return level == len(self.loops) - 1
def get_iter_counts(self):
return [loop.iter_count for loop in self.loops]
def get_subscripts(self, to_level):
iter_names = [loop.iter_name for loop in self.loops[:to_level]]
return '[' + ']['.join(iter_names) + ']'
def __bool__(self):
return bool(self.loops)
def __len__(self):
return len(self.loops)
def __iter__(self):
return iter(self.loops)
class Loop:
def __init__(self, level, iter_type, iter_name, iter_count):
# code() will print
#
# for (iter_type iter_name = 0;
# iter_name < iter_count;
# iter_name++)
#
# For example, when the variable is an int32_t array of N
# elements, we have
#
# iter_type = 'uint32_t'
# iter_name = 'i'
# iter_count = 'N'
self.level = level
self.iter_type = iter_type
self.iter_name = iter_name
self.iter_count = iter_count
# code() will print statements before the for-loop.
self.statements = []
class VariableInfo:
# the variable is initialized, such as an input to the driver
VALID = 0
# the variable is uninitialized, such as an output to the driver
INVALID = 1
# the variable is partially initialized, such as an output to the
# driver that is also a handle (because the id is specified by the
# driver) or a struct (because it can potentially include handles,
# sType, or pNext)
PARTIAL = 2
def __init__(self, ty, var, prefix, validity):
self.ty = ty
self.var = var
self.prefix = prefix
self.validity = validity
self.func_stem = None
self._init_func_stem()
self.loop_info = None
self._init_loop_info()
# remember the dynamic array size before unrolling
self.dynamic_array_size = None
if self.var.is_dynamic_array():
loop = self.loop_info.loops[0]
if self.var.ty.is_c_string():
# not usable
assert 'strlen' in loop.iter_count
else:
self.dynamic_array_size = loop.iter_count
# Try to unroll the inner most loop and save its iter_count to
# array_size.
#
# There is no nested loops after unrolling currently.
self.array_size = None
self._unroll_loop()
# code() will print statements line-by-line.
#
# For example, when the variable is an int32_t array, we have
# this for encode
#
# statements = [
# 'vn_encode_array_size(...)',
# 'vn_encode_int32_t_array(...)',
# ]
#
# and, when allocation is needed, this for decode
#
# statements = [
# 'vn_decode_array_size(...)',
# 'foo = vn_cs_decoder_alloc_temp(...)',
# 'if (!foo) return',
# 'vn_decode_int32_t_array(...)',
# ]
self.statements = []
def _init_func_stem(self):
if self.var.is_blob():
self.func_stem = 'blob'
elif self.var.ty.base.category == VkType.BITMASK:
self.func_stem = self.var.ty.base.typedef.name
else:
self.func_stem = self.var.ty.base.name
def _var_deref(self, var=None):
if not var:
var = self.var
return '*' * (var.ty.indirection_depth() + var.ty.is_static_array())
def _var_const_cast(self):
return '(%s %s)' % (self.var.ty.base.name, self._var_deref())
def _var_loop_indices(self, loop_level):
if loop_level:
return self.loop_info.get_subscripts(loop_level)
else:
return ''
def _var_name(self, loop_level=0, const_cast=False):
var_name = self.prefix + self.var.name
indices = self._var_loop_indices(loop_level)
if const_cast and (self.var.ty.is_const_pointer() or
self.var.ty.is_const_static_array()):
if indices:
return '(%s%s)%s' % (self._var_const_cast(), var_name, indices)
else:
return '%s%s' % (self._var_const_cast(), var_name)
else:
return '%s%s' % (var_name, indices)
def _init_loop_info(self):
self.loop_info = Gen.LoopInfo()
if 'len_exprs' not in self.var.attrs:
if self.var.ty.is_static_array():
iter_count = self.var.ty.static_array_size()
self.loop_info.add_loop('uint32_t', iter_count)
return
len_exprs = self.var.attrs['len_exprs']
len_names = self.var.attrs['len_names']
for level, (expr, name) in enumerate(zip(len_exprs, len_names)):
if expr == 'null-terminated':
iter_type = 'size_t'
iter_count = 'strlen(%s) + 1' % self._var_name(level)
elif name:
loop_vars = self.ty.find_variables(name)
deref = self._var_deref(loop_vars[-1])
iter_type = loop_vars[-1].ty.base.name
iter_count = expr.replace(name, deref + self.prefix + name)
assert len(loop_vars) <= 2
if len(loop_vars) > 1 or loop_vars[-1].ty.is_pointer():
iter_count = '(%s%s ? %s : 0)' % (self.prefix,
loop_vars[0].name, iter_count)
else:
iter_type = 'uint32_t'
iter_count = expr
self.loop_info.add_loop(iter_type, iter_count)
def _unroll_loop(self):
# unroll loops for scalar arrays to get padding right
scalar_categories = [VkType.DEFAULT, VkType.BASETYPE, VkType.ENUM]
if not self.loop_info:
return
if not self.var.ty.base.category in scalar_categories:
return
loop = self.loop_info.pop_loop()
self.func_stem += '_array'
self.array_size = loop.iter_count
def init_alloc_stmts(self):
alloc_counts = self.loop_info.get_iter_counts()
if self.array_size:
alloc_counts.append(self.array_size)
if not alloc_counts:
var_name = self._var_name()
deref = self._var_deref()
alloc_stmt = '%s = vn_cs_decoder_alloc_temp(dec, sizeof(%s%s));' % (
var_name, deref, var_name)
check_stmt = 'if (!%s) return;' % var_name
self.statements.append(alloc_stmt)
self.statements.append(check_stmt)
return
for level, count in enumerate(alloc_counts):
if self.var.is_blob():
alloc_stmt = '%s = vn_cs_decoder_alloc_temp(dec, %s);' % (
self._var_name(level, level > 0), count)
else:
alloc_stmt = '%s = vn_cs_decoder_alloc_temp_array(dec, sizeof(*%s), %s);' % (
self._var_name(level, level > 0), self._var_name(level), count)
check_stmt = 'if (!%s) return;' % self._var_name(level)
if level < len(self.loop_info):
loop = self.loop_info.loops[level]
loop.statements.append(alloc_stmt)
loop.statements.append(check_stmt)
else:
self.statements.append(alloc_stmt)
self.statements.append(check_stmt)
def func_args(self, const_cast):
var_name = self.prefix + self.var.name
loop_level = len(self.loop_info)
deref_count = self.var.ty.indirection_depth() + self.var.ty.is_static_array()
deref_count -= loop_level
# we want a pointer to var
deref_count -= 1
deref = ''
if deref_count > 0:
deref = '*' * deref_count
elif deref_count < 0:
deref = '&' * -deref_count
args = '%s%s' % (deref, self._var_name(loop_level, const_cast))
if self.array_size:
args += ', ' + self.array_size
return args
def _code_enter_loops(self, indent_level, bracket_last):
code = ''
indent = ' ' * indent_level
for loop in self.loop_info:
for stmt in loop.statements:
code += '%s%s\n' % (indent, stmt)
init_expr = '%s %c = 0' % (loop.iter_type, loop.iter_name)
cond_expr = '%c < %s' % (loop.iter_name, loop.iter_count)
incr_expr = '%c++' % loop.iter_name
bracket = ' {'
if not bracket_last and self.loop_info.is_last(loop.level):
bracket = ''
code += '%sfor (%s; %s; %s)%s\n' % (indent, init_expr,
cond_expr, incr_expr, bracket)
indent += ' '
return code
def _code_body(self, indent_level):
loop_level = len(self.loop_info)
code = ''
indent = ' ' * (indent_level + loop_level)
for stmt in self.statements:
code += '%s%s\n' % (indent, stmt)
return code
def _code_leave_loops(self, indent_level, bracket_last):
code = ''
for level in reversed(range(len(self.loop_info))):
if bracket_last or not self.loop_info.is_last(level):
indent = ' ' * (indent_level + level)
code += '%s}\n' % indent
return code
def need_bracket(self):
if self.loop_info:
return True
if len(self.statements) > 1:
return True
return False
def code(self, indent_level):
code_body = self._code_body(indent_level)
bracket_last = code_body.count(';') > 1
code_enter_loops = self._code_enter_loops(
indent_level, bracket_last)
code_leave_loops = self._code_leave_loops(
indent_level, bracket_last)
return code_enter_loops + code_body + code_leave_loops
def _sizeof_variable(self, info, dst, indent_level):
indent = ' ' * indent_level
if info.validity == info.INVALID:
if info.var.ty.is_pointer():
return '%s%s += vn_sizeof_simple_pointer(%s); /* out */' % (
indent, dst, info._var_name())
else:
return '%s/* skip %s */' % (indent, info._var_name())
stmts = []
if info.var.is_dynamic_array():
stmts.append('if (%s) {' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('} else {')
stmts.append(' %s += vn_sizeof_array_size(0);' % dst)
stmts.append('}')
elif info.var.ty.is_pointer():
stmts.append('%s += vn_sizeof_simple_pointer(%s);' % (dst, info._var_name()))
stmts.append('if (%s)' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
else:
stmts.append(info.code(indent_level).strip())
code = ''
for stmt in stmts:
code += '%s%s\n' % (indent, stmt)
return code
def _encode_variable(self, info, indent_level):
indent = ' ' * indent_level
if info.validity == info.INVALID:
if info.var.is_dynamic_array():
return '%svn_encode_array_size(enc, %s ? %s : 0); /* out */' % (
indent, info._var_name(), info.array_size)
elif info.var.ty.is_pointer():
return '%svn_encode_simple_pointer(enc, %s); /* out */' % (
indent, info._var_name())
else:
return '%s/* skip %s */' % (indent, info._var_name())
stmts = []
if info.var.is_dynamic_array():
stmts.append('if (%s) {' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('} else {')
stmts.append(' vn_encode_array_size(enc, 0);')
stmts.append('}')
elif info.var.ty.is_pointer():
stmts.append('if (vn_encode_simple_pointer(enc, %s))' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
else:
stmts.append(info.code(indent_level).strip())
if 'stride' in info.var.attrs:
stmts.append('%s = sizeof(%s);' % (info.var.attrs['stride'], info.func_stem))
code = ''
for stmt in stmts:
code += '%s%s\n' % (indent, stmt)
return code
def _decode_variable(self, info, indent_level):
indent = ' ' * indent_level
if info.validity == info.INVALID:
if not info.var.ty.is_pointer():
return '%s/* skip %s */' % (indent, info._var_name())
stmts = []
if info.var.is_dynamic_array():
stmts.append('if (vn_peek_array_size(dec)) {')
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('} else {')
if not self.is_driver and not info.var.is_optional() and \
info.var.can_validate() and info.dynamic_array_size:
stmts.append(' vn_decode_array_size(dec, %s);' % info.dynamic_array_size)
else:
stmts.append(' vn_decode_array_size_unchecked(dec);')
stmts.append(' %s = NULL;' % info._var_name())
stmts.append('}')
elif info.var.ty.is_pointer():
stmts.append('if (vn_decode_simple_pointer(dec)) {')
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('} else {')
stmts.append(' %s = NULL;' % info._var_name())
if not self.is_driver and not info.var.is_optional() and \
info.var.can_validate():
stmts.append(' vn_cs_decoder_set_fatal(dec);')
stmts.append('}')
elif info.need_bracket():
stmts.append('{')
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('}')
else:
stmts.append(info.code(indent_level).strip())
code = ''
for stmt in stmts:
code += '%s%s\n' % (indent, stmt)
return code
def _replace_variable_handle(self, info, indent_level):
indent = ' ' * indent_level
if info.validity != info.VALID or \
info.var.ty.base.category not in [VkType.HANDLE, VkType.STRUCT] or \
not self.is_serializable(info.var):
return '%s/* skip %s */' % (indent, info._var_name())
stmts = []
if info.var.ty.is_pointer() and info.need_bracket():
stmts.append('if (%s) {' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
stmts.append('}')
elif info.var.ty.is_pointer():
stmts.append('if (%s)' % info._var_name())
stmts.append(' %s' % info.code(indent_level + 1).strip())
else:
stmts.append(info.code(indent_level).strip())
code = ''
for stmt in stmts:
code += '%s%s\n' % (indent, stmt)
return code
def _sizeof_variable_info(self, ty, var, prefix, validity, dst):
info = self.VariableInfo(ty, var, prefix, validity)
if not self.is_serializable(var):
assert var.maybe_null()
info.statements.append('assert(false);')
return info
# save strlen result to a temp
if var.has_c_string():
assert info.array_size.startswith('strlen')
stmt = 'const size_t string_size = %s;' % info.array_size
info.statements.append(stmt)
info.array_size = 'string_size'
# encode array sizes
for loop in info.loop_info:
stmt = '%s += vn_sizeof_array_size(%s);' % (dst, loop.iter_count)
loop.statements.append(stmt)
if info.array_size:
stmt = '%s += vn_sizeof_array_size(%s);' % (dst, info.array_size)
info.statements.append(stmt)
# nothing to encode
if validity == info.INVALID:
return info
func_name = 'vn_sizeof_' + info.func_stem
if validity == info.PARTIAL and var.ty.base.category == ty.STRUCT:
func_name += '_partial'
stmt = '%s += %s(%s);' % (dst, func_name, info.func_args(False))
info.statements.append(stmt)
return info
def _encode_variable_info(self, ty, var, prefix, validity):
info = self.VariableInfo(ty, var, prefix, validity)
if not self.is_serializable(var):
assert var.maybe_null()
info.statements.append('assert(false);')
return info
# save strlen result to a temp
if var.has_c_string():
assert info.array_size.startswith('strlen')
stmt = 'const size_t string_size = %s;' % info.array_size
info.statements.append(stmt)
info.array_size = 'string_size'
# encode array sizes
for loop in info.loop_info:
stmt = 'vn_encode_array_size(enc, %s);' % loop.iter_count
loop.statements.append(stmt)
if info.array_size:
stmt = 'vn_encode_array_size(enc, %s);' % info.array_size
info.statements.append(stmt)
# nothing to encode
if validity == info.INVALID:
return info
func_name = 'vn_encode_' + info.func_stem
if validity == info.PARTIAL and var.ty.base.category == ty.STRUCT:
func_name += '_partial'
if 'stride' in var.attrs:
stmt = '%s(enc, (void *)%s + %s * %c);' % (func_name, info._var_name(), var.attrs['stride'], loop.iter_name)
else:
stmt = '%s(enc, %s);' % (func_name, info.func_args(False))
info.statements.append(stmt)
return info
def _decode_variable_info(self, ty, var, prefix, validity, alloc_storage):
info = self.VariableInfo(ty, var, prefix, validity)
if not self.is_serializable(var):
assert var.maybe_null()
if self.is_driver:
stmt = 'assert(false);'
else:
stmt = 'vn_cs_decoder_set_fatal(dec);'
info.statements.append(stmt)
return info
# decode array sizes
for loop in info.loop_info:
temp_name = 'iter_count'
if loop.level > 0:
temp_name += '_' + loop.iter_name
stmt = 'const %s %s = vn_decode_array_size(dec, %s);' % \
(loop.iter_type, temp_name, loop.iter_count)
loop.statements.append(stmt)
loop.iter_count = temp_name
# decode the encoded array size
if info.array_size:
if var.has_c_string():
assert info.array_size.startswith('strlen')
assert info.func_stem == 'char_array'
stmt = 'const size_t string_size = vn_decode_array_size_unchecked(dec);'
info.statements.append(stmt)
info.array_size = 'string_size'
else:
stmt = 'const size_t array_size = vn_decode_array_size(dec, %s);' \
% info.array_size
info.statements.append(stmt)
info.array_size = 'array_size'
if alloc_storage and var.ty.is_pointer():
info.init_alloc_stmts()
# nothing to decode
if validity == info.INVALID:
return info
func_name = 'vn_decode_' + info.func_stem
if validity == info.PARTIAL and var.ty.base.category == ty.STRUCT:
func_name += '_partial'
if alloc_storage and var.ty.base.category in [ty.STRUCT, ty.UNION]:
func_name += '_temp'
if var.ty.base.category == ty.HANDLE:
if validity == info.VALID:
# automatic handle lookup
if not self.is_driver:
func_name += '_lookup'
elif alloc_storage and var.ty.base.dispatchable:
func_name += '_temp'
stmt = '%s(dec, %s);' % (func_name, info.func_args(True))
info.statements.append(stmt)
return info
def _replace_variable_handle_info(self, ty, var, prefix, validity):
info = self.VariableInfo(ty, var, prefix, validity)
# nothing to replace
might_contain_handle = [ty.HANDLE, ty.STRUCT]
if (validity != info.VALID or
var.ty.base.category not in might_contain_handle or