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.

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

RFC 2: Queues #15345

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

ysbaddaden
Copy link
Contributor

@ysbaddaden ysbaddaden commented Jan 14, 2025

Introduces 3 queues that will be used the ExecutionContext schedulers. They derivate from Go's internal queues (q, runq and globrunq).

  1. Fiber::Queue: holds an unbounded singly-linked list of Fiber with a bulk insert operation.

    Note: we may consider renaming Fiber::Queue as Fiber::List and Fiber#schedlink as Fiber#list_next?

  2. ExecutionContext::GlobalQueue: wraps a Fiber::Queue with optional thread-safety and a bulk grab operation. There will be a single global queue per execution context shared among one or more schedulers.

    The point is to have an unbounded space to store as many fibers as needed, or to store cross context enqueues —the runnables queue below only supports a single producer.

  3. ExecutionContext::Runnables: a bounded, lock-free, chase-lev queue (single producer, multiple consumers) with bulk operations. There will be a one runnables queue per execution context scheduler (aka local queue).

    On overflow or underflow it pushes/grabs half the queue size to/from the global queue (locking the mutex once in a while).

    Any scheduler can steal from any runnables queue in the execution context at any time, directly into their own local queue.

    The point is to have a quick list to push/pop and steal from, and to limit the occurrences where we must lock the scheduler mutex to reach to the global queue.

Refs #15342

Simple abstraction on top of a mutex and condition variable to
synchronize the execution of a set of threads.
@BlobCodes
Copy link
Contributor

Fiber::Queue: holds an unbounded singly-linked list of Fiber

Isn't that a Stack / LIFO?

@yxhuvud
Copy link
Contributor

yxhuvud commented Jan 14, 2025

How much of the queues will be public interface that are hard to change later on?

@ysbaddaden
Copy link
Contributor Author

ysbaddaden commented Jan 14, 2025

@BlobCodes Yes, it's a LIFO singly linked list (in contrast to the FIFO doubly linked list of Crystal::PointerLinkedList).

@yxhuvud Good call, they should all be :nodoc: (I missed GlobalQueue) at least for the time being!

@ysbaddaden ysbaddaden force-pushed the feature/execution-context-queues branch from defe37d to 7c67d27 Compare January 20, 2025 17:45
@ysbaddaden
Copy link
Contributor Author

Moved to Fiber::ExecutionContext as per #15350.

src/fiber.cr Outdated
@@ -66,6 +66,9 @@ class Fiber
# :nodoc:
property previous : Fiber?

# :nodoc:
property schedlink : Fiber?
Copy link
Member

Choose a reason for hiding this comment

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

issue: This property name is far from self-explanatory. Could you add some description why it's there and what it does?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I renamed it as #queue_next but it felt weird. Since it's not really a queue but just a list of fibers, I went with my suggestion to rename Fiber::Queue as Fiber::List and this property as #list_next and it feels better overall.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we could move this declaration to src/fiber/list.cr too 🤔

src/fiber/queue.cr Outdated Show resolved Hide resolved
src/fiber/execution_context/runnables.cr Outdated Show resolved Hide resolved
src/fiber/execution_context/runnables.cr Outdated Show resolved Hide resolved
@ysbaddaden
Copy link
Contributor Author

The MinGW failure on CI should be fixed by #15404.

@straight-shoota
Copy link
Member

Hm, that'll leave MinGW broken until we merge that fixup then? 🤔

@ysbaddaden
Copy link
Contributor Author

ysbaddaden commented Feb 4, 2025

That's possible, yes.

We might want to split #15404:

Doesn't change the public API (the stack is still taken from the current
scheduler's stack pool), but introduces an undocumented initializer that
takes the stack and stack_bottom pointers.

This will allow a few scenarios, mostly for RFC 2:

- start fibers with a fake stack when we don't need to run the fibers,
  for example during specs that only need fiber objects (and would leak
  memory since we only release stacks after the fiber has run);
- during a cross execution context spawn, we can pick a stack from the
  destination context instead of the current context (so we can recycle
  stacks from fibers that terminated in the desination context).
@ysbaddaden
Copy link
Contributor Author

Updated to add:

  1. cherry-pick the commit that adds the stack arguments to Fiber#initialize;
  2. use fake stacks in the queue specs.

Let's avoid any further changes 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants