Add loglevels to aiebu #178

donwalkarsoham · 2025-11-25T15:50:37Z

Problem solved by the commit

aiebu-asm was printing information to console output while assembling. This could reduce aiebu-asm performance.

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

N/A

How problem was solved, alternative solutions (if any) and why they were rejected

1> Added a verbose flag to aiebu-asm utility to enable verbose logs on cout.
2> To further enhance logging, added log levels for logging, enabled by aiebu-asm flags. "warn" is the default level.
Added --log-level option to both aie4 and config targets:
("log-level", "log level: error, warn, info, debug (default: warn)"

The flag accepts 4 values:

error - Only errors
warn - Errors and warnings (default)
info - Errors, warnings, and info messages
debug - All messages (same as -f verbose)

Below are Log levels and its contents.

Levels	     Contents
---------------------------------------------------------------
error        LOG_ERROR only
warn         (default) LOG_ERROR, LOG_WARN
info	     LOG_ERROR, LOG_WARN, LOG_INFO
debug	     LOG_ERROR, LOG_WARN, LOG_INFO, LOG_DEBUG

Example Usage -

# Default: show errors and warnings
aiebu-asm -c input.asm -o output.elf

# Only show errors
aiebu-asm -c input.asm -o output.elf --log-level error

# Show errors, warnings, and info (verbose output)
aiebu-asm -c input.asm -o output.elf --log-level info

# Show everything (debug mode)
aiebu-asm -c input.asm -o output.elf --log-level debug

# Alternative: -f verbose still works (sets to debug)
aiebu-asm -c input.asm -o output.elf -f verbose

Risks (if any) associated the changes in the commit

N/A

What has been tested and how, request additional testing if necessary

1> Tested on Windows aiebu-asm utility

Documentation impact (if any)

N/A

Signed-off-by: Donwalkar <[email protected]>

github-actions

clang-tidy made some suggestions

github-actions · 2025-11-25T16:03:24Z

src/cpp/common/logger.h

+};
+
+// Global log level (default: errors and warnings)
+inline log_level g_log_level = log_level::warn;


warning: variable 'g_log_level' is non-const and globally accessible, consider making it const [cppcoreguidelines-avoid-non-const-global-variables]

inline log_level g_log_level = log_level::warn; ^

github-actions · 2025-11-25T16:03:24Z

src/cpp/common/logger.h

+} // namespace aiebu
+
+// Logging macros
+#define LOG_ERROR(msg) \


warning: function-like macro 'LOG_ERROR' used; consider a 'constexpr' template function [cppcoreguidelines-macro-usage]

#define LOG_ERROR(msg) \ ^

github-actions · 2025-11-25T16:03:24Z

src/cpp/common/logger.h

+// Logging macros
+#define LOG_ERROR(msg) \
+  do { \
+    std::cerr << "[ERROR] " << msg << std::endl; \


warning: macro argument should be enclosed in parentheses [bugprone-macro-parentheses]

Suggested change

std::cerr << "[ERROR] " << msg << std::endl; \

std::cerr << "[ERROR] " << (msg) << std::endl; \

github-actions · 2025-11-25T16:03:24Z

src/cpp/common/logger.h

+    std::cerr << "[ERROR] " << msg << std::endl; \
+  } while (0)
+
+#define LOG_WARN(msg) \


warning: function-like macro 'LOG_WARN' used; consider a 'constexpr' template function [cppcoreguidelines-macro-usage]

#define LOG_WARN(msg) \ ^

github-actions · 2025-11-25T16:03:24Z

src/cpp/common/logger.h

+#define LOG_WARN(msg) \
+  do { \
+    if (aiebu::g_log_level >= aiebu::log_level::warn) { \
+      std::cout << "[WARN] " << msg << std::endl; \


warning: macro argument should be enclosed in parentheses [bugprone-macro-parentheses]

Suggested change

std::cout << "[WARN] " << msg << std::endl; \

std::cout << "[WARN] " << (msg) << std::endl; \

github-actions · 2025-11-25T16:03:26Z

src/cpp/preprocessor/asm/asm_parser.cpp

      m_parserptr->set_nummem(to_uinteger<uint32_t>(match[3]));
-      std::cout << "Core count: " << match[1] << std::endl;
-      std::cout << "Memory size: " << match[3] << std::endl;
+      LOG_INFO("Core count: " << match[1]);


warning: avoid do-while loops [cppcoreguidelines-avoid-do-while]

LOG_INFO("Core count: " << match[1]); ^

Additional context

src/cpp/common/logger.h:58: expanded from macro 'LOG_INFO'

do { \ ^

github-actions · 2025-11-25T16:03:26Z

src/cpp/preprocessor/asm/asm_parser.cpp

-      std::cout << "Core count: " << match[1] << std::endl;
-      std::cout << "Memory size: " << match[3] << std::endl;
+      LOG_INFO("Core count: " << match[1]);
+      LOG_INFO("Memory size: " << match[3]);


warning: avoid do-while loops [cppcoreguidelines-avoid-do-while]

LOG_INFO("Memory size: " << match[3]); ^

Additional context

src/cpp/common/logger.h:58: expanded from macro 'LOG_INFO'

do { \ ^

github-actions · 2025-11-25T16:03:26Z

src/cpp/preprocessor/asm/asm_parser.cpp

    return false;
  }
-//  std::cout << "Reading file:" << filename << std::endl;
+  LOG_INFO("Reading file:" << filename);


warning: avoid do-while loops [cppcoreguidelines-avoid-do-while]

LOG_INFO("Reading file:" << filename); ^

Additional context

src/cpp/common/logger.h:58: expanded from macro 'LOG_INFO'

do { \ ^

github-actions · 2025-11-25T16:03:26Z

src/cpp/preprocessor/asm/asm_parser.cpp

  }

-//  std::cout << "Reading file:" << filename << std::endl;
+  LOG_INFO("Reading file:" << filename);


warning: avoid do-while loops [cppcoreguidelines-avoid-do-while]

LOG_INFO("Reading file:" << filename); ^

Additional context

src/cpp/common/logger.h:58: expanded from macro 'LOG_INFO'

do { \ ^

github-actions · 2025-11-25T16:03:26Z

src/cpp/utils/target/target.h

  {
    auto e = as.get_elf();
-    std::cout << "elf size:" << e.size() << "\n";
+    LOG_INFO("elf size:" << e.size());


warning: avoid do-while loops [cppcoreguidelines-avoid-do-while]

LOG_INFO("elf size:" << e.size()); ^

Additional context

src/cpp/common/logger.h:58: expanded from macro 'LOG_INFO'

do { \ ^

Copilot

Pull request overview

This PR adds a structured logging system to the aiebu-asm utility to improve performance by reducing unnecessary console output. The implementation introduces four log levels (error, warn, info, debug) with warn as the default, replacing direct std::cout calls with appropriate logging macros throughout the codebase.

Key changes:

Created a new logging framework with configurable log levels (error, warn, info, debug)
Added --log-level CLI option to both aie4 and config targets
Replaced console output statements with appropriate LOG_* macros based on message severity

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/cpp/common/logger.h	New header defining log levels, global log level management, and logging macros
src/cpp/utils/target/target.cpp	Added log-level option parsing and validation for both aie4 and config targets
src/cpp/utils/target/target.h	Replaced std::cout with LOG_INFO for ELF size output
src/cpp/preprocessor/asm/asm_parser.cpp	Converted std::cout statements to appropriate LOG_INFO and LOG_WARN calls
src/cpp/preprocessor/aie2ps/aie2ps_preprocessor.h	Refactored flag processing to enable verbose logging before parsing
src/cpp/preprocessor/aie2/aie2_blob_preprocessor_input.h	Added verbose flag handling for blob preprocessor
src/cpp/encoder/aie2ps/aie2ps_encoder.cpp	Conditionalized report summary output based on log level
src/cpp/elf/elfwriter.cpp	Replaced std::cout with LOG_INFO for UID output

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-25T17:17:59Z

src/cpp/utils/target/target.cpp

+    if (result.count("log-level")) {
+      log_level_str = result["log-level"].as<decltype(log_level_str)>();
+      if (log_level_str == "error")
+        aiebu::set_log_level(aiebu::log_level::error);
+      else if (log_level_str == "warn")
+        aiebu::set_log_level(aiebu::log_level::warn);
+      else if (log_level_str == "info")
+        aiebu::set_log_level(aiebu::log_level::info);
+      else if (log_level_str == "debug")
+        aiebu::set_log_level(aiebu::log_level::debug);
+      else {
+        auto errMsg = boost::format("Invalid log level: %s. Valid options: error, warn, info, debug\n") % log_level_str;
+        throw std::runtime_error(errMsg.str());
+      }
+    }


The log level validation logic is duplicated in both the aie4 target (lines 385-399) and config target (lines 475-489). Consider extracting this validation into a reusable helper function to reduce code duplication and improve maintainability.

Copilot · 2025-11-25T17:17:59Z

src/cpp/preprocessor/aie2ps/aie2ps_preprocessor.h

    auto flags = tinput->get_flags();
+    uint32_t optimize = 0;
+    asm_dump_flag debug_flag = asm_dump_flag::text;
    for (const auto& flag: flags)
    {
      if (flag == disable_dump_map)
-        toutput->set_debug(asm_dump_flag::disable);
+        debug_flag = asm_dump_flag::disable;
      else if (flag == full_dump_map)
-        toutput->set_debug(asm_dump_flag::full);
+        debug_flag = asm_dump_flag::full;
+      else if (flag == verbose_asm)
+        enable_verbose_logging();
      else if (flag.find(prefix) == 0)
        optimize = std::stoi(flag.substr(prefix.size()));
      else
        std::cout << "Invalid flag: " << flag << ", ignored !!!" << std::endl;
    }


The error message for invalid flags (line 65) should use LOG_WARN instead of std::cout for consistency with the new logging system.

Copilot · 2025-11-25T17:18:00Z

src/cpp/preprocessor/aie2/aie2_blob_preprocessor_input.h

+      else if (lib == "verbose")
+        enable_verbose_logging();
      else
        std::cout << "Invalid flag: " << lib << ", ignored !!!" << std::endl;


The error message for invalid flags should use LOG_WARN instead of std::cout for consistency with the new logging system.

Suggested change

std::cout << "Invalid flag: " << lib << ", ignored !!!" << std::endl;

LOG_WARN("Invalid flag: %s, ignored !!!", lib.c_str());

HimanshuChoudhary-Xilinx · 2025-11-26T17:09:51Z

src/cpp/utils/target/target.cpp

            ("asm,c", "ASM File", cxxopts::value<decltype(input_file)>())
            ("j,json", "control packet Patching json file", cxxopts::value<decltype(external_buffers_file)>())
            ("L,libpath", "libs path", cxxopts::value<decltype(libpaths)>())
            ("f,flag", "flags", cxxopts::value<decltype(flags)>())


missed adding for aie2ps, flag & log_level

HimanshuChoudhary-Xilinx · 2025-11-26T17:11:31Z

src/cpp/utils/target/target.cpp

            ("c,controlcode", "TXN control code binary or ASM file", cxxopts::value<decltype(m_transaction_file)>())
            ("p,controlpkt", "Control packet binary", cxxopts::value<decltype(m_controlpkt_file)>())
            ("j,json", "control packet Patching json file", cxxopts::value<decltype(m_external_buffers_file)>())
            ("l,lib", "linked libs", cxxopts::value<decltype(m_libs)>())


missed adding log_level here

HimanshuChoudhary-Xilinx · 2025-11-26T17:12:27Z

src/cpp/utils/target/target.cpp

  try {
    all_options.add_options()
            ("o,outputelf", "ELF output file name", cxxopts::value<decltype(output_elffile)>())
            ("j,json", "control packet Patching json file", cxxopts::value<decltype(json_file)>())


missed adding log_level here

HimanshuChoudhary-Xilinx · 2025-11-26T17:15:33Z

src/cpp/utils/target/target.cpp

            ("o,outputelf", "ELF output file name", cxxopts::value<decltype(output_elffile)>())
            ("j,json", "control packet Patching json file", cxxopts::value<decltype(json_file)>())
-            ("f,flag", "flags", cxxopts::value<decltype(flags)>())
+            ("f,flag", "flags (e.g., 'verbose' for detailed output, 'disabledump', 'fulldump')", cxxopts::value<decltype(flags)>())


we dont need verbose here, we can merge verbose functionality with fulldump for aie2ps/aie4/aie2ps_config/aie4_config

HimanshuChoudhary-Xilinx · 2025-11-26T17:18:29Z

src/cpp/preprocessor/aie2ps/aie2ps_preprocessor.h

+        debug_flag = asm_dump_flag::disable;
      else if (flag == full_dump_map)
-        toutput->set_debug(asm_dump_flag::full);
+        debug_flag = asm_dump_flag::full;


we dont need verbose.

if (flag == disable_dump_map) debug_flag = asm_dump_flag::disable; else if (flag == full_dump_map) { debug_flag = asm_dump_flag::full; enable_verbose_logging(); }

HimanshuChoudhary-Xilinx · 2025-11-26T17:24:10Z

src/cpp/preprocessor/aie2/aie2_blob_preprocessor_input.h

    {
      if (lib == legacydpuxclbin)
        arg_offset = 1;
+      else if (lib == "verbose")


how you are passing this flag from aiebu-asm, that code is missing

HimanshuChoudhary-Xilinx · 2025-11-26T17:24:58Z

src/cpp/utils/target/target.cpp

+    if (result.count("log-level")) {
+      log_level_str = result["log-level"].as<decltype(log_level_str)>();
+      if (log_level_str == "error")
+        aiebu::set_log_level(aiebu::log_level::error);


how you will set log_level when user is calling lib apis?

HimanshuChoudhary-Xilinx · 2025-11-26T17:26:07Z

src/cpp/utils/target/target.cpp

+    if (result.count("log-level")) {
+      log_level_str = result["log-level"].as<decltype(log_level_str)>();
+      if (log_level_str == "error")
+        aiebu::set_log_level(aiebu::log_level::error);


Signed-off-by: Soham Donwalkar <[email protected]>

Add loglevels to aiebu, set at runtime

4d68ddc

Signed-off-by: Donwalkar <[email protected]>

donwalkarsoham mentioned this pull request Nov 25, 2025

"Do Not Review" Add loglevels to aiebu #177

Closed

github-actions bot reviewed Nov 25, 2025

View reviewed changes

HimanshuChoudhary-Xilinx requested a review from Copilot November 25, 2025 17:17

Copilot AI reviewed Nov 25, 2025

View reviewed changes

HimanshuChoudhary-Xilinx reviewed Nov 26, 2025

View reviewed changes

Merge branch 'main-ge' into verbose

f11b58c

Signed-off-by: Soham Donwalkar <[email protected]>

	std::cerr << "[ERROR] " << msg << std::endl; \
	std::cerr << "[ERROR] " << (msg) << std::endl; \

	std::cout << "[WARN] " << msg << std::endl; \
	std::cout << "[WARN] " << (msg) << std::endl; \

	std::cout << "Invalid flag: " << lib << ", ignored !!!" << std::endl;
	LOG_WARN("Invalid flag: %s, ignored !!!", lib.c_str());

Add loglevels to aiebu #178

Are you sure you want to change the base?

Add loglevels to aiebu #178

Uh oh!

Conversation

donwalkarsoham commented Nov 25, 2025

Problem solved by the commit

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

How problem was solved, alternative solutions (if any) and why they were rejected

Risks (if any) associated the changes in the commit

What has been tested and how, request additional testing if necessary

Documentation impact (if any)

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects