mirror of
https://codeberg.org/ziglang/zig.git
synced 2026-03-14 02:06:16 +01:00
dcc3e6e1dd
This commit replaces the "fuzzer" UI, previously accessed with the `--fuzz` and `--port` flags, with a more interesting web UI which allows more interactions with the Zig build system. Most notably, it allows accessing the data emitted by a new "time report" system, which allows users to see which parts of Zig programs take the longest to compile. The option to expose the web UI is `--webui`. By default, it will listen on `[::1]` on a random port, but any IPv6 or IPv4 address can be specified with e.g. `--webui=[::1]:8000` or `--webui=127.0.0.1:8000`. The options `--fuzz` and `--time-report` both imply `--webui` if not given. Currently, `--webui` is incompatible with `--watch`; specifying both will cause `zig build` to exit with a fatal error. When the web UI is enabled, the build runner spawns the web server as soon as the configure phase completes. The frontend code consists of one HTML file, one JavaScript file, two CSS files, and a few Zig source files which are built into a WASM blob on-demand -- this is all very similar to the old fuzzer UI. Also inherited from the fuzzer UI is that the build system communicates with web clients over a WebSocket connection. When the build finishes, if `--webui` was passed (i.e. if the web server is running), the build runner does not terminate; it continues running to serve web requests, allowing interactive control of the build system. In the web interface is an overall "status" indicating whether a build is currently running, and also a list of all steps in this build. There are visual indicators (colors and spinners) for in-progress, succeeded, and failed steps. There is a "Rebuild" button which will cause the build system to reset the state of every step (note that this does not affect caching) and evaluate the step graph again. If `--time-report` is passed to `zig build`, a new section of the interface becomes visible, which associates every build step with a "time report". For most steps, this is just a simple "time taken" value. However, for `Compile` steps, the compiler communicates with the build system to provide it with much more interesting information: time taken for various pipeline phases, with a per-declaration and per-file breakdown, sorted by slowest declarations/files first. This feature is still in its early stages: the data can be a little tricky to understand, and there is no way to, for instance, sort by different properties, or filter to certain files. However, it has already given us some interesting statistics, and can be useful for spotting, for instance, particularly complex and slow compile-time logic. Additionally, if a compilation uses LLVM, its time report includes the "LLVM pass timing" information, which was previously accessible with the (now removed) `-ftime-report` compiler flag. To make time reports more useful, ZIR and compilation caches are ignored by the Zig compiler when they are enabled -- in other words, `Compile` steps *always* run, even if their result should be cached. This means that the flag can be used to analyze a project's compile time without having to repeatedly clear cache directory, for instance. However, when using `-fincremental`, updates other than the first will only show you the statistics for what changed on that particular update. Notably, this gives us a fairly nice way to see exactly which declarations were re-analyzed by an incremental update. If `--fuzz` is passed to `zig build`, another section of the web interface becomes visible, this time exposing the fuzzer. This is quite similar to the fuzzer UI this commit replaces, with only a few cosmetic tweaks. The interface is closer than before to supporting multiple fuzz steps at a time (in line with the overall strategy for this build UI, the goal will be for all of the fuzz steps to be accessible in the same interface), but still doesn't actually support it. The fuzzer UI looks quite different under the hood: as a result, various bugs are fixed, although other bugs remain. For instance, viewing the source code of any file other than the root of the main module is completely broken (as on master) due to some bogus file-to-module assignment logic in the fuzzer UI. Implementation notes: * The `lib/build-web/` directory holds the client side of the web UI. * The general server logic is in `std.Build.WebServer`. * Fuzzing-specific logic is in `std.Build.Fuzz`. * `std.Build.abi` is the new home of `std.Build.Fuzz.abi`, since it now relates to the build system web UI in general. * The build runner now has an **actual** general-purpose allocator, because thanks to `--watch` and `--webui`, the process can be arbitrarily long-lived. The gpa is `std.heap.DebugAllocator`, but the arena remains backed by `std.heap.page_allocator` for efficiency. I fixed several crashes caused by conflation of `gpa` and `arena` in the build runner and `std.Build`, but there may still be some I have missed. * The I/O logic in `std.Build.WebServer` is pretty gnarly; there are a *lot* of threads involved. I anticipate this situation improving significantly once the `std.Io` interface (with concurrency support) is introduced. |
||
|---|---|---|
| .. | ||
| Build | ||
| builtin | ||
| c | ||
| compress | ||
| crypto | ||
| debug | ||
| dwarf | ||
| fmt | ||
| fs | ||
| hash | ||
| heap | ||
| http | ||
| Io | ||
| json | ||
| math | ||
| mem | ||
| meta | ||
| net | ||
| os | ||
| posix | ||
| process | ||
| Random | ||
| sort | ||
| tar | ||
| Target | ||
| testing | ||
| Thread | ||
| time | ||
| tz | ||
| unicode | ||
| valgrind | ||
| zig | ||
| zip | ||
| zon | ||
| array_hash_map.zig | ||
| array_list.zig | ||
| ascii.zig | ||
| atomic.zig | ||
| base64.zig | ||
| bit_set.zig | ||
| BitStack.zig | ||
| bounded_array.zig | ||
| buf_map.zig | ||
| buf_set.zig | ||
| Build.zig | ||
| builtin.zig | ||
| c.zig | ||
| coff.zig | ||
| compress.zig | ||
| crypto.zig | ||
| debug.zig | ||
| DoublyLinkedList.zig | ||
| dwarf.zig | ||
| dynamic_library.zig | ||
| elf.zig | ||
| enums.zig | ||
| fifo.zig | ||
| fmt.zig | ||
| fs.zig | ||
| gpu.zig | ||
| hash.zig | ||
| hash_map.zig | ||
| heap.zig | ||
| http.zig | ||
| Io.zig | ||
| json.zig | ||
| leb128.zig | ||
| log.zig | ||
| macho.zig | ||
| math.zig | ||
| mem.zig | ||
| meta.zig | ||
| multi_array_list.zig | ||
| net.zig | ||
| once.zig | ||
| os.zig | ||
| pdb.zig | ||
| pie.zig | ||
| posix.zig | ||
| priority_dequeue.zig | ||
| priority_queue.zig | ||
| process.zig | ||
| Progress.zig | ||
| Random.zig | ||
| RingBuffer.zig | ||
| segmented_list.zig | ||
| SemanticVersion.zig | ||
| simd.zig | ||
| SinglyLinkedList.zig | ||
| sort.zig | ||
| start.zig | ||
| static_string_map.zig | ||
| std.zig | ||
| tar.zig | ||
| Target.zig | ||
| testing.zig | ||
| Thread.zig | ||
| time.zig | ||
| treap.zig | ||
| tz.zig | ||
| unicode.zig | ||
| Uri.zig | ||
| valgrind.zig | ||
| wasm.zig | ||
| zig.zig | ||
| zip.zig | ||
| zon.zig | ||