Skip to content

Add coroutine semaphore#6891

Merged
waruqi merged 7 commits intodevfrom
sem
Oct 5, 2025
Merged

Add coroutine semaphore#6891
waruqi merged 7 commits intodevfrom
sem

Conversation

@waruqi
Copy link
Member

@waruqi waruqi commented Oct 4, 2025

  • Before adding new features and new modules, please go to issues to submit the relevant feature description first.
  • Write good commit messages and use the same coding conventions as the rest of the project.
  • Please commit code to dev branch and we will merge into master branch in feature
  • Ensure your edited codes with four spaces instead of TAB.

  • 增加新特性和新模块之前,请先到issues提交相关特性说明,经过讨论评估确认后,再进行相应的代码提交,避免做无用工作。
  • 编写友好可读的提交信息,并使用与工程代码相同的代码规范,代码请用4个空格字符代替tab缩进。
  • 请提交代码到dev分支,如果通过,我们会在特定时间合并到master分支上。
  • 为了规范化提交日志的格式,commit消息,不要用中文,请用英文描述。

@waruqi waruqi added this to the v3.0.4 milestone Oct 4, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @waruqi, 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 a robust coroutine semaphore mechanism to the project's scheduler, enabling more sophisticated control over concurrent coroutine execution. This feature allows developers to manage access to shared resources or limit the number of active coroutines, thereby improving the handling of asynchronous operations and resource contention. The changes include the core semaphore implementation, its integration into the scheduler, and necessary sandbox adaptations, alongside new test cases to validate its functionality and performance.

Highlights

  • Coroutine Semaphore Implementation: Introduced a new _semaphore module within the core scheduler to provide coroutine-based semaphore functionality, including new, post, and wait operations for managing concurrent access.
  • Scheduler Integration: The core scheduler now exposes a co_semaphore function, allowing for the creation of these new coroutine semaphores directly through the scheduler interface.
  • Sandbox Compatibility: Added specific wrapping logic in the sandbox module to ensure the new co_semaphore and its methods (post, wait) function correctly and safely within the sandboxed environment.
  • Benchmarking and Testing: Included new test files to benchmark asynchronous job execution (runjobs.lua) and to demonstrate the usage and behavior of the newly added coroutine semaphore (semaphore.lua).
  • Minor Code Cleanup: A small, non-functional comment was removed from core/src/xmake/os/getenvs.c.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Copy link
Contributor

@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

This pull request introduces a coroutine semaphore, a useful synchronization primitive for concurrent programming. The implementation is mostly solid, but I've found a few issues, including a critical memory leak in the wait function on timeout and a bug in __tostring. I've also suggested some improvements for clarity and efficiency in the post method and pointed out an issue in the sandboxed wrapper. Additionally, there's a minor issue in one of the new test files.

Comment on lines +118 to +120
if timeout then
break
end
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

If the wait operation times out, the coroutine is not removed from the self._WAITING set. This is a memory leak and can lead to incorrect behavior, as the coroutine will remain in the waiting queue. You should remove the coroutine from the waiting set when a timeout occurs.

        if timeout then
            self._WAITING:remove(running)
            break
        end


-- tostring(semaphore)
function _semaphore:__tostring()
return string.format("<sem: %s/%d>", self:name(), self:value())
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

The __tostring metamethod calls self:value(), but this method is not defined for _semaphore. This will cause a runtime error. You should either implement the value() method or directly access self._VALUE.

    return string.format("<sem: %s/%d>", self:name(), self._VALUE)

Comment on lines +53 to +59
function sandbox_core_base_scheduler_semaphore.post(semaphore, value)
local result, errors = semaphore:_post(value)
if result < 0 and errors then
raise(errors)
end
return result
end
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The error handling for the wrapped post function appears to be incorrect. The original _semaphore:post function returns the new semaphore value and does not return an error tuple. Consequently, errors will always be nil, and the condition result < 0 and errors will never be true. This error check is likely dead code and should be removed.

function sandbox_core_base_scheduler_semaphore.post(semaphore, value)
    return semaphore:_post(value)
end

local value = semaphore:wait(-1)
print("[%d]: -> triggered, value: %d ..", id, value)
end
print("[%d]: end", id)
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This print statement is unreachable because it is placed after an infinite while true loop. If the loop is intended to run forever, this line should be removed to avoid confusion.

Comment on lines +53 to +69
function _semaphore:post(value)
value = self._VALUE + value
self._VALUE = value
if value > 0 then
local pending = {}
local waiting = self._WAITING
for item in waiting:items() do
if #pending < value then
table.insert(pending, item)
end
end
for _, item in ipairs(pending) do
scheduler:co_resume(item)
end
end
return value
end
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The implementation of post has a couple of areas for improvement:

  1. The value variable is reused for both the input parameter and the new semaphore value, which can be confusing. Using a separate variable for the new value would improve clarity.
  2. The loop that collects waiting coroutines iterates over all of them, even if enough have been found. It would be more efficient to break the loop once the required number of pending coroutines is reached.
function _semaphore:post(value_to_add)
    local new_value = self._VALUE + value_to_add
    self._VALUE = new_value
    if new_value > 0 then
        local pending = {}
        local waiting = self._WAITING
        for item in waiting:items() do
            if #pending < new_value then
                table.insert(pending, item)
            else
                break
            end
        end
        for _, item in ipairs(pending) do
            scheduler:co_resume(item)
        end
    end
    return new_value
end

@waruqi waruqi merged commit 6ffb08d into dev Oct 5, 2025
41 of 44 checks passed
@waruqi waruqi deleted the sem branch October 5, 2025 01:45
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.

1 participant