Add ETPRIsize_t support to ExecuTorch for Xtensa (pytorch#7895)

Summary:

topic: not user facing

Our Xtensa G3's toolchain, which is as recent as RJ-2024.3 release doesn't have %zu format specifier support. Since we only have the precompiled libc.a provided from cadence -- it seems from the disassembly that only the following are supported

%c: character
%s: string
%d: decimal integer
%i: decimal integer (same as %d)
%u: unsigned decimal integer
%x: hexadecimal integer
%X: uppercase hexadecimal integer
%p: pointer

which is consistent with what I've seen come-out from ET_LOG prints that pass through the vsnprintf specifier

Haven't heard of a 64-bit Xtensa DSP, so I think this 'lu' specifier mapping should work for all Xtensa toolchains regardless of vsnprintf implementation.

This diff also updates a couple of places where I most commonly see the mishandled %zu specifier. If the changes are okay, I can more widely update print statements in ExecuTorch. It would touch a lot of files, some of which would never be compiled for Xtensa.

Differential Revision: D68131252

Author: cmt0

runtime/core/hierarchical_allocator.h

@@ -62,14 +62,15 @@ class HierarchicalAllocator final {
     ET_CHECK_OR_RETURN_ERROR(
         memory_id < buffers_.size(),
         InvalidArgument,
-        "id %" PRIu32 " >= %zu",
+        "id %" PRIu32 " >= %" ET_PRIsize_t,
         memory_id,
         buffers_.size());
     Span<uint8_t> buffer = buffers_[memory_id];
     ET_CHECK_OR_RETURN_ERROR(
         offset_bytes + size_bytes <= buffer.size(),
         MemoryAllocationFailed,
-        "offset_bytes (%zu) + size_bytes (%zu) >= allocator size (%zu) "
+        "offset_bytes (%" ET_PRIsize_t ") + size_bytes (%" ET_PRIsize_t
+        ") >= allocator size (%" ET_PRIsize_t
         "for memory_id %" PRIu32,
         offset_bytes,
         size_bytes,

runtime/executor/method.cpp

@@ -24,6 +24,7 @@
 #include <executorch/runtime/kernel/kernel_runtime_context.h>
 #include <executorch/runtime/kernel/operator_registry.h>
 #include <executorch/runtime/platform/assert.h>
+#include <executorch/runtime/platform/compiler.h>
 #include <executorch/runtime/platform/log.h>
 #include <executorch/runtime/platform/profiler.h>
 #include <executorch/schema/program_generated.h>
@@ -238,7 +239,7 @@ Result<InstructionArgs> gen_instruction_arguments(
     ET_CHECK_OR_RETURN_ERROR(
         arg_idx < num_values,
         InvalidProgram,
-        "Arg index %d >= %zu",
+        "Arg index %d >= %" ET_PRIsize_t,
         arg_idx,
         num_values);
     arg_list[i] = &values[arg_idx];
@@ -311,7 +312,7 @@ Error Method::parse_values() {
                  executorch_flatbuffer::KernelTypes::Null ||
              serialization_value->val() != nullptr),
         InvalidProgram,
-        "Null value at index %zu",
+        "Null value at index %" ET_PRIsize_t,
         i);
 
     const auto val = serialization_value->val();
@@ -340,7 +341,7 @@ Error Method::parse_values() {
         const auto items =
             static_cast<const executorch_flatbuffer::IntList*>(val)->items();
         ET_CHECK_OR_RETURN_ERROR(
-            items != nullptr, InvalidProgram, "Missing list at index %zu", i);
+            items != nullptr, InvalidProgram, "Missing list at index %" ET_PRIsize_t, i);
         // Allocate space for boxed and unboxed list representations using
         // values_ as source of truth
         auto* evalp_list =
@@ -356,7 +357,7 @@ Error Method::parse_values() {
           ET_CHECK_OR_RETURN_ERROR(
               value_index >= 0 && value_index < n_value,
               InvalidProgram,
-              "Invalid value index %" PRId64 " for IntList %zu index %zu",
+              "Invalid value index %" PRId64 " for IntList %" ET_PRIsize_t " index %" ET_PRIsize_t,
               value_index,
               i,
               j);
@@ -369,7 +370,7 @@ Error Method::parse_values() {
         const auto items =
             static_cast<const executorch_flatbuffer::BoolList*>(val)->items();
         ET_CHECK_OR_RETURN_ERROR(
-            items != nullptr, InvalidProgram, "Missing list at index %zu", i);
+            items != nullptr, InvalidProgram, "Missing list at index %" ET_PRIsize_t, i);
         // NOTE: This is technically not portable. A platform could technically
         // define boolean as something longer than a byte. This would be an
         // exceptionally rare case, and this type is currently unused in any
@@ -384,7 +385,7 @@ Error Method::parse_values() {
         const auto items =
             static_cast<const executorch_flatbuffer::DoubleList*>(val)->items();
         ET_CHECK_OR_RETURN_ERROR(
-            items != nullptr, InvalidProgram, "Missing list at index %zu", i);
+            items != nullptr, InvalidProgram, "Missing list at index %" ET_PRIsize_t, i);
         new (&values_[i])
             EValue(exec_aten::ArrayRef<double>(items->data(), items->size()));
       } break;
@@ -395,7 +396,7 @@ Error Method::parse_values() {
         ET_CHECK_OR_RETURN_ERROR(
             fb_str != nullptr,
             InvalidProgram,
-            "Missing string at index %zu",
+            "Missing string at index %" ET_PRIsize_t,
             i);
         new (&values_[i]) EValue(fb_str->c_str(), fb_str->size());
       } break;
@@ -407,7 +408,7 @@ Error Method::parse_values() {
         if (!t.ok()) {
           ET_LOG(
               Error,
-              "Failed parsing tensor at index %zu: 0x%" PRIx32,
+              "Failed parsing tensor at index %" ET_PRIsize_t ": 0x%" PRIx32,
               i,
               static_cast<uint32_t>(t.error()));
           return t.error();
@@ -429,7 +430,7 @@ Error Method::parse_values() {
         if (!tensors.ok()) {
           ET_LOG(
               Error,
-              "Failed parsing tensor list at index %zu: 0x%" PRIx32,
+              "Failed parsing tensor list at index %" ET_PRIsize_t ": 0x%" PRIx32,
               i,
               static_cast<uint32_t>(tensors.error()));
           return tensors.error();
@@ -452,7 +453,7 @@ Error Method::parse_values() {
         if (!tensors.ok()) {
           ET_LOG(
               Error,
-              "Failed parsing optional tensor list at index %zu: 0x%" PRIx32,
+              "Failed parsing optional tensor list at index %" ET_PRIsize_t ": 0x%" PRIx32,
               i,
               static_cast<uint32_t>(tensors.error()));
           return tensors.error();
@@ -467,7 +468,7 @@ Error Method::parse_values() {
         // schema.fbs
         ET_LOG(
             Error,
-            "Unknown KernelTypes value %" PRIu32 " at index %zu",
+            "Unknown KernelTypes value %" PRIu32 " at index %" ET_PRIsize_t,
             static_cast<uint32_t>(serialization_value->val_type()) - 1,
             i);
         return Error::InvalidProgram;
@@ -509,7 +510,7 @@ Error populate_operator_name(
       cx < operator_name_size,
       Internal,
       "Operator name %s%s%s with length %d "
-      "truncated to %zu due to internal buffer limit.",
+      "truncated to %" ET_PRIsize_t " due to internal buffer limit.",
       op->name()->c_str(),
       has_overload ? "." : "",
       has_overload ? op->overload()->c_str() : "",
@@ -569,7 +570,7 @@ Error Method::resolve_operator(
       ET_CHECK_OR_RETURN_ERROR(
           err == Error::Ok,
           InvalidArgument,
-          "Error setting dim_order %zu: 0x%" PRIx32,
+          "Error setting dim_order %" ET_PRIsize_t ": 0x%" PRIx32,
           i,
           static_cast<uint32_t>(err));
       meta[count].dim_order_ =
@@ -694,7 +695,7 @@ Error Method::init(executorch_flatbuffer::ExecutionPlan* s_plan) {
       ET_CHECK_OR_RETURN_ERROR(
           s_instructions != nullptr,
           InvalidProgram,
-          "Missing instructions in chain %zu",
+          "Missing instructions in chain %" ET_PRIsize_t,
           i);
       auto num_instructions = s_instructions->size();
       auto chain_instruction_kernels =
@@ -717,7 +718,7 @@ Error Method::init(executorch_flatbuffer::ExecutionPlan* s_plan) {
         ET_CHECK_OR_RETURN_ERROR(
             instruction != nullptr && instruction->instr_args() != nullptr,
             InvalidProgram,
-            "Null instruction at index %zu",
+            "Null instruction at index %" ET_PRIsize_t,
             instr_idx);
 
         const void* instr_args = instruction->instr_args();
@@ -783,7 +784,7 @@ Error Method::init(executorch_flatbuffer::ExecutionPlan* s_plan) {
             ET_CHECK_OR_RETURN_ERROR(
                 index >= 0 && index < n_value_,
                 InvalidProgram,
-                "Index %d negative or >= %zu",
+                "Index %d negative or >= %" ET_PRIsize_t,
                 index,
                 n_value_);
             chain_instruction_arg_lists[instr_idx] = InstructionArgs();
@@ -831,7 +832,7 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
   ET_CHECK_OR_RETURN_ERROR(
       input_idx < inputs_size(),
       InvalidArgument,
-      "Input index (%zu) must be less than the number of inputs in method (%zu).",
+      "Input index (%" ET_PRIsize_t ") must be less than the number of inputs in method (%" ET_PRIsize_t ").",
       input_idx,
       inputs_size());
 
@@ -843,7 +844,7 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     tag_to_string(e.tag, tag_name.data(), tag_name.size());
     ET_LOG(
         Error,
-        "Input %zu was expected to be a Tensor or primitive but was %s.",
+        "Input %" ET_PRIsize_t " was expected to be a Tensor or primitive but was %s.",
         input_idx,
         tag_name.data());
 #endif
@@ -876,7 +877,7 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     ET_CHECK_OR_RETURN_ERROR(
         t_dst.scalar_type() == t_src.scalar_type(),
         InvalidArgument,
-        "Input %zu has unexpected scalar type: expected %s but was %s.",
+        "Input %" ET_PRIsize_t " has unexpected scalar type: expected %s but was %s.",
         input_idx,
         executorch::runtime::toString(t_dst.scalar_type()),
         executorch::runtime::toString(t_src.scalar_type()));
@@ -886,7 +887,7 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     ET_CHECK_OR_RETURN_ERROR(
         err == Error::Ok,
         InvalidArgument,
-        "Error setting input %zu: 0x%" PRIx32,
+        "Error setting input %" ET_PRIsize_t ": 0x%" PRIx32,
         input_idx,
         static_cast<uint32_t>(err));
     Error error;
@@ -899,15 +900,15 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     ET_CHECK_OR_RETURN_ERROR(
         error == Error::Ok,
         InvalidArgument,
-        "Error setting data_ptr %zu: 0x%" PRIx32,
+        "Error setting data_ptr %" ET_PRIsize_t ": 0x%" PRIx32,
         input_idx,
         static_cast<uint32_t>(error));
     // Prims have to be the same as what was traced
   } else if (e.isInt()) {
     ET_CHECK_OR_RETURN_ERROR(
         e.toInt() == input_evalue.toInt(),
         InvalidArgument,
-        "The %zu-th input of method should have the same value as the input_evalue, but got %" PRId64
+        "The %" ET_PRIsize_t "-th input of method should have the same value as the input_evalue, but got %" PRId64
         " and %" PRId64,
         input_idx,
         e.toInt(),
@@ -916,7 +917,7 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     ET_CHECK_OR_RETURN_ERROR(
         e.toBool() == input_evalue.toBool(),
         InvalidArgument,
-        "The %zu-th input of method should have the same value as the input_evalue, but got %" PRId64
+        "The %" ET_PRIsize_t "-th input of method should have the same value as the input_evalue, but got %" PRId64
         " and %" PRId64,
         input_idx,
         (int64_t)e.toBool(),
@@ -944,15 +945,15 @@ Method::set_input(const EValue& input_evalue, size_t input_idx) {
     ET_CHECK_OR_RETURN_ERROR(
         is_equal,
         InvalidArgument,
-        "The %zu-th input of method should have the same value as the input_evalue, but get %f and %f",
+        "The %" ET_PRIsize_t "-th input of method should have the same value as the input_evalue, but get %f and %f",
         input_idx,
         lhs,
         rhs);
   } else if (e.isString()) {
     ET_CHECK_OR_RETURN_ERROR(
         e.toString() == input_evalue.toString(),
         InvalidArgument,
-        "The %zu-th input of method should have the same value as the input_evalue, but get %s and %s",
+        "The %" ET_PRIsize_t "-th input of method should have the same value as the input_evalue, but get %s and %s",
         input_idx,
         e.toString().data(),
         input_evalue.toString().data());
@@ -984,7 +985,7 @@ Method::set_inputs(const exec_aten::ArrayRef<EValue>& input_evalues) {
   ET_CHECK_OR_RETURN_ERROR(
       input_size == input_evalues.size(),
       InvalidArgument,
-      "The length of given input array (%zu) must be same as the number of inputs in method (%zu).",
+      "The length of given input array (%" ET_PRIsize_t ") must be same as the number of inputs in method (%" ET_PRIsize_t ").",
       input_evalues.size(),
       input_size);
 
@@ -1009,7 +1010,7 @@ Method::set_output_data_ptr(void* buffer, size_t size, size_t output_idx) {
   ET_CHECK_OR_RETURN_ERROR(
       output_idx < outputs_size(),
       InvalidArgument,
-      "output_idx: %zu > num_outputs: %zu",
+      "output_idx: %" ET_PRIsize_t " > num_outputs: %" ET_PRIsize_t,
       output_idx,
       outputs_size());
 
@@ -1028,7 +1029,7 @@ Method::set_output_data_ptr(void* buffer, size_t size, size_t output_idx) {
   if (tensor_meta->is_memory_planned()) {
     ET_LOG(
         Error,
-        "Output %zu is memory planned, or is a constant. Cannot override "
+        "Output %" ET_PRIsize_t " is memory planned, or is a constant. Cannot override "
         "the existing data pointer.",
         output_idx);
     return Error::InvalidState;
@@ -1048,7 +1049,7 @@ Method::set_output_data_ptr(void* buffer, size_t size, size_t output_idx) {
   ET_CHECK_OR_RETURN_ERROR(
       t.nbytes() <= size,
       InvalidArgument,
-      "buffer size: %zu is smaller then expected tensor size: %zu",
+      "buffer size: %" ET_PRIsize_t " is smaller then expected tensor size: %" ET_PRIsize_t,
       size,
       t.nbytes());
 
@@ -1107,7 +1108,7 @@ Error Method::execute_instruction() {
   ET_CHECK_OR_RETURN_ERROR(
       step_state_.instr_idx < instructions->size(),
       Internal,
-      "Instr index %zu >= chain[%zu] instr count %zu",
+      "Instr index %" ET_PRIsize_t " >= chain[%" ET_PRIsize_t "] instr count %" ET_PRIsize_t,
       step_state_.instr_idx,
       step_state_.chain_idx,
       (size_t)instructions->size());
@@ -1134,7 +1135,7 @@ Error Method::execute_instruction() {
         ET_UNUSED auto op = serialization_plan_->operators()->Get(op_index);
         ET_LOG(
             Error,
-            "KernelCall failed at instruction %zu:%zu in operator %s.%s: 0x%x",
+            "KernelCall failed at instruction %" ET_PRIsize_t ":%" ET_PRIsize_t " in operator %s.%s: 0x%x",
             step_state_.chain_idx,
             step_state_.instr_idx,
             op->name()->c_str(),
@@ -1164,7 +1165,7 @@ Error Method::execute_instruction() {
           delegate_idx < n_delegate_,
           Internal,
           "DELEGATE_CALL index %" PRIu32
-          " >= num delegates %zu at instruction %zu",
+          " >= num delegates %" ET_PRIsize_t " at instruction %" ET_PRIsize_t,
           delegate_idx,
           n_delegate_,
           step_state_.instr_idx);
@@ -1178,7 +1179,7 @@ Error Method::execute_instruction() {
       if (err != Error::Ok) {
         ET_LOG(
             Error,
-            "CALL_DELEGATE execute failed at instruction %zu: 0x%" PRIx32,
+            "CALL_DELEGATE execute failed at instruction %" ET_PRIsize_t ": 0x%" PRIx32,
             step_state_.instr_idx,
             static_cast<uint32_t>(err));
       }
@@ -1351,7 +1352,7 @@ Error Method::execute() {
     ET_CHECK_OR_RETURN_ERROR(
         instructions != nullptr,
         Internal,
-        "chain %zu has no instructions field",
+        "chain %" ET_PRIsize_t " has no instructions field",
         step_state_.chain_idx);
 
     // Loop over instructions
@@ -1391,12 +1392,12 @@ MethodMeta Method::method_meta() const {
 }
 
 const EValue& Method::get_value(size_t i) const {
-  ET_CHECK_MSG(i < n_value_, "%zu >= %zu", i, n_value_);
+  ET_CHECK_MSG(i < n_value_, "%" ET_PRIsize_t " >= %" ET_PRIsize_t, i, n_value_);
   return values_[i];
 }
 
 EValue& Method::mutable_value(size_t i) {
-  ET_CHECK_MSG(i < n_value_, "%zu >= %zu", i, n_value_);
+  ET_CHECK_MSG(i < n_value_, "%" ET_PRIsize_t " >= %" ET_PRIsize_t, i, n_value_);
   return values_[i];
 }
 
@@ -1406,7 +1407,7 @@ size_t Method::inputs_size() const {
 }
 
 size_t Method::get_input_index(size_t i) const {
-  ET_CHECK_MSG(i < inputs_size(), "%zu >= %zu", i, inputs_size());
+  ET_CHECK_MSG(i < inputs_size(), "%" ET_PRIsize_t " >= %" ET_PRIsize_t, i, inputs_size());
   return static_cast<size_t>(serialization_plan_->inputs()->Get(i));
 }
 
@@ -1424,7 +1425,7 @@ size_t Method::outputs_size() const {
 }
 
 size_t Method::get_output_index(size_t i) const {
-  ET_CHECK_MSG(i < outputs_size(), "%zu >= %zu", i, outputs_size());
+  ET_CHECK_MSG(i < outputs_size(), "%" ET_PRIsize_t " >= %" ET_PRIsize_t, i, outputs_size());
   return static_cast<size_t>(serialization_plan_->outputs()->Get(i));
 }
 

runtime/platform/compiler.h

@@ -146,6 +146,13 @@
 #define ET_FUNCTION __FUNCTION__
 #endif // __has_builtin(__builtin_FUNCTION)
 
+// As of G3 RJ-2024.3 toolchain, zu format specifier is not supported for Xtensa
+#if defined(__XTENSA__)
+#define ET_PRIsize_t "lu"
+#else
+#define ET_PRIsize_t "zu"
+#endif
+
 // Whether the compiler supports GNU statement expressions.
 // https://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html
 #ifndef ET_HAVE_GNU_STATEMENT_EXPRESSIONS