Add k2-lib mode (#1385)

mkornaukhov · web-flow · commit d365fc0a5c3d · 2025-08-08T14:50:53.000+03:00
diff --git a/compiler/code-gen/const-globals-batched-mem.cpp b/compiler/code-gen/const-globals-batched-mem.cpp
@@ -301,7 +301,7 @@ void GlobalsMemAllocation::compile(CodeGenerator &W) const {
   W << "// count(php global scope) = " << mem.count_of_php_global_scope << NL;
   W << "// n_batches = " << mem.batches.size() << NL;
 
-  if (!G->is_output_mode_lib()) {
+  if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
     W << "php_globals.once_alloc_linear_mem(" << mem.total_mem_size << ");" << NL;
   } else {
     W << "php_globals.once_alloc_linear_mem(\"" << G->settings().static_lib_name.get() << "\", " << mem.total_mem_size << ");" << NL;
@@ -331,7 +331,7 @@ void PhpMutableGlobalsConstRefArgument::compile(CodeGenerator &W) const {
 void GlobalVarInPhpGlobals::compile(CodeGenerator &W) const {
   if (global_var->is_builtin_runtime) {
     W << "php_globals.get_superglobals().v$" << global_var->name;
-  } else if (!G->is_output_mode_lib()) {
+  } else if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
     W << "(*reinterpret_cast<" << type_out(tinf::get_type(global_var)) << "*>(php_globals.mem()+" << global_var->offset_in_linear_mem << "))";
   } else {
     W << "(*reinterpret_cast<" << type_out(tinf::get_type(global_var)) << "*>(php_globals.mem_for_lib(\"" << G->settings().static_lib_name.get() << "\")+" << global_var->offset_in_linear_mem << "))";
diff --git a/compiler/code-gen/files/const-vars-init.cpp b/compiler/code-gen/files/const-vars-init.cpp
@@ -59,7 +59,7 @@ void ConstVarsInit::compile_const_init_part(CodeGenerator &W, const ConstantsBat
   IncludesCollector includes;
   ConstantsExternCollector c_mem_extern;
   for (VarPtr var : batch.constants) {
-    if (!G->is_output_mode_lib()) {
+    if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
       includes.add_var_signature_depends(var);
       includes.add_vertex_depends(var->init_val);
     }
diff --git a/compiler/code-gen/files/init-scripts.cpp b/compiler/code-gen/files/init-scripts.cpp
@@ -20,7 +20,7 @@ struct StaticInit {
 };
 
 void StaticInit::compile(CodeGenerator &W) const {
-  if (G->is_output_mode_lib()) {
+  if (G->is_output_mode_lib() || G->is_output_mode_k2_lib()) {
     return;
   }
 
@@ -220,7 +220,7 @@ void InitScriptsCpp::compile(CodeGenerator &W) const {
 
   W << NL << StaticInit() << NL;
 
-  if (G->is_output_mode_lib()) {
+  if (G->is_output_mode_lib() || G->is_output_mode_k2_lib()) {
     W << LibRunFunction(main_file_id->main_function);
     W << CloseFile();
     return;
diff --git a/compiler/compiler-core.cpp b/compiler/compiler-core.cpp
@@ -139,6 +139,8 @@ void CompilerCore::register_settings(CompilerSettings *settings) {
     output_mode = OutputMode::k2_oneshot;
   } else if (mode == "k2-multishot") {
     output_mode = OutputMode::k2_multishot;
+  } else if (mode == "k2-lib") {
+    output_mode = OutputMode::k2_lib;
   } else {
     output_mode = OutputMode::server;
   }
diff --git a/compiler/compiler-core.h b/compiler/compiler-core.h
@@ -28,6 +28,7 @@ enum class OutputMode {
   server,       // -M server
   cli,          // -M cli
   lib,          // -M lib
+  k2_lib,       // -M k2-lib
   k2_cli,       // -M k2-cli
   k2_server,    // -M k2-server
   k2_oneshot,   // -M k2-oneshot
@@ -202,6 +203,10 @@ class CompilerCore {
     return output_mode == OutputMode::lib;
   }
 
+  bool is_output_mode_k2_lib() const {
+    return output_mode == OutputMode::k2_lib;
+  }
+
   bool is_output_mode_k2_cli() const {
     return output_mode == OutputMode::k2_cli;
   }
@@ -219,7 +224,7 @@ class CompilerCore {
   }
 
   bool is_output_mode_k2() const {
-    return is_output_mode_k2_cli() || is_output_mode_k2_server() || is_output_mode_k2_oneshot() || is_output_mode_k2_multishot();
+    return is_output_mode_k2_cli() || is_output_mode_k2_server() || is_output_mode_k2_oneshot() || is_output_mode_k2_multishot() || is_output_mode_k2_lib();
   }
 
   void set_exclude_namespaces(std::vector<std::string> &&excludes) {
diff --git a/compiler/compiler-settings.cpp b/compiler/compiler-settings.cpp
@@ -251,7 +251,7 @@ void CompilerSettings::init() {
     kphp_error(is_k2_mode, "Option \"k2-component-name\" is only available for k2 component modes");
   }
 
-  if (mode.get() == "lib") {
+  if (mode.get() == "lib" || mode.get() == "k2-lib") {
     if (!tl_schema_file.get().empty()) {
       throw std::runtime_error{"Option " + tl_schema_file.get_env_var() + " is forbidden for static lib mode"};
     }
diff --git a/compiler/kphp2cpp.cpp b/compiler/kphp2cpp.cpp
@@ -217,8 +217,8 @@ int main(int argc, char *argv[]) {
              "tracked-builtins-list", "KPHP_TRACKED_BUILTINS_LIST");
   parser.add("File with kphp runtime sha256 hash", settings->runtime_sha256_file,
              "runtime-sha256", "KPHP_RUNTIME_SHA256", "${KPHP_PATH}/objs/php_lib_version.sha256");
-  parser.add("The output binary type: server, cli, lib, k2-cli, k2-server, k2-oneshot, k2-multishot", settings->mode, 'M', "mode", "KPHP_MODE", "server",
-             {"server", "cli", "lib", "k2-cli", "k2-server", "k2-oneshot", "k2-multishot"});
+  parser.add("The output binary type: server, cli, lib, k2-lib, k2-cli, k2-server, k2-oneshot, k2-multishot", settings->mode, 'M', "mode", "KPHP_MODE", "server",
+             {"server", "cli", "lib", "k2-lib", "k2-cli", "k2-server", "k2-oneshot", "k2-multishot"});
   parser.add("A runtime library for building the output binary", settings->link_file,
              'l', "link-with", "KPHP_LINK_FILE");
   parser.add("Build runtime from sources", settings->force_link_runtime,
diff --git a/compiler/make/make.cpp b/compiler/make/make.cpp
@@ -538,9 +538,10 @@ static std::vector<File *> run_pre_make(OutputMode output_mode, const CompilerSe
   }
 
   auto lib_header_dirs = collect_imported_headers();
-  auto targets = output_mode == OutputMode::lib ? kphp_make_static_lib_target(obj_index, G->get_index(), lib_header_dirs, make)
-                                                : kphp_make_target(obj_index, G->get_index(), lib_header_dirs, make);
-  for (File * file : targets) {
+  auto targets = vk::any_of_equal(output_mode, OutputMode::lib, OutputMode::k2_lib)
+                     ? kphp_make_static_lib_target(obj_index, G->get_index(), lib_header_dirs, make)
+                     : kphp_make_target(obj_index, G->get_index(), lib_header_dirs, make);
+  for (File* file : targets) {
     response.push_back(file);
   }
 
@@ -569,8 +570,7 @@ void run_make() {
   auto objs = run_pre_make(output_mode, settings, make_stats_file, make, obj_index, bin_file, obj_rt_index);
   stage::die_if_global_errors();
 
-  if (G->is_output_mode_lib()) {
-    // todo:k2 think about kphp libraries
+  if (G->is_output_mode_lib() || G->is_output_mode_k2_lib()) {
     make.create_objs2static_lib_target(objs, &bin_file);
   } else if (G->is_output_mode_k2()) {
     make.create_objs2k2_component_target(objs, &bin_file);
@@ -584,8 +584,10 @@ void run_make() {
   }
   stage::die_if_global_errors();
 
-  const std::string build_stage{output_mode == OutputMode::lib ? "Compiling" : "Linking"};
-  stage::set_exit_code(output_mode == OutputMode::lib ? ExitCode::CPP_TO_OBJS_STAGE : ExitCode::OBJS_TO_BINARY_STAGE);
+  const bool is_lib = vk::any_of_equal(output_mode, OutputMode::lib, OutputMode::k2_lib);
+
+  const std::string build_stage{is_lib ? "Compiling" : "Linking"};
+  stage::set_exit_code(is_lib ? ExitCode::CPP_TO_OBJS_STAGE : ExitCode::OBJS_TO_BINARY_STAGE);
   AutoProfiler profiler{get_profiler(build_stage)};
 
   bool ok = make.make_target(&bin_file, build_stage, settings.jobs_count.get());
@@ -610,7 +612,7 @@ void run_make() {
   if (!settings.user_binary_path.get().empty()) {
     hard_link_or_copy(bin_file.path, settings.user_binary_path.get());
   }
-  if (output_mode == OutputMode::lib) {
+  if (vk::any_of_equal(output_mode, OutputMode::lib, OutputMode::k2_lib)) {
     copy_static_lib_to_out_dir(std::move(bin_file));
   }
 }
diff --git a/compiler/pipes/calc-bad-vars.cpp b/compiler/pipes/calc-bad-vars.cpp
@@ -628,7 +628,7 @@ class CalcBadVars {
       function->dep = std::move(call_graph.graph[function]);
     }
 
-    if (!G->is_output_mode_lib()) {
+    if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
       return;
     }
 
diff --git a/compiler/pipes/calc-empty-functions.cpp b/compiler/pipes/calc-empty-functions.cpp
@@ -90,7 +90,7 @@ void CalcEmptyFunctions::execute(FunctionPtr f, DataStream<FunctionPtr> &os) {
   stage::set_function(f);
   f->body_seq = calc_function_body_type(f);
 
-  if (f->is_main_function() && G->is_output_mode_lib() && G->get_main_file()->main_function == f) {
+  if (f->is_main_function() && (G->is_output_mode_lib() || G->is_output_mode_k2_lib()) && G->get_main_file()->main_function == f) {
     kphp_error(f->body_seq == FunctionData::body_value::empty, "main php file of a lib mustn't contain code, only declarations");
   }
 
diff --git a/compiler/pipes/code-gen.cpp b/compiler/pipes/code-gen.cpp
@@ -95,14 +95,14 @@ void CodeGenF::on_finish(DataStream<std::unique_ptr<CodeGenRootCmd>> &os) {
     }
   }
 
-  if (G->settings().enable_global_vars_memory_stats.get() && !G->is_output_mode_lib()) {
+  if (G->settings().enable_global_vars_memory_stats.get() && !G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
     code_gen_start_root_task(os, std::make_unique<GlobalVarsMemoryStats>(all_globals));
   }
   code_gen_start_root_task(os, std::make_unique<InitScriptsCpp>(G->get_main_file()));
   code_gen_start_root_task(os, std::make_unique<ConstVarsInit>(all_constants_in_mem));
   code_gen_start_root_task(os, std::make_unique<GlobalVarsReset>(all_globals_in_mem));
 
-  if (G->is_output_mode_lib()) {
+  if (G->is_output_mode_lib() || G->is_output_mode_k2_lib()) {
     std::vector<FunctionPtr> exported_functions;
     for (FunctionPtr f : all_functions) {
       if (f->kphp_lib_export) {
@@ -116,7 +116,7 @@ void CodeGenF::on_finish(DataStream<std::unique_ptr<CodeGenRootCmd>> &os) {
   }
 
   // TODO: should be done in lib mode also, but in some other way
-  if (!G->is_output_mode_lib()) {
+  if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {
     if (!G->is_output_mode_k2()) {
       code_gen_start_root_task(os, std::make_unique<TypeTagger>(vk::singleton<ForkableTypeStorage>::get().flush_forkable_types(),
                                                                 vk::singleton<ForkableTypeStorage>::get().flush_waitable_types()));
diff --git a/compiler/pipes/gen-tree-postprocess.cpp b/compiler/pipes/gen-tree-postprocess.cpp
@@ -90,7 +90,7 @@ VertexAdaptor<op_require> make_require_once_call(SrcFilePtr lib_main_file, Verte
 }
 
 VertexPtr process_require_lib(VertexAdaptor<op_func_call> require_lib_call) {
-  kphp_error_act (!G->is_output_mode_lib(), "require_lib is forbidden to use for compiling libs", return require_lib_call);
+  kphp_error_act (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib(), "require_lib is forbidden to use for compiling libs", return require_lib_call);
   VertexRange args = require_lib_call->args();
   kphp_error_act (args.size() == 1, fmt_format("require_lib expected 1 arguments, got {}", args.size()), return require_lib_call);
   auto lib_name_node = args[0];
diff --git a/compiler/pipes/remove-empty-function-calls.cpp b/compiler/pipes/remove-empty-function-calls.cpp
@@ -46,7 +46,7 @@ VertexPtr RemoveEmptyFunctionCallsPass::on_exit_vertex(VertexPtr v) {
     // get rid of $called - global variables for empty source files;
     // namely, detect 'v$src_fooxxx$called = true' assign in such files and remove it,
     // this allows to avoid further call of register_var() with such global variable
-    if (!G->is_output_mode_lib() && current_function->is_main_function() && current_function->body_seq == FunctionData::body_value::empty) {
+    if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib() && current_function->is_main_function() && current_function->body_seq == FunctionData::body_value::empty) {
       auto set = v.as<op_set>();
       auto lhs = set->lhs();
       auto rhs = set->rhs();
diff --git a/tests/python/lib/testcase.py b/tests/python/lib/testcase.py
@@ -357,11 +357,24 @@ def should_use_k2(cls):
         return search_k2_bin() is not None
 
     @classmethod
-    def kphp_env_for_k2_cli_component(cls):
-        env = {"KPHP_MODE": "k2-cli", "KPHP_ENABLE_FULL_PERFORMANCE_ANALYZE": "0",
+    def kphp_env_for_k2_common(cls):
+        env = {"KPHP_ENABLE_FULL_PERFORMANCE_ANALYZE": "0",
                "KPHP_PROFILER": "0", "KPHP_USER_BINARY_PATH": "component.so", "KPHP_FORCE_LINK_RUNTIME": "1"}
         return env
 
+    @classmethod
+    def kphp_env_for_k2_cli_component(cls):
+        env = cls.kphp_env_for_k2_common()
+        env["KPHP_MODE"] = "k2-cli"
+        return env
+
+    @classmethod
+    def kphp_env_for_k2_lib(cls):
+        env = cls.kphp_env_for_k2_common()
+        env["KPHP_MODE"] = "k2-lib"
+        return env
+
+
     def make_kphp_once_runner(self, php_script_path):
         once_runner = KphpRunOnce(
             php_script_path=os.path.join(self.test_dir, php_script_path),
diff --git a/tests/python/tests/libs/test_libs.py b/tests/python/tests/libs/test_libs.py
@@ -10,16 +10,21 @@ class TestLibs(KphpCompilerAutoTestCase):
     def test_raw_php_libs(self):
         self.build_and_compare_with_php("php/lib_user.php")
 
-    @pytest.mark.k2_skip
     def test_compiled_libs(self):
+        lib_build_env = {
+            "KPHP_MODE": "lib",
+            "KPHP_DYNAMIC_INCREMENTAL_LINKAGE": "0",
+        }
+        
+        if self.should_use_k2():
+            lib_build_env.update(self.kphp_env_for_k2_lib())
+        
         for lib_name in ("example1", "example2"):
             lib_out_dir = os.path.join(self.web_server_working_dir, "lib_examples/{}/lib".format(lib_name))
+            lib_build_env.update({"KPHP_OUT_LIB_DIR": lib_out_dir})
             lib_builder = self.make_kphp_once_runner("php/lib_examples/{}".format(lib_name))
-            self.assertTrue(lib_builder.compile_with_kphp({
-                "KPHP_MODE": "lib",
-                "KPHP_DYNAMIC_INCREMENTAL_LINKAGE": "0",
-                "KPHP_OUT_LIB_DIR": lib_out_dir
-            }), "Got {} KPHP build error".format(lib_name))
+            self.assertTrue(lib_builder.compile_with_kphp(lib_build_env),
+                            "Got {} KPHP build error".format(lib_name))
 
         kphp_runner = self.build_and_compare_with_php("php/lib_user.php", kphp_env={
             "KPHP_INCLUDE_DIR": self.web_server_working_dir,

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ void ConstVarsInit::compile_const_init_part(CodeGenerator &W, const ConstantsBat`
`59`	`59`	`IncludesCollector includes;`
`60`	`60`	`ConstantsExternCollector c_mem_extern;`
`61`	`61`	`for (VarPtr var : batch.constants) {`
`62`		`- if (!G->is_output_mode_lib()) {`
	`62`	`+ if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {`
`63`	`63`	`includes.add_var_signature_depends(var);`
`64`	`64`	`includes.add_vertex_depends(var->init_val);`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,8 @@ void CompilerCore::register_settings(CompilerSettings *settings) {`
`139`	`139`	`output_mode = OutputMode::k2_oneshot;`
`140`	`140`	`} else if (mode == "k2-multishot") {`
`141`	`141`	`output_mode = OutputMode::k2_multishot;`
	`142`	`+ } else if (mode == "k2-lib") {`
	`143`	`+ output_mode = OutputMode::k2_lib;`
`142`	`144`	`} else {`
`143`	`145`	`output_mode = OutputMode::server;`
`144`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ enum class OutputMode {`
`28`	`28`	`server, // -M server`
`29`	`29`	`cli, // -M cli`
`30`	`30`	`lib, // -M lib`
	`31`	`+ k2_lib, // -M k2-lib`
`31`	`32`	`k2_cli, // -M k2-cli`
`32`	`33`	`k2_server, // -M k2-server`
`33`	`34`	`k2_oneshot, // -M k2-oneshot`
`@@ -202,6 +203,10 @@ class CompilerCore {`
`202`	`203`	`return output_mode == OutputMode::lib;`
`203`	`204`	`}`
`204`	`205`
	`206`	`+ bool is_output_mode_k2_lib() const {`
	`207`	`+ return output_mode == OutputMode::k2_lib;`
	`208`	`+ }`
	`209`	`+`
`205`	`210`	`bool is_output_mode_k2_cli() const {`
`206`	`211`	`return output_mode == OutputMode::k2_cli;`
`207`	`212`	`}`
`@@ -219,7 +224,7 @@ class CompilerCore {`
`219`	`224`	`}`
`220`	`225`
`221`	`226`	`bool is_output_mode_k2() const {`
`222`		`- return is_output_mode_k2_cli() \|\| is_output_mode_k2_server() \|\| is_output_mode_k2_oneshot() \|\| is_output_mode_k2_multishot();`
	`227`	`+ return is_output_mode_k2_cli() \|\| is_output_mode_k2_server() \|\| is_output_mode_k2_oneshot() \|\| is_output_mode_k2_multishot() \|\| is_output_mode_k2_lib();`
`223`	`228`	`}`
`224`	`229`
`225`	`230`	`void set_exclude_namespaces(std::vector<std::string> &&excludes) {`
Original file line number	Diff line number	Diff line change
`@@ -251,7 +251,7 @@ void CompilerSettings::init() {`
`251`	`251`	`kphp_error(is_k2_mode, "Option \"k2-component-name\" is only available for k2 component modes");`
`252`	`252`	`}`
`253`	`253`
`254`		`- if (mode.get() == "lib") {`
	`254`	`+ if (mode.get() == "lib" \|\| mode.get() == "k2-lib") {`
`255`	`255`	`if (!tl_schema_file.get().empty()) {`
`256`	`256`	`throw std::runtime_error{"Option " + tl_schema_file.get_env_var() + " is forbidden for static lib mode"};`
`257`	`257`	`}`
Original file line number	Diff line number	Diff line change
`@@ -628,7 +628,7 @@ class CalcBadVars {`
`628`	`628`	`function->dep = std::move(call_graph.graph[function]);`
`629`	`629`	`}`
`630`	`630`
`631`		`- if (!G->is_output_mode_lib()) {`
	`631`	`+ if (!G->is_output_mode_lib() && !G->is_output_mode_k2_lib()) {`
`632`	`632`	`return;`
`633`	`633`	`}`
`634`	`634`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ void CalcEmptyFunctions::execute(FunctionPtr f, DataStream<FunctionPtr> &os) {`
`90`	`90`	`stage::set_function(f);`
`91`	`91`	`f->body_seq = calc_function_body_type(f);`
`92`	`92`
`93`		`- if (f->is_main_function() && G->is_output_mode_lib() && G->get_main_file()->main_function == f) {`
	`93`	`+ if (f->is_main_function() && (G->is_output_mode_lib() \|\| G->is_output_mode_k2_lib()) && G->get_main_file()->main_function == f) {`
`94`	`94`	`kphp_error(f->body_seq == FunctionData::body_value::empty, "main php file of a lib mustn't contain code, only declarations");`
`95`	`95`	`}`
`96`	`96`