Dependency graph work - Part 1 - Preliminary work (#3505)

Relates to #1353 

This adds no new functionality or overhead to the compiler, yet. This is
the preliminary work that has:
- added code to the compiler in several spots to flag when something is
used without being properly required/imported/whatever (disabled by
default)
- that was used to generate project wide file dependencies (some
circulars were manually fixed)
- then that graph underwent a transitive reduction and the result was
written to all `jak1` source files.

The next step will be making this actually produce and use a dependency
graph. Some of the reasons why I'm working on this:
- eliminates more `game.gp` boilerplate. This includes the `.gd` files
to some extent (`*-ag` files and `tpage` files will still need to be
handled) this is the point of the new `bundles` form. This should make
it even easier to add a new file into the source tree.
- a build order that is actually informed from something real and
compiler warnings that tell you when you are using something that won't
be available at build time.
- narrows the search space for doing LSP actions -- like searching for
references. Since it would be way too much work to store in the compiler
every location where every symbol/function/etc is used, I have to do
ad-hoc searches. By having a dependency graph i can significantly reduce
that search space.
- opens the doors for common shared code with a legitimate pattern.
Right now jak 2 shares code from the jak 1 folder. This is basically a
hack -- but by having an explicit require syntax, it would be possible
to reference arbitrary file paths, such as a `common` folder.

Some stats:
- Jak 1 has about 2500 edges between files, including transitives
- With transitives reduced at the source code level, each file seems to
have a modest amount of explicit requirements.

Known issues:
- Tracking the location for where `defmacro`s and virtual state
definitions were defined (and therefore the file) is still problematic.
Because those forms are in a macro environment, the reader does not
track them. I'm wondering if a workaround could be to search the
reader's text_db by not just the `goos::Object` but by the text
position. But for the purposes of finishing this work, I just statically
analyzed and searched the code with throwaway python code.
This commit is contained in:
Tyler Wilding
2024-05-12 12:37:59 -04:00
committed by GitHub
parent e0b1d8c21e
commit d1ece445d4
557 changed files with 3200 additions and 179 deletions
+21 -3
View File
@@ -3,6 +3,8 @@
* Calling and defining functions, lambdas, and inlining.
*/
#include "common/util/string_util.h"
#include "goalc/compiler/Compiler.h"
#include "goalc/emitter/CallingConvention.h"
@@ -315,10 +317,26 @@ Val* Compiler::compile_lambda(const goos::Object& form, const goos::Object& rest
*/
Val* Compiler::compile_function_or_method_call(const goos::Object& form, Env* env) {
goos::Object f = form;
auto fe = env->function_env();
const auto fe = env->function_env();
auto args = get_va(form, form);
auto uneval_head = args.unnamed.at(0);
const auto args = get_va(form, form);
const auto& uneval_head = args.unnamed.at(0);
if (m_settings.check_for_requires) {
const auto& symbol_info = m_symbol_info.lookup_exact_name(uneval_head.print());
if (!symbol_info.empty()) {
const auto& result = symbol_info.at(0);
if (result->m_def_location.has_value() &&
!env->file_env()->m_missing_required_files.contains(result->m_def_location->file_path) &&
env->file_env()->m_required_files.find(result->m_def_location->file_path) ==
env->file_env()->m_required_files.end() &&
!str_util::ends_with(result->m_def_location->file_path,
env->file_env()->name() + ".gc")) {
lg::warn("Missing require in {} for {} over {}", env->file_env()->name(),
result->m_def_location->file_path, uneval_head.print());
env->file_env()->m_missing_required_files.insert(result->m_def_location->file_path);
}
}
}
Val* head = get_none();
// determine if this call should be automatically inlined.