Skip to content

lua: add healthchecking and file searchers exclusion #108

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.

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

Merged
merged 2 commits into from
Jul 30, 2025

Conversation

adamgreloch
Copy link
Member

@adamgreloch adamgreloch commented Jul 17, 2025

Description

Adds opt-in main loop healthchecking useful for in-C-call hang detection. It also adds an opt-in exclusion of file searchers to further harden the interpreter

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (refactoring, style fixes, git/CI config, submodule management, no code logic changes)

How Has This Been Tested?

  • Already covered by automatic testing.
  • New test added: (add PR link here).
  • Tested by hand on: host, nilee

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing linter checks and tests passed.
  • My changes generate no new compilation warnings for any of the targets.

Special treatment

  • This PR needs additional PRs to work (list the PRs, preferably in merge-order).
  • I will merge this PR by myself when appropriate.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @adamgreloch, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces significant enhancements to Lua's robustness and integration capabilities, primarily by adding an opt-in healthchecking mechanism for the main loop and providing a configurable way to handle unhandled panics more gracefully in multithreaded environments. These changes aim to improve the stability and diagnosability of Lua applications, especially when embedded in larger systems.

Highlights

  • Opt-in Healthchecking: I've implemented an opt-in healthchecking mechanism for the Lua main loop. This feature is designed to detect hangs, particularly those occurring during long-running C-call executions, by allowing an external entity to query the Lua VM's responsiveness.
  • MT-Safe Heartbeat API: To support the healthchecking, I've exposed new, thread-safe C API functions: lua_sendheartbeatrequest and lua_getheartbeatresponse. These functions enable external components to safely request and receive heartbeat responses from the Lua VM, facilitating robust hang detection.
  • Configurable Panic Handling: I've added an opt-in feature that allows replacing the default abort() behavior with pthread_exit() when an unhandled Lua panic occurs. This is crucial for multithreaded applications, as it prevents the entire process from crashing due to a single thread's unhandled panic, allowing other threads to continue execution.
  • Internal Name Clash Resolution: As part of these changes, I've resolved a potential name clash by renaming the internal priority array to lpriority in src/lparser.c. This prevents conflicts with priority() functions that might be included from sys/threads.h.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@adamgreloch adamgreloch marked this pull request as ready for review July 17, 2025 07:22
@adamgreloch adamgreloch requested a review from Darchiv July 17, 2025 07:22
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request introduces healthchecking and replaces abort() with pthread_exit() on panic. The review identifies a critical bug in the use of pthread_exit that leads to undefined behavior, and uninitialized variables in the health check feature. There are also recommendations to fix typos in comments.

@adamgreloch adamgreloch force-pushed the adamgreloch/NIL-726 branch from a95b476 to 78b3dba Compare July 17, 2025 07:29
Copy link

github-actions bot commented Jul 17, 2025

Unit Test Results

8 039 tests  ±0   7 515 ✅ ±0   41m 52s ⏱️ - 2m 1s
  479 suites ±0     524 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit ecfb6b2. ± Comparison against base commit 8b776e4.

♻️ This comment has been updated with latest results.

@adamgreloch adamgreloch force-pushed the adamgreloch/NIL-726 branch from 78b3dba to ecfb6b2 Compare July 22, 2025 07:10
@adamgreloch adamgreloch changed the title lua: add healthchecking, don't abort on panic lua: add healthchecking and file searchers exclusion Jul 22, 2025
@Darchiv Darchiv merged commit e8db984 into master Jul 30, 2025
38 checks passed
@Darchiv Darchiv deleted the adamgreloch/NIL-726 branch July 30, 2025 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants