Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adjustments to core suspender #5075

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

adjustments to core suspender #5075

wants to merge 7 commits into from
+108 −44

Conversation

ab9rf
Copy link
Member

@ab9rf ab9rf commented Dec 3, 2024

this is an attempted step to improve semantics around core suspenders. this does not actually resolve #5074 but it is intended as a step toward doing so

@ab9rf
Copy link
Member Author

ab9rf commented Dec 3, 2024 •
edited
Loading

with the last commit this now does resolve #5074

i've validated it on windows but needs testing on linux

test procedure:

  • launch game.
  • in console enter a nonsense command, should quickly respond "blah is not a recognized command"
  • in launcher, enter lua "while(true) do end". this will freeze the launcher as this is an infinite loop
  • in console, enter a nonsense command, should (after a brief pause) respond "Cannot acquire core lock in helpdb.get_commands" followed by "blah is not a recognized command"
  • in console, enter kill-lua. the console should emit a lua traceback, and the launcher should unfreeze and also show the traceback
  • in console, enter a nonsense command, should quickly respond "blah is not a recognized command"

@ab9rf ab9rf requested a review from lethosor December 3, 2024 17:56
@ab9rf
Copy link
Member Author

ab9rf commented Dec 3, 2024

@dhthwy has confirmed that this works on linux, so i'm releasing it for review

@ab9rf ab9rf marked this pull request as ready for review December 3, 2024 18:28
@ab9rf
Copy link
Member Author

ab9rf commented Dec 4, 2024

thanks again to @NicksWorld for their invaluable help on this PR

myk002 added a commit to myk002/dfhack that referenced this pull request Dec 6, 2024
@myk002
temporarily neuter implementation of try_autocomplete
e75ce39 
to reduce danger of deadlocking
will be reverted in DFHack#5075
@myk002 myk002 mentioned this pull request Dec 6, 2024
Merged
NicksWorld
NicksWorld reviewed Dec 12, 2024
View reviewed changes
library/include/Core.h Outdated Show resolved Hide resolved
@ab9rf ab9rf marked this pull request as draft December 13, 2024 06:09
ab9rf and others added 3 commits December 13, 2024 19:21
@ab9rf
adjustments to core suspender
ca31a28 
this is an attempted step to improve semantics around core suspenders. this does not actually resolve DFHack#5074 but it is intended as a step toward doing so
@ab9rf @NicksWorld
fix semantics for conditional locking
0f7e108 
this switches the core lock to a recursive timed mutex, uses a `try_lock_for` in `CoreSuspenderBase` and changes `help_helper` and `get_commands` over to using conditional locks to avoid a hang in the event that a core lock cannot be acquired in these methods

i also moved some repeated code into protected/private methods in both `CoreSuspenderBase` and `CoreSuspender` to mitigate DRY, which also massively improves readability

h/t to @NicksWorld for their help in figuring out the required semantics

Co-Authored-By: Nicholas McDaniel <[email protected]>
@ab9rf
revert DFHack#5080, reinstating try_autocomplete
73ab644
ab9rf added 2 commits December 13, 2024 20:12
@ab9rf
rework CoreSuspender API
e1866c2 
Drastically simplify CoreSuspender API:
* remove access to state manipulation
* add ConditionalCoreSuspender subclass for conditional locks
* fix various errors around use of an explicit core argument when creating a CoreSuspender
@ab9rf
reorder constructor
36fa4a6 
to satisfy gcc's order warning

i will shortly submit a PR to add `/w15038` to the msvc configuration so msvc will also catch these warnings going forward
@ab9rf ab9rf marked this pull request as ready for review December 14, 2024 02:36
@ab9rf
Copy link
Member Author

ab9rf commented Dec 14, 2024

The last batch of changes drastically simplify the CoreSuspender API by removing consumer access to CoreSuspender state, adding a ConditionalCoreSuspender subclass that provides a conditional locking mechanic, fixes various errors around use of an explicit core argument when creating a CoreSuspender, which required having CoreSuspenderBase hold a reference to the core used to initialize it. I also changed the explicit-core constructors to use a Core& instead of a Core*

@ab9rf @NicksWorld
minor improvement
ff6d7a2 
removed the local `isLocked` member from `CoreSuspenderBase` as it is redundant with `owns_lock()` from `std::unique_lock`

h/t to @NicksWorld for pointing this out

Co-Authored-By: Nicholas McDaniel <[email protected]>
myk002
myk002 reviewed Dec 18, 2024
View reviewed changes
library/include/Core.h Outdated Show resolved Hide resolved
library/include/Core.h Outdated Show resolved Hide resolved
@ab9rf
simplifications
0f326c1 
no point in calling `owns_lock` twice
@myk002
Copy link
Member

myk002 commented Dec 18, 2024

I'm not certain of the full effect of this change, but the changes look reasonable to merge for practical testing

@myk002
Copy link
Member

myk002 commented Dec 19, 2024 •
edited
Loading

@lethosor any (blocking) concerns before we merge this?

@myk002 myk002 mentioned this pull request Dec 20, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NicksWorld NicksWorld NicksWorld left review comments

@dhthwy dhthwy dhthwy left review comments

@myk002 myk002 myk002 approved these changes

@lethosor lethosor Awaiting requested review from lethosor

Assignees
No one assigned
Labels
None yet
Projects
50.15-r2
Status: Review In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

console hang if user makes a typo while lua is busy
4 participants
@ab9rf @myk002 @dhthwy @NicksWorld