• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1import copy
2
3from .common.codegen import CodeGen, VulkanWrapperGenerator
4from .common.vulkantypes import \
5        VulkanAPI, makeVulkanTypeSimple, iterateVulkanType
6
7from .marshaling import VulkanMarshalingCodegen
8from .reservedmarshaling import VulkanReservedMarshalingCodegen
9from .counting import VulkanCountingCodegen
10from .handlemap import HandleMapCodegen
11from .deepcopy import DeepcopyCodegen
12from .transform import TransformCodegen, genTransformsForVulkanType
13
14from .wrapperdefs import API_PREFIX_RESERVEDMARSHAL
15from .wrapperdefs import API_PREFIX_MARSHAL
16from .wrapperdefs import API_PREFIX_UNMARSHAL
17from .wrapperdefs import ROOT_TYPE_DEFAULT_VALUE
18from .wrapperdefs import VULKAN_STREAM_TYPE_GUEST
19
20encoder_decl_preamble = """
21class VkEncoder {
22public:
23    VkEncoder(IOStream* stream);
24    ~VkEncoder();
25
26#include "VkEncoder.h.inl"
27"""
28
29encoder_decl_postamble = """
30private:
31    class Impl;
32    std::unique_ptr<Impl> mImpl;
33};
34"""
35
36encoder_impl_preamble ="""
37
38using namespace goldfish_vk;
39
40using android::aligned_buf_alloc;
41using android::aligned_buf_free;
42using android::base::guest::AutoLock;
43using android::base::guest::Lock;
44using android::base::BumpPool;
45
46#include "VkEncoder.cpp.inl"
47
48#define VALIDATE_RET(retType, success, validate) \\
49    retType goldfish_vk_validateResult = validate; \\
50    if (goldfish_vk_validateResult != success) return goldfish_vk_validateResult; \\
51
52#define VALIDATE_VOID(validate) \\
53    VkResult goldfish_vk_validateResult = validate; \\
54    if (goldfish_vk_validateResult != VK_SUCCESS) return; \\
55
56"""
57
58STREAM = "stream"
59RESOURCES = "sResourceTracker"
60POOL = "pool"
61
62ENCODER_PREVALIDATED_APIS = [
63    "vkFlushMappedMemoryRanges",
64    "vkInvalidateMappedMemoryRanges",
65]
66
67ENCODER_CUSTOM_RESOURCE_PREPROCESS = [
68    "vkMapMemoryIntoAddressSpaceGOOGLE",
69    "vkDestroyDevice",
70]
71
72ENCODER_CUSTOM_RESOURCE_POSTPROCESS = [
73    "vkCreateInstance",
74    "vkCreateDevice",
75    "vkMapMemoryIntoAddressSpaceGOOGLE",
76    "vkGetPhysicalDeviceProperties",
77    "vkGetPhysicalDeviceProperties2",
78    "vkGetPhysicalDeviceProperties2KHR",
79    "vkGetPhysicalDeviceMemoryProperties",
80    "vkGetPhysicalDeviceMemoryProperties2",
81    "vkGetPhysicalDeviceMemoryProperties2KHR",
82    "vkCreateDescriptorUpdateTemplate",
83    "vkCreateDescriptorUpdateTemplateKHR",
84    "vkGetPhysicalDeviceExternalSemaphoreProperties",
85    "vkGetPhysicalDeviceExternalSemaphorePropertiesKHR",
86]
87
88ENCODER_EXPLICIT_FLUSHED_APIS = [
89    "vkEndCommandBufferAsyncGOOGLE",
90    "vkQueueSubmitAsyncGOOGLE",
91    "vkQueueBindSparseAsyncGOOGLE",
92    "vkQueueWaitIdleAsyncGOOGLE",
93    "vkQueueSignalReleaseImageANDROID",
94    "vkDestroyDevice",
95]
96
97SUCCESS_RET_TYPES = {
98    "VkResult" : "VK_SUCCESS",
99    "void" : None,
100    # TODO: Put up success results for other return types here.
101}
102
103ENCODER_THIS_PARAM = makeVulkanTypeSimple(False, "VkEncoder", 1, "this")
104
105# Common components of encoding a Vulkan API call
106def make_event_handler_call(
107    handler_access,
108    api,
109    context_param,
110    input_result_param,
111    cgen,
112    suffix=""):
113    extraParams = [context_param.paramName]
114    if input_result_param:
115        extraParams.append(input_result_param)
116    return cgen.makeCallExpr( \
117               "%s->on_%s%s" % (handler_access, api.name, suffix),
118               extraParams + \
119                       [p.paramName for p in api.parameters[:-1]])
120
121def emit_custom_pre_validate(typeInfo, api, cgen):
122    if api.name in ENCODER_PREVALIDATED_APIS:
123        callExpr = \
124            make_event_handler_call( \
125                "mImpl->validation()", api,
126                ENCODER_THIS_PARAM,
127                SUCCESS_RET_TYPES[api.getRetTypeExpr()],
128                cgen)
129
130        if api.getRetTypeExpr() == "void":
131            cgen.stmt("VALIDATE_VOID(%s)" % callExpr)
132        else:
133            cgen.stmt("VALIDATE_RET(%s, %s, %s)" % \
134                (api.getRetTypeExpr(),
135                 SUCCESS_RET_TYPES[api.getRetTypeExpr()],
136                 callExpr))
137
138def emit_custom_resource_preprocess(typeInfo, api, cgen):
139    if api.name in ENCODER_CUSTOM_RESOURCE_PREPROCESS:
140        cgen.stmt( \
141            make_event_handler_call( \
142                "sResourceTracker", api,
143                ENCODER_THIS_PARAM,
144                SUCCESS_RET_TYPES[api.getRetTypeExpr()],
145                cgen, suffix="_pre"))
146
147def emit_custom_resource_postprocess(typeInfo, api, cgen):
148    if api.name in ENCODER_CUSTOM_RESOURCE_POSTPROCESS:
149        cgen.stmt(make_event_handler_call( \
150            "sResourceTracker",
151            api,
152            ENCODER_THIS_PARAM,
153            api.getRetVarExpr(),
154            cgen))
155
156def emit_count_marshal(typeInfo, param, cgen):
157    res = \
158        iterateVulkanType(
159            typeInfo, param,
160            VulkanCountingCodegen( \
161                cgen, "sFeatureBits", param.paramName, "countPtr", ROOT_TYPE_DEFAULT_VALUE,
162               "count_"))
163    if not res:
164        cgen.stmt("(void)%s" % param.paramName)
165
166def emit_marshal(typeInfo, param, cgen):
167    forOutput = param.isHandleType() and ("out" in param.inout)
168    if forOutput:
169        cgen.stmt("/* is handle, possibly out */")
170
171    res = \
172        iterateVulkanType(
173            typeInfo, param,
174            VulkanReservedMarshalingCodegen( \
175                cgen, STREAM, ROOT_TYPE_DEFAULT_VALUE, param.paramName, "streamPtrPtr",
176               API_PREFIX_RESERVEDMARSHAL,
177               "" if forOutput else "get_host_u64_",
178               direction="write"))
179    if not res:
180        cgen.stmt("(void)%s" % param.paramName)
181
182    if forOutput:
183        cgen.stmt("/* is handle, possibly out */")
184
185def emit_unmarshal(typeInfo, param, cgen):
186    iterateVulkanType(
187        typeInfo, param,
188        VulkanMarshalingCodegen( \
189            cgen, STREAM, ROOT_TYPE_DEFAULT_VALUE, param.paramName,
190           API_PREFIX_UNMARSHAL, direction="read"))
191
192def emit_deepcopy(typeInfo, param, cgen):
193    res = \
194        iterateVulkanType(typeInfo, param, DeepcopyCodegen(
195            cgen, [param.paramName, "local_" + param.paramName], "pool", ROOT_TYPE_DEFAULT_VALUE, "deepcopy_"))
196    if not res:
197        cgen.stmt("(void)%s" % param.paramName)
198
199def emit_transform(typeInfo, param, cgen, variant="tohost"):
200    res = \
201        iterateVulkanType(typeInfo, param, TransformCodegen( \
202            cgen, param.paramName, "sResourceTracker", "transform_%s_" % variant, variant))
203    if not res:
204        cgen.stmt("(void)%s" % param.paramName)
205
206def emit_handlemap_create(typeInfo, param, cgen):
207    iterateVulkanType(typeInfo, param, HandleMapCodegen(
208        cgen, None, "sResourceTracker", "handlemap_",
209        lambda vtype: typeInfo.isHandleType(vtype.typeName)
210    ))
211
212def custom_encoder_args(api):
213    params = ["this"]
214    if api.getRetVarExpr() is not None:
215        params.append(api.getRetVarExpr())
216    return params
217
218def emit_handlemap_destroy(typeInfo, param, cgen):
219    iterateVulkanType(typeInfo, param, HandleMapCodegen(
220        cgen, None, "sResourceTracker->destroyMapping()", "handlemap_",
221        lambda vtype: typeInfo.isHandleType(vtype.typeName)
222    ))
223
224class EncodingParameters(object):
225    def __init__(self, api):
226        self.localCopied = []
227        self.toWrite = []
228        self.toRead = []
229        self.toCreate = []
230        self.toDestroy = []
231
232        for param in api.parameters:
233            param.action = None
234            param.inout = "in"
235
236            if param.paramName == "doLock":
237                continue
238
239            if param.possiblyOutput():
240                param.inout += "out"
241                self.toWrite.append(param)
242                self.toRead.append(param)
243                if param.isCreatedBy(api):
244                    self.toCreate.append(param)
245                    param.action = "create"
246            else:
247
248                if param.paramName == "doLock":
249                    continue
250
251                if param.isDestroyedBy(api):
252                    self.toDestroy.append(param)
253                    param.action = "destroy"
254                localCopyParam = \
255                    param.getForNonConstAccess().withModifiedName( \
256                        "local_" + param.paramName)
257                self.localCopied.append((param, localCopyParam))
258                self.toWrite.append(localCopyParam)
259
260def emit_parameter_encode_preamble_write(typeInfo, api, cgen):
261    emit_custom_pre_validate(typeInfo, api, cgen);
262    emit_custom_resource_preprocess(typeInfo, api, cgen);
263
264    cgen.stmt("auto %s = mImpl->stream()" % STREAM)
265    cgen.stmt("auto %s = mImpl->pool()" % POOL)
266    # cgen.stmt("%s->setHandleMapping(%s->unwrapMapping())" % (STREAM, RESOURCES))
267
268    encodingParams = EncodingParameters(api)
269    for (_, localCopyParam) in encodingParams.localCopied:
270        cgen.stmt(cgen.makeRichCTypeDecl(localCopyParam))
271
272def emit_parameter_encode_copy_unwrap_count(typeInfo, api, cgen, customUnwrap=None):
273    encodingParams = EncodingParameters(api)
274
275    for (origParam, localCopyParam) in encodingParams.localCopied:
276        shouldCustomCopy = \
277            customUnwrap and \
278            origParam.paramName in customUnwrap and \
279            "copyOp" in customUnwrap[origParam.paramName]
280
281        shouldCustomMap = \
282            customUnwrap and \
283            origParam.paramName in customUnwrap and \
284            "mapOp" in customUnwrap[origParam.paramName]
285
286        if shouldCustomCopy:
287            customUnwrap[origParam.paramName]["copyOp"](cgen, origParam, localCopyParam)
288        else:
289            # if this is a pointer type and we don't do custom copy nor unwrap,
290            # and the transform doesn't end up doing anything,
291            # don't deepcopy, just cast it.
292
293            avoidDeepcopy = False
294
295            if origParam.pointerIndirectionLevels > 0:
296                testCgen = CodeGen()
297                genTransformsForVulkanType("sResourceTracker", origParam, lambda p: testCgen.generalAccess(p, parentVarName = None, asPtr = True), lambda p: testCgen.generalLengthAccess(p, parentVarName = None), testCgen)
298                emit_transform(typeInfo, origParam, testCgen, variant="tohost")
299                if "" == testCgen.swapCode():
300                    avoidDeepcopy = True
301            if avoidDeepcopy:
302                cgen.line("// Avoiding deepcopy for %s" % origParam.paramName)
303                cgen.stmt("%s = (%s%s)%s" % (localCopyParam.paramName, localCopyParam.typeName, "*" * origParam.pointerIndirectionLevels, origParam.paramName))
304            else:
305                emit_deepcopy(typeInfo, origParam, cgen)
306
307    for (origParam, localCopyParam) in encodingParams.localCopied:
308        shouldCustomMap = \
309            customUnwrap and \
310            origParam.paramName in customUnwrap and \
311            "mapOp" in customUnwrap[origParam.paramName]
312
313        if shouldCustomMap:
314            customUnwrap[origParam.paramName]["mapOp"](cgen, origParam, localCopyParam)
315        else:
316            if localCopyParam.typeName == "VkAllocationCallbacks":
317                cgen.stmt("%s = nullptr" % localCopyParam.paramName)
318
319    apiForTransform = \
320        api.withCustomParameters( \
321            map(lambda p: p[1], \
322                encodingParams.localCopied))
323
324    # Apply transforms if applicable.
325    # Apply transform to API itself:
326    genTransformsForVulkanType(
327        "sResourceTracker",
328        apiForTransform,
329        lambda p: cgen.generalAccess(p, parentVarName = None, asPtr = True),
330        lambda p: cgen.generalLengthAccess(p, parentVarName = None),
331        cgen)
332
333    # For all local copied parameters, run the transforms
334    for localParam in apiForTransform.parameters:
335        if "doLock" in localParam.paramName:
336            continue
337        emit_transform(typeInfo, localParam, cgen, variant="tohost")
338
339    cgen.stmt("size_t count = 0")
340    cgen.stmt("size_t* countPtr = &count")
341    cgen.beginBlock()
342
343    # Use counting stream to calculate the packet size.
344    for p in encodingParams.toWrite:
345        emit_count_marshal(typeInfo, p, cgen)
346
347    cgen.endBlock()
348
349def is_cmdbuf_dispatch(api):
350    return "VkCommandBuffer" == api.parameters[0].typeName
351
352def emit_parameter_encode_write_packet_info(typeInfo, api, cgen):
353    # Seqno and skipping dispatch serialize are for use with VULKAN_STREAM_FEATURE_QUEUE_SUBMIT_WITH_COMMANDS_BIT
354    doSeqno = True
355    doDispatchSerialize = True
356
357    if is_cmdbuf_dispatch(api):
358        doSeqno = False
359        doDispatchSerialize = False
360
361    if doSeqno:
362        cgen.stmt("uint32_t packetSize_%s = 4 + 4 + (queueSubmitWithCommandsEnabled ? 4 : 0) + count" % (api.name))
363    else:
364        cgen.stmt("uint32_t packetSize_%s = 4 + 4 + count" % (api.name))
365
366    if not doDispatchSerialize:
367        cgen.stmt("if (queueSubmitWithCommandsEnabled) packetSize_%s -= 8" % api.name)
368
369    cgen.stmt("uint8_t* streamPtr = %s->reserve(packetSize_%s)" % (STREAM, api.name))
370    cgen.stmt("uint8_t** streamPtrPtr = &streamPtr")
371    cgen.stmt("uint32_t opcode_%s = OP_%s" % (api.name, api.name))
372
373    if doSeqno:
374        cgen.stmt("uint32_t seqno; if (queueSubmitWithCommandsEnabled) seqno = ResourceTracker::nextSeqno()")
375
376    cgen.stmt("memcpy(streamPtr, &opcode_%s, sizeof(uint32_t)); streamPtr += sizeof(uint32_t)" % api.name)
377    cgen.stmt("memcpy(streamPtr, &packetSize_%s, sizeof(uint32_t)); streamPtr += sizeof(uint32_t)" % api.name)
378
379    if doSeqno:
380        cgen.line("if (queueSubmitWithCommandsEnabled) { memcpy(streamPtr, &seqno, sizeof(uint32_t)); streamPtr += sizeof(uint32_t); }")
381
382def emit_parameter_encode_do_parameter_write(typeInfo, api, cgen):
383    encodingParams = EncodingParameters(api)
384
385    dispatchDone = False
386
387    for p in encodingParams.toWrite:
388        if is_cmdbuf_dispatch(api) and not dispatchDone:
389            cgen.beginIf("!queueSubmitWithCommandsEnabled")
390            emit_marshal(typeInfo, p, cgen)
391            cgen.endIf()
392        else:
393            emit_marshal(typeInfo, p, cgen)
394
395        dispatchDone = True
396
397def emit_parameter_encode_read(typeInfo, api, cgen):
398    encodingParams = EncodingParameters(api)
399
400    for p in encodingParams.toRead:
401        if p.action == "create":
402            cgen.stmt(
403                "%s->setHandleMapping(%s->createMapping())" % \
404                (STREAM, RESOURCES))
405        emit_unmarshal(typeInfo, p, cgen)
406        if p.action == "create":
407            cgen.stmt(
408                "%s->unsetHandleMapping()" % STREAM)
409        emit_transform(typeInfo, p, cgen, variant="fromhost")
410
411def emit_post(typeInfo, api, cgen):
412    encodingParams = EncodingParameters(api)
413
414    emit_custom_resource_postprocess(typeInfo, api, cgen)
415
416    for p in encodingParams.toDestroy:
417        emit_handlemap_destroy(typeInfo, p, cgen)
418
419    doSeqno = True
420    if is_cmdbuf_dispatch(api):
421        doSeqno = False
422
423    retType = api.getRetTypeExpr()
424
425    if api.name in ENCODER_EXPLICIT_FLUSHED_APIS:
426        cgen.stmt("stream->flush()");
427        return
428
429    if doSeqno:
430        if retType == "void":
431            encodingParams = EncodingParameters(api)
432            if 0 == len(encodingParams.toRead):
433                cgen.stmt("stream->flush()");
434
435def emit_pool_free(cgen):
436    cgen.stmt("++encodeCount;")
437    cgen.beginIf("0 == encodeCount % POOL_CLEAR_INTERVAL")
438    cgen.stmt("pool->freeAll()")
439    cgen.stmt("%s->clearPool()" % STREAM)
440    cgen.endIf()
441
442def emit_return_unmarshal(typeInfo, api, cgen):
443
444    retType = api.getRetTypeExpr()
445
446    if retType == "void":
447        return
448
449    retVar = api.getRetVarExpr()
450    cgen.stmt("%s %s = (%s)0" % (retType, retVar, retType))
451    cgen.stmt("%s->read(&%s, %s)" % \
452              (STREAM, retVar, cgen.sizeofExpr(api.retType)))
453
454def emit_return(typeInfo, api, cgen):
455    if api.getRetTypeExpr() == "void":
456        return
457
458    retVar = api.getRetVarExpr()
459    cgen.stmt("return %s" % retVar)
460
461def emit_lock(cgen):
462    cgen.stmt("(void)doLock");
463    cgen.stmt("bool queueSubmitWithCommandsEnabled = sFeatureBits & VULKAN_STREAM_FEATURE_QUEUE_SUBMIT_WITH_COMMANDS_BIT")
464    cgen.stmt("if (!queueSubmitWithCommandsEnabled && doLock) this->lock()")
465
466def emit_unlock(cgen):
467    cgen.stmt("if (!queueSubmitWithCommandsEnabled && doLock) this->unlock()")
468
469def emit_default_encoding(typeInfo, api, cgen):
470    emit_lock(cgen)
471    emit_parameter_encode_preamble_write(typeInfo, api, cgen)
472    emit_parameter_encode_copy_unwrap_count(typeInfo, api, cgen)
473    emit_parameter_encode_write_packet_info(typeInfo, api, cgen)
474    emit_parameter_encode_do_parameter_write(typeInfo, api, cgen)
475    emit_parameter_encode_read(typeInfo, api, cgen)
476    emit_return_unmarshal(typeInfo, api, cgen)
477    emit_post(typeInfo, api, cgen)
478    emit_pool_free(cgen)
479    emit_unlock(cgen)
480    emit_return(typeInfo, api, cgen)
481
482## Custom encoding definitions##################################################
483
484def emit_only_goldfish_custom(typeInfo, api, cgen):
485    emit_lock(cgen)
486    cgen.vkApiCall( \
487        api,
488        customPrefix="sResourceTracker->on_",
489        customParameters=custom_encoder_args(api) + \
490                [p.paramName for p in api.parameters[:-1]])
491    emit_unlock(cgen)
492    emit_return(typeInfo, api, cgen)
493
494def emit_only_resource_event(typeInfo, api, cgen):
495    cgen.stmt("(void)doLock");
496    input_result = None
497    retExpr = api.getRetVarExpr()
498
499    if retExpr:
500        retType = api.getRetTypeExpr()
501        input_result = SUCCESS_RET_TYPES[retType]
502        cgen.stmt("%s %s = (%s)0" % (retType, retExpr, retType))
503
504    cgen.stmt(
505        (("%s = " % retExpr) if retExpr else "") +
506        make_event_handler_call(
507            "sResourceTracker",
508            api,
509            ENCODER_THIS_PARAM,
510            input_result, cgen))
511
512    if retExpr:
513        emit_return(typeInfo, api, cgen)
514
515def emit_with_custom_unwrap(custom):
516    def call(typeInfo, api, cgen):
517        emit_lock(cgen)
518        emit_parameter_encode_preamble_write(typeInfo, api, cgen)
519        emit_parameter_encode_copy_unwrap_count(
520            typeInfo, api, cgen, customUnwrap=custom)
521        emit_parameter_encode_write_packet_info(typeInfo, api, cgen)
522        emit_parameter_encode_do_parameter_write(typeInfo, api, cgen)
523        emit_parameter_encode_read(typeInfo, api, cgen)
524        emit_return_unmarshal(typeInfo, api, cgen)
525        emit_pool_free(cgen)
526        emit_unlock(cgen)
527        emit_return(typeInfo, api, cgen)
528    return call
529
530def encode_vkFlushMappedMemoryRanges(typeInfo, api, cgen):
531    emit_lock(cgen)
532    emit_parameter_encode_preamble_write(typeInfo, api, cgen)
533    emit_parameter_encode_copy_unwrap_count(typeInfo, api, cgen)
534
535    def emit_flush_ranges(streamVar):
536        cgen.beginIf("!sResourceTracker->usingDirectMapping()")
537        cgen.beginFor("uint32_t i = 0", "i < memoryRangeCount", "++i")
538        cgen.stmt("auto range = pMemoryRanges[i]")
539        cgen.stmt("auto memory = pMemoryRanges[i].memory")
540        cgen.stmt("auto size = pMemoryRanges[i].size")
541        cgen.stmt("auto offset = pMemoryRanges[i].offset")
542        cgen.stmt("uint64_t streamSize = 0")
543        cgen.stmt("if (!memory) { %s->write(&streamSize, sizeof(uint64_t)); continue; }" % streamVar)
544        cgen.stmt("auto hostPtr = sResourceTracker->getMappedPointer(memory)")
545        cgen.stmt("auto actualSize = size == VK_WHOLE_SIZE ? sResourceTracker->getMappedSize(memory) : size")
546        cgen.stmt("if (!hostPtr) { %s->write(&streamSize, sizeof(uint64_t)); continue; }" % streamVar)
547        cgen.stmt("streamSize = actualSize")
548        cgen.stmt("%s->write(&streamSize, sizeof(uint64_t))" % streamVar)
549        cgen.stmt("uint8_t* targetRange = hostPtr + offset")
550        cgen.stmt("%s->write(targetRange, actualSize)" % streamVar)
551        cgen.endFor()
552        cgen.endIf()
553
554    emit_parameter_encode_write_packet_info(typeInfo, api, cgen)
555    emit_parameter_encode_do_parameter_write(typeInfo, api, cgen)
556
557    emit_flush_ranges(STREAM)
558
559    emit_parameter_encode_read(typeInfo, api, cgen)
560    emit_return_unmarshal(typeInfo, api, cgen)
561    emit_pool_free(cgen)
562    emit_unlock(cgen)
563    emit_return(typeInfo, api, cgen)
564
565def encode_vkInvalidateMappedMemoryRanges(typeInfo, api, cgen):
566    emit_lock(cgen)
567    emit_parameter_encode_preamble_write(typeInfo, api, cgen)
568    emit_parameter_encode_copy_unwrap_count(typeInfo, api, cgen)
569    emit_parameter_encode_write_packet_info(typeInfo, api, cgen)
570    emit_parameter_encode_do_parameter_write(typeInfo, api, cgen)
571    emit_parameter_encode_read(typeInfo, api, cgen)
572    emit_return_unmarshal(typeInfo, api, cgen)
573
574    def emit_invalidate_ranges(streamVar):
575        cgen.beginIf("!sResourceTracker->usingDirectMapping()")
576        cgen.beginFor("uint32_t i = 0", "i < memoryRangeCount", "++i")
577        cgen.stmt("auto range = pMemoryRanges[i]")
578        cgen.stmt("auto memory = pMemoryRanges[i].memory")
579        cgen.stmt("auto size = pMemoryRanges[i].size")
580        cgen.stmt("auto offset = pMemoryRanges[i].offset")
581        cgen.stmt("uint64_t streamSize = 0")
582        cgen.stmt("if (!memory) { %s->read(&streamSize, sizeof(uint64_t)); continue; }" % streamVar)
583        cgen.stmt("auto hostPtr = sResourceTracker->getMappedPointer(memory)")
584        cgen.stmt("auto actualSize = size == VK_WHOLE_SIZE ? sResourceTracker->getMappedSize(memory) : size")
585        cgen.stmt("if (!hostPtr) { %s->read(&streamSize, sizeof(uint64_t)); continue; }" % streamVar)
586        cgen.stmt("streamSize = actualSize")
587        cgen.stmt("%s->read(&streamSize, sizeof(uint64_t))" % streamVar)
588        cgen.stmt("uint8_t* targetRange = hostPtr + offset")
589        cgen.stmt("%s->read(targetRange, actualSize)" % streamVar)
590        cgen.endFor()
591        cgen.endIf()
592
593    emit_invalidate_ranges(STREAM)
594    emit_pool_free(cgen)
595    emit_unlock(cgen)
596    emit_return(typeInfo, api, cgen)
597
598def emit_manual_inline(typeInfo, api, cgen):
599    cgen.line("#include \"%s_encode_impl.cpp.inl\"" % api.name)
600
601def unwrap_VkNativeBufferANDROID():
602    def mapOp(cgen, orig, local):
603        cgen.stmt("sResourceTracker->unwrap_VkNativeBufferANDROID(%s, %s)" %
604                  (orig.paramName, local.paramName))
605    return { "pCreateInfo" : { "mapOp" : mapOp } }
606
607def unwrap_vkAcquireImageANDROID_nativeFenceFd():
608    def mapOp(cgen, orig, local):
609        cgen.stmt("sResourceTracker->unwrap_vkAcquireImageANDROID_nativeFenceFd(%s, &%s)" %
610                  (orig.paramName, local.paramName))
611    return { "nativeFenceFd" : { "mapOp" : mapOp } }
612
613custom_encodes = {
614    "vkMapMemory" : emit_only_resource_event,
615    "vkUnmapMemory" : emit_only_resource_event,
616    "vkFlushMappedMemoryRanges" : encode_vkFlushMappedMemoryRanges,
617    "vkInvalidateMappedMemoryRanges" : encode_vkInvalidateMappedMemoryRanges,
618    "vkCreateImage" : emit_with_custom_unwrap(unwrap_VkNativeBufferANDROID()),
619    "vkCreateImageWithRequirementsGOOGLE" : emit_with_custom_unwrap(unwrap_VkNativeBufferANDROID()),
620    "vkAcquireImageANDROID" : emit_with_custom_unwrap(unwrap_vkAcquireImageANDROID_nativeFenceFd()),
621    "vkQueueFlushCommandsGOOGLE" : emit_manual_inline,
622}
623
624class VulkanEncoder(VulkanWrapperGenerator):
625    def __init__(self, module, typeInfo):
626        VulkanWrapperGenerator.__init__(self, module, typeInfo)
627
628        self.typeInfo = typeInfo
629
630        self.cgenHeader = CodeGen()
631        self.cgenHeader.incrIndent()
632
633        self.cgenImpl = CodeGen()
634
635    def onBegin(self,):
636        self.module.appendHeader(encoder_decl_preamble)
637        self.module.appendImpl(encoder_impl_preamble)
638
639    def onGenCmd(self, cmdinfo, name, alias):
640        VulkanWrapperGenerator.onGenCmd(self, cmdinfo, name, alias)
641
642        api = copy.deepcopy(self.typeInfo.apis[name])
643        api.parameters.append(makeVulkanTypeSimple(False, "uint32_t", 0, "doLock"))
644
645        self.cgenHeader.stmt(self.cgenHeader.makeFuncProto(api))
646        apiImpl = api.withModifiedName("VkEncoder::" + api.name)
647
648        self.module.appendHeader(self.cgenHeader.swapCode())
649
650        if api.name in custom_encodes.keys():
651            self.module.appendImpl(self.cgenImpl.makeFuncImpl(
652                apiImpl, lambda cgen: custom_encodes[api.name](self.typeInfo, api, cgen)))
653        else:
654            self.module.appendImpl(self.cgenImpl.makeFuncImpl(apiImpl,
655                lambda cgen: emit_default_encoding(self.typeInfo, api, cgen)))
656
657    def onEnd(self,):
658        self.module.appendHeader(encoder_decl_postamble)
659        self.cgenHeader.decrIndent()
660