Add localUnits array and use that inside medical statemachines #4836

dedmen · 2017-01-17T19:22:46Z

This will add an array of localUnits which is kept up-to-date by Eventhandlers and remove the need to dynamically create that list every few frames inside the medical state machines.

The EH has about a performance penalty of 0.015ms per spawned unit.

Currently the Statemachines inside medical_ai and medical_blood create this array of local Units dynamically each time they refresh their list (https://github.com/CBATeam/CBA_A3/blob/master/addons/statemachine/fnc_clockwork.sqf#L37)
by using allUnits select {local _x} which has about a 0.24ms impact.

This is basically moving the performance impact from a PFH thats executed every few frames to an Eventhandler and also reducing the performance cost in the meantime.

I didn't test this yet but i don't know what could go wrong. Besides the "local" EH misbehaving.

Currently the Statemachine clockwork for the 2 medical Statemachines is with 1.2ms the longest executing PFH when on a server with exactly 100 non-local AI's.
diag_captureFrame:

And because 0 of these AI's are local and the Statemachine will recreate the unit list when it iterated through it fully. It will recreate it every frame.
For both Statemachines thats about 0.48ms per frame just for recreating that list over and over again.
This PR should cut down on the bulk of that.

This would essentially be replaced by BI adding a localUnits script function. Which i would hope they would do but.. They probably won't.

@commy2

Code by @commy2

PabstMirror · 2017-01-17T21:45:38Z

I think this is a good idea, will really shine with high unit counts.

Need to use retro init - }, true, [], true] call CBA_fnc_addClassEventHandler;
Or nothing gets added at start like player.
But that's currently bugged - CBATeam/CBA_A3#567

Need to handle deleted units, Deleted EH is a good canidate but it's for 1.68.

dedmen · 2017-01-17T21:58:56Z

A quick workaround against CBATeam/CBA_A3#567 would probably just be using pushBackUnique
What about adding the EH's at preInit? That was actually what commy suggested. preInit should be before unit spawns right?

PabstMirror · 2017-01-18T00:00:22Z

Adding at preInit or just using the config should work fine.

BaerMitUmlaut · 2017-01-18T06:42:46Z

@PabstMirror: deleted units should become objectNull, right? The state machine skips null elements.

PabstMirror · 2017-01-18T06:54:23Z

Think of something like ALIVE that does unit caching
Constantly creating and deleting units
The list would be constantly growing
We would waste more time filtering though a list of a 1000 objNulls

dedmen · 2017-01-18T22:33:37Z

Then we should rather wait till 1.68 with this.
For the EH's there are three possibilities

Cram all the code inside the config EH
Create a seperate function for each EH and call that from the config
Add in preInit.

I do favor the preInit one if thats reliable enough. What do you think?

commy2 · 2017-01-18T23:15:21Z

Solution for deleted units is using the "deleted" event handler (requires 1.68)
Solution for killed units is using the "killed" event handler.

I think these two should cover these potential problems.

commy2 · 2017-01-18T23:17:32Z

Retro init is not needed if the "init" event handler is installed in preInit. (Which should be the way to go anyways).

commy2 · 2017-01-18T23:19:55Z

Since the state machine is filtering null objects anyway, I think we can just add the "deleted" event handler and play the waiting game with the Arma update. CBA will update soon, hopefully.

…-localUnits

PabstMirror · 2017-11-07T04:53:33Z

It's failing when deleting via zeus

// Debug code:
[{isNull _this}, {diag_log text format ["%1 - %2 became null", diag_frameNo, this]}, cursorObject] call CBA_fnc_waitUntilAndExecute;

// Deleting via deleteVehicle
45596 unit deleted: _unit=10a29ec40# 164025: b_soldier_01.p3d, local _unit=true z\ace\addons\common\functions\fnc_setupLocalUnitsHandler.sqf:56
45597 unit deleted nextFrame: _unit=<NULL-object>, local _unit=false, isNull _unit=true z\ace\addons\common\functions\fnc_setupLocalUnitsHandler.sqf:61
45597 - any became null

// Deleting via zeus
53311 unit deleted: _unit=10a2bef40# 164031: b_soldier_01.p3d, local _unit=true z\ace\addons\common\functions\fnc_setupLocalUnitsHandler.sqf:56
Info: Zeus interface queued deletion of Alpha 2-2 group with 0 units inside.
53312 unit deleted nextFrame: _unit=10a2bef40# 164031: b_soldier_01.p3d, local _unit=true, isNull _unit=false z\ace\addons\common\functions\fnc_setupLocalUnitsHandler.sqf:61
53313 - any became null

So it takes 2+ frames for it to actually be deleted?

dedmen · 2017-11-07T08:18:09Z

🤕 I hate Arma.
It can still happen that we have null objects in localUnits array.. In fact it will happen.
CBA's nextFrame executes after the PFH's.
So if unit get's null at start of frame it will still be in localUnits array at the PFH's.
It will most likely get deleted in the Simulation cycle and Draw3D runs after the simulation cycle.. So using Draw3D could get around that.

I guess easiest solution might just be having a PFH in Draw3D that does
localUnits = localUnits - [objNull]
Does the vanilla deletedEH really get called when spawning vehicles in Zeus? Could it be just a XEH issue?

dedmen · 2017-11-20T12:03:04Z

In the end.. Can't we just make a getLocalUnits function.
That does localUnits = localUnits - [objNull] on the first call every frame?
Perf wise it's crap. But still a lot better than everyone doing allUnits select {local _x}
And if someone doesn't care about null objects they can just use the variable directly.

Then we should also remove the deleted EH as it only creates problems.
@PabstMirror thoughts? I don't see problems with this solution.

Btw I figured out why Zeus deletion takes 2 frames.
A frame is like this
<framestart><scheduled scripts and PFH><simulation><UI scripts and draw3D><frameend>

deleting a vehicle schedules it's deletion. And it get's really deleted in next simulation.

so call deleteVehicle from scheduled or PFH. After that simulation runs and deletes vehicle. Next frame in PFH we check if it was deleted and it was.

Zeus seems to schedule deletion in simulation or UI cycle.
We get deleted eh and want to check next frame.
We check next frame, simulation didn't happen yet so unit is still !null. In the UI cycle it is null but we only notice on next PFH.
So it looks like we are 2 frames late. But actually we are only
frameend,framestart,pfh,simulation,draw3d,frameend,framestart late. As you can see one simulation in there.

Normal deleteVehicle looks like
simulation,draw3d,frameend,framestart

dedmen · 2017-11-20T12:49:47Z

addons/common/functions/fnc_setupLocalUnitsHandler.sqf

+            params ["_unit"];
+            TRACE_3("unit deleted nextFrame",_unit,local _unit,isNull _unit);
+            if (isNull _unit) then { //If it is not null then the deleted EH was Fake.
+                GVAR(localUnits) = GVAR(localUnits) - [objNull];


I delete all objNull here as using find to find a null object will find the first null object and not the one the deleted EH belongs to anyway.
I would prefer to just call FUNC(getLocalUnits) here in case we add a check to getLocalUnits so it only removes null objects once per frame.
But it would hurt readability.

dedmen · 2017-11-20T13:04:04Z

addons/common/functions/fnc_getLocalUnits.sqf

+ */
+
+//Remove null objects
+GVAR(localUnits) = GVAR(localUnits) - [objNull];


We can check diag_frameNo against a global variable so we only remove null objects once a frame to get us a little more perf.
But I'm not sure if GVAR(localUnits) = GVAR(localUnits) - [objNull]; is really that expensive that it's worth it. Needs profiling with atleast a hundred local units.

Actually we only need to run this if there was a deletedEH in the last 2-3 frames. But I don't think it hurts.
Considering this will already be about a 100x improvement vs iterating through allUnits everytime.

also to checking diag_frameNo objects are deleted in simulation cycle. Draw3D runs after that in the same frame. So that could cause Draw3D to still get null objects.

dedmen · 2017-11-20T13:05:33Z

addons/common/functions/fnc_setupLocalUnitsHandler.sqf

+    };
+}] call CBA_fnc_addClassEventHandler;
+
+["CAManBase", "respawn", {


Shouldn't "init" also fire for respawning units?
But I guess they might be !alive at init?

Respawning in MP should be tested.

Init does not fire for respawned objects.

not ready yet

dedmen · 2018-03-01T09:39:50Z

What's currently the problem? Besides merge conflict.
The problem with Zeus deleting units that are not deleted could be solved by using a draw3D EH 1 frame after Zeus "deletes" the unit. We don't have a execNextFrame utility function for that though. And the EH fires in simulation cycle. Meaning right after that is a draw3D EH which we don't want. So if we add in the sim cycle we first have to skip one run.

As vehicles are deleted in SIM cycle this means after using Draw3D it's "impossible" to get null objects into the localUnits array. Because we clean up right after they get deleted.
But Draw3D handlers that run before our's could still see null objects.
Others already said null-objects aren't a big problem. As they can appear in allUnits anyway.

PabstMirror · 2019-02-26T19:44:25Z

Moved isBleeding check to inside state machine as checking FUNC(isBleeding) for all units was still expensive. Even with high unit count I think the delay between bleeding is high enough that this should not cause issues.

dedmen · 2019-02-27T09:00:15Z

What about the issues we talked about?

PabstMirror · 2019-02-27T17:02:35Z

I tested on a dedicated server and it and
call ace_common_fnc_getLocalUnits matched allUnits select {local _x}

The addition of GVAR(localUnits) = GVAR(localUnits) - [objNull]; in the getter fixes any problems with deletedEH. I guess we could even remove the deletedEH as it still is unreliable with zeus

PabstMirror · 2019-02-27T17:11:19Z

["CAManBase", "deleted", {
    params ["_unit"];
    TRACE_2("AAA unit deleted",_unit,local _unit);

    if (local _unit) then {
        [{
            params ["_unit"];
            TRACE_3("BBB unit deleted nextFrame",_unit,local _unit,isNull _unit);
            [{
                params ["_unit"];
                TRACE_3("CCC unit deleted next-nextFrame",_unit,local _unit,isNull _unit);
                if (isNull _unit) then { // If it is not null then the deleted EH was Fake.
                    GVAR(localUnits) = GVAR(localUnits) - [objNull];
                };
            }, _this] call CBA_fnc_execNextFrame;
        }, [_unit]] call CBA_fnc_execNextFrame;
    };
}] call CBA_fnc_addClassEventHandler;

this should also work

@commy2

* Added localUnits EH Code by @commy2 * Init localUnits Variable * use localUnits for medical_blood statemachine * use localUnits for medical_ai statemachine * Remove bracket hell * Add Deleted EH * Run at preInit, move to seperate file * Handle Respawns, Filter Dead * Add detection for Fake deleted EH * Use a getter function * delete all objNull at deletedEH * Cleanup header/comments * Move isBleeding check to inside statemachine * opps * debug off

dedmen added 5 commits January 17, 2017 19:58

Added localUnits EH

bb3869f

Code by @commy2

Init localUnits Variable

e15f0e6

use localUnits for medical_blood statemachine

54ac1bd

use localUnits for medical_ai statemachine

5ec6f54

Remove bracket hell

dd6b603

PabstMirror added the kind/enhancement Release Notes: **IMPROVED:** label Jan 17, 2017

PabstMirror added this to the 3.9.0 milestone Jan 17, 2017

PabstMirror added the status/WIP label Jan 17, 2017

PabstMirror modified the milestones: Ongoing, 3.9.0 Jan 19, 2017

PabstMirror added the 1.68 label Jan 23, 2017

Add Deleted EH

c2c1c15

PabstMirror removed arma/1.68 status/WIP labels May 1, 2017

Merge branch 'dedmen-localUnits' of https://github.com/dedmen/ACE3

5ff36ae

PabstMirror self-assigned this May 1, 2017

Run at preInit, move to seperate file

310f91f

PabstMirror changed the base branch from master to medical-rewrite May 1, 2017 18:22

PabstMirror changed the base branch from medical-rewrite to master May 1, 2017 18:22

PabstMirror added 2 commits May 7, 2017 16:56

Merge remote-tracking branch 'refs/remotes/origin/master' into dedman…

44fd1bf

…-localUnits

Handle Respawns, Filter Dead

c0bdd81

Add detection for Fake deleted EH

85d4898

dedmen added 2 commits November 20, 2017 13:46

Use a getter function

8af22f8

delete all objNull at deletedEH

5535ca1

dedmen commented Nov 20, 2017

View reviewed changes

PabstMirror added 2 commits February 25, 2019 22:59

Merge branch 'master' into pr/4836

b30740c

Cleanup header/comments

4f9f471

PabstMirror modified the milestones: Ongoing, 3.12.6 Feb 26, 2019

PabstMirror removed the status/needs-testing label Feb 26, 2019

PabstMirror added 2 commits February 26, 2019 13:40

Move isBleeding check to inside statemachine

a8b3915

opps

4fca03c

debug off

04d03ae

PabstMirror added the MedicalRewrite-Rectify label Feb 26, 2019

PabstMirror approved these changes Feb 26, 2019

View reviewed changes

PabstMirror merged commit 7f04d00 into acemod:master Feb 27, 2019

PabstMirror added a commit that referenced this pull request Mar 26, 2019

rectify localUnits func #4836

047583c

PabstMirror added the MedicalRewrite-Rectified label Mar 26, 2019

BaerMitUmlaut pushed a commit that referenced this pull request Aug 5, 2019

rectify localUnits func #4836

59127b0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add localUnits array and use that inside medical statemachines #4836

Add localUnits array and use that inside medical statemachines #4836

dedmen commented Jan 17, 2017 •

edited

Loading

PabstMirror commented Jan 17, 2017

dedmen commented Jan 17, 2017

PabstMirror commented Jan 18, 2017

BaerMitUmlaut commented Jan 18, 2017

PabstMirror commented Jan 18, 2017

dedmen commented Jan 18, 2017

commy2 commented Jan 18, 2017

commy2 commented Jan 18, 2017

commy2 commented Jan 18, 2017 •

edited

Loading

PabstMirror commented Nov 7, 2017

dedmen commented Nov 7, 2017 •

edited

Loading

dedmen commented Nov 20, 2017 •

edited

Loading

dedmen Nov 20, 2017 •

edited

Loading

dedmen Nov 20, 2017

dedmen Nov 20, 2017

dedmen Nov 20, 2017

dedmen Nov 20, 2017

commy2 Nov 20, 2017

dedmen commented Mar 1, 2018

PabstMirror commented Feb 26, 2019

dedmen commented Feb 27, 2019

PabstMirror commented Feb 27, 2019

PabstMirror commented Feb 27, 2019

Add localUnits array and use that inside medical statemachines #4836

Add localUnits array and use that inside medical statemachines #4836

Conversation

dedmen commented Jan 17, 2017 • edited Loading

PabstMirror commented Jan 17, 2017

dedmen commented Jan 17, 2017

PabstMirror commented Jan 18, 2017

BaerMitUmlaut commented Jan 18, 2017

PabstMirror commented Jan 18, 2017

dedmen commented Jan 18, 2017

commy2 commented Jan 18, 2017

commy2 commented Jan 18, 2017

commy2 commented Jan 18, 2017 • edited Loading

PabstMirror commented Nov 7, 2017

dedmen commented Nov 7, 2017 • edited Loading

dedmen commented Nov 20, 2017 • edited Loading

dedmen Nov 20, 2017 • edited Loading

Choose a reason for hiding this comment

dedmen Nov 20, 2017

Choose a reason for hiding this comment

dedmen Nov 20, 2017

Choose a reason for hiding this comment

dedmen Nov 20, 2017

Choose a reason for hiding this comment

dedmen Nov 20, 2017

Choose a reason for hiding this comment

commy2 Nov 20, 2017

Choose a reason for hiding this comment

dedmen commented Mar 1, 2018

PabstMirror commented Feb 26, 2019

dedmen commented Feb 27, 2019

PabstMirror commented Feb 27, 2019

PabstMirror commented Feb 27, 2019

dedmen commented Jan 17, 2017 •

edited

Loading

commy2 commented Jan 18, 2017 •

edited

Loading

dedmen commented Nov 7, 2017 •

edited

Loading

dedmen commented Nov 20, 2017 •

edited

Loading

dedmen Nov 20, 2017 •

edited

Loading