Truly independent web browser ladybird.org
Go to file
stasoid 17fcbce324 LibCore: Make single-shot timer objects manually reset on Windows
This fixes a really nasty EventLoop bug which I debugged for 2 weeks.

The spin_until([&]{return completed_tasks == total_tasks;}) in
TraversableNavigable::check_if_unloading_is_canceled spins forever.

Cause of the bug:

check_if_unloading_is_canceled is called deferred

check_if_unloading_is_canceled creates a task:

        queue_global_task(..., [&] {
            ...
            completed_tasks++;
        }));

This task is never executed.

queue_global_task calls TaskQueue::add

void TaskQueue::add(task)
{
    m_tasks.append(task);
    m_event_loop->schedule();
}

void HTML::EventLoop::schedule()
{
    if (!m_system_event_loop_timer)
        m_system_event_loop_timer = Timer::create_single_shot(
            0, // delay
            [&] { process(); });

    if (!m_system_event_loop_timer->is_active())
        m_system_event_loop_timer->restart();
}

EventLoop::process executes one task from task queue and calls
schedule again if there are more tasks.

So task processing relies on one single-shot zero-delay timer,
m_system_event_loop_timer.

Timers and other notification events are handled by Core::EventLoop
and Core::ThreadEventQueue, these are different from HTML::EventLoop
and HTML::TaskQueue mentioned above.

check_if_unloading_is_canceled is called using deferred_invoke
mechanism, different from m_system_event_loop_timer,
see Navigable::navigate and Core::EventLoop::deferred_invoke.

The core of the problem is that Core::EventLoop::pump is called again
(from spin_until) after timer fired but before its handler is executed.

In ThreadEventQueue::process events are moved into local variable before
executing. The first of those events is check_if_unloading_is_canceled.
One of the rest events is Web::HTML::EventLoop::process sheduled in
EventLoop::schedule using m_system_event_loop_timer.
When check_if_unloading_is_canceled calls queue_global_task its
m_system_event_loop_timer is still active because Timer::timer_event
was not yet called, so the timer is not restarted.
But Timer::timer_event (and hence EventLoop::process) will never execute
because check_if_unloading_is_canceled calls spin_until after
queue_global_task, and EventLoop::process is no longer in
event_queue.m_private->queued_events.

By making a single-shot timer manually-reset we are allowing it to fire
several times. So when spin_until is executed m_system_event_loop_timer
is fired again. Not an ideal solution, but this is the best I could
come up with. This commit makes the behavior match EventLoopImplUnix,
in which single-shot timer can also fire several times.

Adding event_queue.process(); at the start of pump like in EvtLoopImplQt
doesn't fix the problem.

Note: Timer::start calls EventReceiver::start_timer, which calls
EventLoop::register_timer with should_reload always set to true
(single-shot vs periodic are handled in Timer::timer_event instead),
so I use static_cast<Timer&>(object).is_single_shot() instead of
!should_reload.
2025-04-10 19:02:03 -06:00
.devcontainer Devcontainer: Set VCPKG_FORCE_SYSTEM_BINARIES when building cache 2025-02-18 15:33:51 -07:00
.github CI: Add nightly Swift jobs for both Linux and macOS 2025-04-03 16:47:48 -06:00
AK LibWeb/IDB: Add some debug output 2025-04-09 11:48:49 -06:00
Base/res LibWeb: Dispatch pointer events to ::backdrop originating element 2025-04-09 12:10:42 +01:00
Documentation Meta: Add a link job pool with a configurable size 2025-04-08 14:01:28 +02:00
Libraries LibCore: Make single-shot timer objects manually reset on Windows 2025-04-10 19:02:03 -06:00
Meta LibIPC+LibWeb: Delete LargeMessageWrapper workaround in IPC connection 2025-04-10 23:40:02 +02:00
Services LibWeb/CSS: Don't resolve @import URLs until they are used 2025-04-09 18:45:57 +01:00
Tests LibJS: Inline the fast path of Value::to_i32() and simplify to_u32() 2025-04-09 22:06:49 +02:00
Toolchain Meta: Update vcpkg to latest main revision 2025-04-03 08:03:48 -06:00
UI LibWebView: Do not use AK::format to format search engine URLs 2025-04-06 13:45:10 +02:00
Utilities LibJS: Make Value() default-construct the undefined value 2025-04-05 11:20:26 +02:00
.clang-format Meta: Support using clang-format on Objective-C++ files 2023-08-22 21:36:19 -04:00
.clang-tidy Meta: Disable clang-tidy “implicit-bool-conversion” check 2025-01-24 09:25:37 +01:00
.clangd Meta: Change the default build directories to exclude "ladybird" prefix 2024-11-06 10:38:57 -07:00
.editorconfig
.gitattributes LibGfx: Remove support for the various "portable" image formats 2024-06-17 21:57:35 +02:00
.gitignore Meta: Add swiftly .swift-version to .gitignore 2025-04-03 16:47:48 -06:00
.gn Meta: Automatically generate a compilation database for clangd 2023-11-14 14:29:35 -05:00
.mailmap Meta: Update my e-mail address everywhere 2024-10-04 13:19:50 +02:00
.pre-commit-config.yaml Meta: Replace deprecated pre-commit stage name 2024-10-18 09:40:59 +02:00
.prettierignore Everywhere: Hoist the Libraries folder to the top-level 2024-11-10 12:50:45 +01:00
.prettierrc
.swift-format Meta: Add swift-format configuration 2024-07-30 18:38:02 -06:00
.ycm_extra_conf.py Meta: Make YCM return flags as Python list 2024-07-06 14:50:43 -06:00
CMakeLists.txt UI/Qt: Migrate to LibWebView's autocomplete engine 2025-04-02 08:52:45 -04:00
CMakePresets.json Meta: Make the "Release" build type use -O3 and -flto 2025-04-01 13:44:05 +02:00
CODE_OF_CONDUCT.md Meta: Add code of conduct (from the Ruby community) 2024-10-02 09:49:52 +02:00
CONTRIBUTING.md Meta: Switch to clang-format-19 as the standard formatter 2024-12-28 05:39:32 -08:00
ISSUES.md Docs: Add info about --enable-idl-tracing flag 2025-01-15 13:25:35 +00:00
LICENSE Meta: Update license year 2025-02-10 11:40:57 +00:00
README.md Libraries: Remove LibArchive 2024-11-25 13:37:45 +01:00
SECURITY.md Documentation: Make updates to align better with new issue template 2024-10-31 09:18:08 +01:00
vcpkg-configuration.json Meta: Add overlay port for vulkan-loader 2024-07-07 15:56:59 +02:00
vcpkg.json Meta: Update curl to 8.13.0 2025-04-05 14:26:09 -04:00

Ladybird

Ladybird is a truly independent web browser, using a novel engine based on web standards.

Important

Ladybird is in a pre-alpha state, and only suitable for use by developers

Features

We aim to build a complete, usable browser for the modern web.

Ladybird uses a multi-process architecture with a main UI process, several WebContent renderer processes, an ImageDecoder process, and a RequestServer process.

Image decoding and network connections are done out of process to be more robust against malicious content. Each tab has its own renderer process, which is sandboxed from the rest of the system.

At the moment, many core library support components are inherited from SerenityOS:

  • LibWeb: Web rendering engine
  • LibJS: JavaScript engine
  • LibWasm: WebAssembly implementation
  • LibCrypto/LibTLS: Cryptography primitives and Transport Layer Security
  • LibHTTP: HTTP/1.1 client
  • LibGfx: 2D Graphics Library, Image Decoding and Rendering
  • LibUnicode: Unicode and locale support
  • LibMedia: Audio and video playback
  • LibCore: Event loop, OS abstraction layer
  • LibIPC: Inter-process communication

How do I build and run this?

See build instructions for information on how to build Ladybird.

Ladybird runs on Linux, macOS, Windows (with WSL2), and many other *Nixes.

How do I read the documentation?

Code-related documentation can be found in the documentation folder.

Get in touch and participate!

Join our Discord server to participate in development discussion.

Please read Getting started contributing if you plan to contribute to Ladybird for the first time.

Before opening an issue, please see the issue policy and the detailed issue-reporting guidelines.

The full contribution guidelines can be found in CONTRIBUTING.md.

License

Ladybird is licensed under a 2-clause BSD license.