MHR [REFramework] {invalid type specifier} when hooked on method causing freeze on load

[Bimmr]

When hooking

sdk.hook(sdk.find_type_definition("snow.facility.kitchen.MealFunc"):get_method("get_AvailableDangoList"), 
function()
    log.debug("Pre")
end, function()
    log.debug("Post")
end)

The game seems to freeze while loading after choosing my hunter

The REFramework Debug Console will say something along the lines of:

[*** LOG ERROR #0152 ***] [2022-07-09 12:38:44] [REFramework] {invalid type specifier}
[*** LOG ERROR #0234 ***] [2022-07-09 12:38:55] [REFramework] {invalid type specifier}
[*** LOG ERROR #0235 ***] [2022-07-09 12:38:57] [REFramework] {invalid type specifier}

It will then fill the re2_framework_log.txt file with:

[2022-07-09 11:49:30.217] [REFramework] [info] REFramework entry
[2022-07-09 11:49:30.219] [REFramework] [info] Game Module Addr: 140000000
[2022-07-09 11:49:30.219] [REFramework] [info] Game Module Size: 28e59000
[2022-07-09 11:49:30.219] [REFramework] [info] Preallocated buffer: 13fff0fc0
[2022-07-09 11:49:30.219] [REFramework] [info] Getting OS version information...
[2022-07-09 11:49:30.219] [REFramework] [info] OS Version Information
[2022-07-09 11:49:30.219] [REFramework] [info] 	Major Version: 10
[2022-07-09 11:49:30.219] [REFramework] [info] 	Minor Version: 0
[2022-07-09 11:49:30.219] [REFramework] [info] 	Build Number: 19043
[2022-07-09 11:49:30.219] [REFramework] [info] 	Platform Id: 2

...
[2022-07-09 12:00:30.343] [REFramework] [info] Hooked DirectX 12
[2022-07-09 12:00:40.355] [REFramework] [info] Last chance encountered for hooking
[2022-07-09 12:00:40.355] [REFramework] [info] Sending initial message hook test
[2022-07-09 12:00:41.355] [REFramework] [info] Sending rehook request for D3D
[2022-07-09 12:00:41.356] [REFramework] [info] Unhooking D3D12
[2022-07-09 12:00:41.357] [REFramework] [info] Hooking D3D12
[2022-07-09 12:00:41.357] [REFramework] [info] Creating dummy device
[2022-07-09 12:00:41.357] [REFramework] [info] D3D12CreateDevice appears to be hooked, temporarily unhooking
[2022-07-09 12:00:41.358] [REFramework] [info] Restoring hooked bytes for D3D12CreateDevice
[2022-07-09 12:00:41.359] [REFramework] [info] Dummy device: 5de6d500
[2022-07-09 12:00:41.359] [REFramework] [info] Creating dummy DXGI factory
[2022-07-09 12:00:41.359] [REFramework] [info] Creating dummy command queue
[2022-07-09 12:00:41.405] [REFramework] [info] Creating dummy swapchain
[2022-07-09 12:00:41.408] [REFramework] [info] Querying dummy swapchain
[2022-07-09 12:00:41.408] [REFramework] [info] Finding command queue offset
[2022-07-09 12:00:41.408] [REFramework] [info] Found command queue offset: 118
[2022-07-09 12:00:41.444] [REFramework] [info] Initializing hooks
[2022-07-09 12:00:41.444] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b148->7ff83fd71fe0 to 7fffcdfa8b50
[2022-07-09 12:00:41.445] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b170->7ff83fd90650 to 7fffcdfa8d90
[2022-07-09 12:00:41.445] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b178->7ff83fddb2c0 to 7fffcdfa9030
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 7768
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 25756
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 15068
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 9756
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 27052
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 26796
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 14328
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 22872
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 7532
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 7940
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 26208
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 11904
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 20688
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 12372
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 2728
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 4512
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 5172
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 11684
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 11476
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 12028
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 12740
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 1372
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 14316
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 19272
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 17872
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 20920
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 25636
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 15164
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 3172
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 16280
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 4248
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 1536
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 3948
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 23816
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 24820
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 27592
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 13632
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 15880
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 12164
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 2044
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 25760
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 23160
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 26544
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 6756
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 20288
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 23840
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 5984
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 19360
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 9828
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 26840
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 11740
[2022-07-09 12:00:41.445] [REFramework] [info] Resuming 16632
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 26160
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 20100
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 22752
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 9260
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 4028
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 11204
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 5116
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 7856
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 14176
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 19816
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 9028
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 15948
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 26732
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 13072
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 11380
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 26500
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 16180
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 10488
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 2976
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 22816
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 14744
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 12020
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 23084
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 27004
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 4712
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 19908
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 24856
[2022-07-09 12:00:41.446] [REFramework] [info] Resuming 2204
[2022-07-09 12:00:41.457] [REFramework] [info] Hooked DirectX 12
[2022-07-09 12:00:51.468] [REFramework] [info] Last chance encountered for hooking
[2022-07-09 12:00:51.468] [REFramework] [info] Sending initial message hook test
[2022-07-09 12:00:52.469] [REFramework] [info] Sending rehook request for D3D
[2022-07-09 12:00:52.469] [REFramework] [info] Unhooking D3D12
[2022-07-09 12:00:52.470] [REFramework] [info] Hooking D3D12
[2022-07-09 12:00:52.471] [REFramework] [info] Creating dummy device
[2022-07-09 12:00:52.471] [REFramework] [info] D3D12CreateDevice appears to be hooked, temporarily unhooking
[2022-07-09 12:00:52.472] [REFramework] [info] Restoring hooked bytes for D3D12CreateDevice
[2022-07-09 12:00:52.472] [REFramework] [info] Dummy device: 5de6d500
[2022-07-09 12:00:52.472] [REFramework] [info] Creating dummy DXGI factory
[2022-07-09 12:00:52.473] [REFramework] [info] Creating dummy command queue
[2022-07-09 12:00:52.521] [REFramework] [info] Creating dummy swapchain
[2022-07-09 12:00:52.524] [REFramework] [info] Querying dummy swapchain
[2022-07-09 12:00:52.524] [REFramework] [info] Finding command queue offset
[2022-07-09 12:00:52.524] [REFramework] [info] Found command queue offset: 118
[2022-07-09 12:00:52.559] [REFramework] [info] Initializing hooks
[2022-07-09 12:00:52.559] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b148->7ff83fd71fe0 to 7fffcdfa8b50
[2022-07-09 12:00:52.559] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b170->7ff83fd90650 to 7fffcdfa8d90
[2022-07-09 12:00:52.560] [REFramework] [info] [PointerHook] Hooking 7ff83fe0b178->7ff83fddb2c0 to 7fffcdfa9030
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 7768
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 25756
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 15068
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 9756
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 27052
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 26796
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 14328
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 22872
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 7532
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 7940
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 26208
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 11904
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 20688
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 12372
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 2728
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 4512
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 5172
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 11684
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 11476
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 12028
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 12740
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 1372
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 14316
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 19272
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 17872
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 20920
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 25636
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 15164
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 3172
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 16280
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 4248
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 1536
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 3948
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 23816
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 24820
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 27592
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 13632
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 15880
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 12164
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 2044
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 25760
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 23160
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 26544
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 6756
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 20288
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 23840
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 5984
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 19360
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 9828
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 26840
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 11740
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 16632
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 26160
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 20100
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 22752
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 9260
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 4028
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 11204
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 5116
[2022-07-09 12:00:52.560] [REFramework] [info] Resuming 7856
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 14176
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 19816
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 9028
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 15948
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 26732
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 13072
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 11380
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 26500
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 16180
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 10488
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 2976
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 22816
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 14744
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 12020
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 23084
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 27004
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 4712
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 19908
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 24856
[2022-07-09 12:00:52.561] [REFramework] [info] Resuming 2204
[2022-07-09 12:00:52.571] [REFramework] [info] Hooked DirectX 12
...

[praydog]

Don't hook this function. If you look at the disassembly in the method view, it is an extremely simple function. Because of this, this function will be re-used for other functions that use the same set of instructions, and will cause thousands of garbage data per second to flow through the hook. There is nothing that can be done about this.

[praydog]

ALTERNATIVELY, if you REALLY need to hook this function, you can verify that the args[2] passing through the function is indeed a snow.facility.kitchen.MealFunc, because otherwise other garbage types will be getting passed through this.

function pre_func(args)
    local obj = sdk.to_managed_object(args[2])
    if not obj then return end -- don't do anything, it's not a real managed object
    if not obj:get_type_definition():is_a("snow.facility.kitchen.MealFunc") then return end -- don't do anything, it's not a MealFunc
  
    return sdk.PreHookResult.SKIP_ORIGINAL -- Now you can skip the original; do the same thing to prevent execution of the post function
end

[praydog]

I've made an entry on the wiki as to why this is a problem.

https://cursey.github.io/reframework-book/api/general/best-practices.html#hooking-gotchas

[Bimmr]

So I've spent the last few hours trying other options but nothing would get me the same result as what I'm looking for. I need to change what the function is returning so I don't run into issues with Lua using references instead of values.

Just to confirm, would I need to use something like (this also causes the freeze):

local mealFunc = nil
local function pre_func(args)
    log.debug("Pre")
    local obj = sdk.to_managed_object(args[2])
    if not obj then return end 
    if not obj:get_type_definition():is_a("snow.facility.kitchen.MealFunc") then return end 
    log.debug("Pre MealFunc")
    mealFunc = obj
  
    return sdk.PreHookResult.SKIP_ORIGINAL
end
local function post_func(retval)
    log.debug("Post")
    if mealFunc then
        log.debug("Post MealFunc")
        return retval -- Return custom value here instead
    end
    mealFunc = nil
    return retval
end

sdk.hook(sdk.find_type_definition("snow.facility.kitchen.MealFunc"):get_method("get_AvailableDangoList"), pre_func, post_func)

It seems that regardless of what I have in the post_func it causes the game to freeze after choosing your hunter, any help would be much appreciated as I don't have much experience in Lua

[praydog]

    if mealFunc then
        mealFunc = nil -- Forgot this
        log.debug("Post MealFunc")
        return retval -- Return custom value here instead
    end

[praydog]

I will look into it and see if there's anything I can come up with.

[praydog]

I can't get the game to freeze with the exact snippet you gave me in a standalone script. Is there anything special I need to do?

[Bimmr]

I currently have it in the bottom of another script and it only freezes if that hook is present, but I'll try throwing it in a standalone with nothing else just to 100% confirm that it's what's causing the freeze.

[Bimmr]

So it looks like by itself it works.

I guess it might be another one of the hooks I'm using thats causing that one to break. I'll start playing around and see if I can narrow it down