Convert stmt_html output to use stmt_viz output (halide#7516)

* Allow emitting `stmt_viz` without specifying `assembly`

TL;DR: if we request `stmt_viz` without `assembly`, just generate the latter to a temp file that we dispose of later; this wasn't feasible before since we were previously requiring the assembly output to be generated with the same directory and basename as stmt_viz, but that was fixed.

* Convert stmt_html output to use stmt_viz output

Per discussion on halide#7507, this entirely removes the "classic" stmt_html output and replaces it with the "new" StmtToViz output. Using `compile_to_lowered_stmt` or requesting `stmt_html` will now always output the new output, and requesting `stmt_viz` output is no longer legal.

(Note that this builds on top of halide#7515, which must be submitted first.)

It's not clear to me whether halide#7507 (comment) is a blocker for this change, or a request to add back already-lost functionality.

* Update Makefile

* Update Generator.cpp

Makefile

@@ -560,7 +560,6 @@ SOURCE_FILES = \
   SpirvIR.cpp \
   SplitTuples.cpp \
   StageStridedLoads.cpp \
-  StmtToHtml.cpp \
   StmtToViz.cpp \
   StorageFlattening.cpp \
   StorageFolding.cpp \
@@ -739,7 +738,6 @@ HEADER_FILES = \
   Solve.h \
   SplitTuples.h \
   StageStridedLoads.h \
-  StmtToHtml.h \
   StmtToViz.h \
   StorageFlattening.h \
   StorageFolding.h \

python_bindings/test/correctness/compile_to.py

@@ -43,7 +43,7 @@ def main():
         else:
             assert os.path.isfile(os.path.join(tmpdir, "f_all.o"))
 
-        p = os.path.join(tmpdir, "f.html")
+        p = os.path.join(tmpdir, "f.stmt.html")
         f.compile_to({hl.OutputFileType.stmt_html: p}, args, "f")
         assert os.path.isfile(p)
 

python_bindings/tutorial/lesson_03_debugging_1.py

@@ -41,20 +41,15 @@ def main():
     # of compilation, and also the llvm bitcode we generate at the
     # end.
 
-    # If you'd prefer to read C code, the compile_to_c method emits C
-    # code that implements the Halide pipeline. It can't compile
-    # as-is without you also implementing some support functions, but
-    # it can be helpful for understanding what the Halide pipeline is
-    # doing. You pass it the name of the file, a list of arguments
-    # the generated function should take (none in this case), and the
-    # name of the generated function. Have a look inside gradient.cpp
-    # after compiling and running this lesson.
-    gradient.compile_to_c("gradient.cpp", [], "gradient")
-
-    # Using these two tricks -- setting HL_DEBUG_CODEGEN and calling
-    # compile_to_c -- you can usually figure out what code Halide is
-    # generating. In the next lesson we'll see how to snoop on Halide
-    # at runtime.
+    # Halide will also output an HTML version of this output, which
+    # supports syntax highlighting and code-folding, so it can be
+    # nicer to read for large pipelines. Open gradient.stmt.html" with your
+    # browser after running this tutorial.
+    gradient.compile_to_lowered_stmt("gradient.stmt.html", [], hl.StmtOutputFormat.HTML)
+
+    # You can usually figure out what code Halide is generating using
+    # this pseudocode. In the next lesson we'll see how to snoop on
+    # Halide at runtime.
 
     print("Success!")
     return 0

src/CMakeLists.txt

@@ -148,7 +148,6 @@ set(HEADER_FILES
     Solve.h
     SplitTuples.h
     StageStridedLoads.h
-    StmtToHtml.h
     StmtToViz.h
     StorageFlattening.h
     StorageFolding.h
@@ -329,7 +328,6 @@ set(SOURCE_FILES
     SpirvIR.cpp
     SplitTuples.cpp
     StageStridedLoads.cpp
-    StmtToHtml.cpp
     StmtToViz.cpp
     StorageFlattening.cpp
     StorageFolding.cpp

src/Generator.cpp

@@ -651,7 +651,7 @@ gengen
  -e  A comma separated list of files to emit. Accepted values are:
      [assembly, bitcode, c_header, c_source, cpp_stub, featurization,
       llvm_assembly, object, python_extension, pytorch_wrapper, registration,
-      schedule, static_library, stmt, stmt_html, stmt_viz, compiler_log].
+      schedule, static_library, stmt, stmt_html, compiler_log].
      If omitted, default value is [c_header, static_library, registration].
 
  -p  A comma-separated list of shared libraries that will be loaded before the
@@ -790,13 +790,6 @@ gengen
             output_types.insert(OutputFileType::registration);
             output_types.insert(OutputFileType::static_library);
         } else {
-            // if emit_flags contains "stmt_viz" but not "assembly", throw an error
-            bool has_stmt_viz = std::find(emit_flags.begin(), emit_flags.end(), "stmt_viz") != emit_flags.end();
-            bool has_assembly = std::find(emit_flags.begin(), emit_flags.end(), "assembly") != emit_flags.end();
-
-            user_assert(!has_stmt_viz || has_assembly)
-                << "Output flag `stmt_viz` requires the `assembly` flag to also be set.";
-
             // Build a reverse lookup table. Allow some legacy aliases on the command line,
             // to allow legacy build systems to work more easily.
             std::map<std::string, OutputFileType> output_name_to_enum = {

src/Module.cpp

@@ -18,7 +18,6 @@
 #include "LLVM_Runtime_Linker.h"
 #include "Pipeline.h"
 #include "PythonExtensionGen.h"
-#include "StmtToHtml.h"
 #include "StmtToViz.h"
 
 namespace Halide {
@@ -50,7 +49,6 @@ std::map<OutputFileType, const OutputInfo> get_output_info(const Target &target)
         {OutputFileType::static_library, {"static_library", is_windows_coff ? ".lib" : ".a", IsSingle}},
         {OutputFileType::stmt, {"stmt", ".stmt", IsMulti}},
         {OutputFileType::stmt_html, {"stmt_html", ".stmt.html", IsMulti}},
-        {OutputFileType::stmt_viz, {"stmt_viz", ".stmt.viz.html", IsMulti}},
     };
     return ext;
 }
@@ -523,18 +521,14 @@ MetadataNameMap Module::get_metadata_name_map() const {
 void Module::compile(const std::map<OutputFileType, std::string> &output_files) const {
     validate_outputs(output_files);
 
-    // output stmt and html prior to resolving submodules. We need to
+    // output stmt prior to resolving submodules. We need to
     // clear the output after writing it, otherwise the output will
     // be overwritten by recursive calls after submodules are resolved.
     if (contains(output_files, OutputFileType::stmt)) {
         debug(1) << "Module.compile(): stmt " << output_files.at(OutputFileType::stmt) << "\n";
         std::ofstream file(output_files.at(OutputFileType::stmt));
         file << *this;
     }
-    if (contains(output_files, OutputFileType::stmt_html)) {
-        debug(1) << "Module.compile(): stmt_html " << output_files.at(OutputFileType::stmt_html) << "\n";
-        Internal::print_to_html(output_files.at(OutputFileType::stmt_html), *this);
-    }
 
     // Minor but worthwhile optimization: if all of the output files are of types that won't
     // ever rely on submodules (e.g.: toplevel declarations in C/C++), don't bother resolving
@@ -553,7 +547,6 @@ void Module::compile(const std::map<OutputFileType, std::string> &output_files)
         std::map<OutputFileType, std::string> output_files_copy = output_files;
         output_files_copy.erase(OutputFileType::stmt);
         output_files_copy.erase(OutputFileType::stmt_html);
-        output_files_copy.erase(OutputFileType::stmt_viz);
         resolve_submodules().compile(output_files_copy);
         return;
     }
@@ -630,9 +623,10 @@ void Module::compile(const std::map<OutputFileType, std::string> &output_files)
         }
     }
 
-    if (contains(output_files, OutputFileType::stmt_viz)) {
-        debug(1) << "Module.compile(): stmt_viz " << output_files.at(OutputFileType::stmt_viz) << "\n";
-        Internal::print_to_viz(output_files.at(OutputFileType::stmt_viz), *this, assembly_path);
+    if (contains(output_files, OutputFileType::stmt_html)) {
+        internal_assert(!assembly_path.empty());
+        debug(1) << "Module.compile(): stmt_html " << output_files.at(OutputFileType::stmt_html) << "\n";
+        Internal::print_to_viz(output_files.at(OutputFileType::stmt_html), *this, assembly_path);
     }
     if (contains(output_files, OutputFileType::function_info_header)) {
         debug(1) << "Module.compile(): function_info_header " << output_files.at(OutputFileType::function_info_header) << "\n";

src/Module.h

@@ -41,7 +41,6 @@ enum class OutputFileType {
     static_library,
     stmt,
     stmt_html,
-    stmt_viz,
 };
 
 /** Type of linkage a function in a lowered Halide module can have.