compiler: add go_debug and use it for debug messages
authorIan Lance Taylor <ian@gcc.gnu.org>
Sun, 23 Jun 2019 22:04:53 +0000 (22:04 +0000)
committerIan Lance Taylor <ian@gcc.gnu.org>
Sun, 23 Jun 2019 22:04:53 +0000 (22:04 +0000)
    GCC recently added a new warning -Wformat-diag which does a lot of
    rigorous checks on GCC diagnostic messages.  This produces a number of
    unnecessary diagnostics on gofrontend diagnostic output, such as

    ../../trunk/gcc/go/gofrontend/escape.cc: In member function ‘virtual int Escape_analysis_assign::statement(Block*, size_t*, Statement*)’:
    ../../trunk/gcc/go/gofrontend/escape.cc:1336:33: warning: spurious leading punctuation sequence ‘[’ in format [-Wformat-diag]
     1336 |       go_inform(s->location(), "[%d] %s esc: %s",
          |                                 ^

    ../../trunk/gcc/go/gofrontend/escape.cc: In member function ‘void Escape_analysis_assign::call(Call_expression*)’:
    ../../trunk/gcc/go/gofrontend/escape.cc:1964:17: warning: unquoted operator ‘::’ in format [-Wformat-diag]
     1964 |         "esccall:: indirect call <- %s, untracked",
          |                 ^~

    ../../trunk/gcc/go/gofrontend/escape.cc:1964:34: warning: unbalanced punctuation character ‘<’ in format [-Wformat-diag]
     1964 |         "esccall:: indirect call <- %s, untracked",
          |                                  ^

    Avoid these messages by adding a new function go_debug that uses only
    printf formatting, not GCC diagnostic formatting, and change all the
    optimization debugging messages to use it.  None of the debugging
    messages used the GCC diagnostic formatting specifiers anyhow.

    Reviewed-on: https://go-review.googlesource.com/c/gofrontend/+/183437

From-SVN: r272607

gcc/go/gofrontend/MERGE
gcc/go/gofrontend/escape.cc
gcc/go/gofrontend/expressions.cc
gcc/go/gofrontend/go-diagnostics.cc
gcc/go/gofrontend/go-diagnostics.h
gcc/go/gofrontend/statements.cc

index d51917d..1f9c94f 100644 (file)
@@ -1,4 +1,4 @@
-9b5a43baaf391005989d140109261e5a8e1b1b63
+6bb63a21434b3360dbe7e4bd34889734f361d434
 
 The first line of this file holds the git revision number of the last
 merge done from the gofrontend repository.
index a155834..4cfb480 100644 (file)
@@ -964,9 +964,9 @@ Gogo::analyze_escape()
                 {
                   done = false;
                   if (this->debug_escape_level() > 2)
-                    go_inform((*n)->location(), "Reflooding %s %s",
-                              debug_function_name((*n)->state(context, NULL)->fn).c_str(),
-                              (*n)->ast_format(this).c_str());
+                    go_debug((*n)->location(), "Reflooding %s %s",
+                            debug_function_name((*n)->state(context, NULL)->fn).c_str(),
+                            (*n)->ast_format(this).c_str());
                   escapes[*n] = (*n)->encoding();
                   this->propagate_escape(context, *n);
                 }
@@ -990,9 +990,9 @@ Gogo::analyze_escape()
            {
              Node::Escape_state* state = (*n)->state(context, NULL);
              if ((*n)->encoding() == Node::ESCAPE_NONE)
-               go_inform((*n)->location(), "%s %s does not escape",
-                         strip_packed_prefix(this, debug_function_name(state->fn)).c_str(),
-                         (*n)->ast_format(this).c_str());
+               go_debug((*n)->location(), "%s %s does not escape",
+                        strip_packed_prefix(this, debug_function_name(state->fn)).c_str(),
+                        (*n)->ast_format(this).c_str());
            }
        }
       delete context;
@@ -1333,9 +1333,9 @@ Escape_analysis_assign::statement(Block*, size_t*, Statement* s)
     {
       Node* n = Node::make_node(s);
       std::string fn_name = this->context_->current_function_name();
-      go_inform(s->location(), "[%d] %s esc: %s",
-               this->context_->loop_depth(), fn_name.c_str(),
-               n->ast_format(gogo).c_str());
+      go_debug(s->location(), "[%d] %s esc: %s",
+              this->context_->loop_depth(), fn_name.c_str(),
+              n->ast_format(gogo).c_str());
     }
 
   switch (s->classification())
@@ -1495,9 +1495,9 @@ move_to_heap(Gogo* gogo, Expression *expr)
     {
       Node* n = Node::make_node(expr);
       if (gogo->debug_escape_level() != 0)
-        go_inform(n->definition_location(),
-                  "moved to heap: %s",
-                  n->ast_format(gogo).c_str());
+        go_debug(n->definition_location(),
+                "moved to heap: %s",
+                n->ast_format(gogo).c_str());
       if (gogo->compiling_runtime() && gogo->package_name() == "runtime")
         go_error_at(expr->location(),
                     "%s escapes to heap, not allowed in runtime",
@@ -1519,8 +1519,8 @@ Escape_analysis_assign::expression(Expression** pexpr)
       && n->is_big(this->context_))
     {
       if (debug_level > 1)
-       go_inform((*pexpr)->location(), "%s too large for stack",
-                  n->ast_format(gogo).c_str());
+       go_debug((*pexpr)->location(), "%s too large for stack",
+                n->ast_format(gogo).c_str());
       move_to_heap(gogo, *pexpr);
       n->set_encoding(Node::ESCAPE_HEAP);
       (*pexpr)->address_taken(true);
@@ -1534,9 +1534,9 @@ Escape_analysis_assign::expression(Expression** pexpr)
     {
       Node* n = Node::make_node(*pexpr);
       std::string fn_name = this->context_->current_function_name();
-      go_inform((*pexpr)->location(), "[%d] %s esc: %s",
-               this->context_->loop_depth(), fn_name.c_str(),
-               n->ast_format(gogo).c_str());
+      go_debug((*pexpr)->location(), "[%d] %s esc: %s",
+              this->context_->loop_depth(), fn_name.c_str(),
+              n->ast_format(gogo).c_str());
     }
 
   switch ((*pexpr)->classification())
@@ -1566,8 +1566,8 @@ Escape_analysis_assign::expression(Expression** pexpr)
                       Node* appended = Node::make_node(call->args()->back());
                       this->assign_deref(this->context_->sink(), appended);
                       if (debug_level > 2)
-                        go_inform((*pexpr)->location(),
-                                  "special treatment of append(slice1, slice2...)");
+                        go_debug((*pexpr)->location(),
+                                "special treatment of append(slice1, slice2...)");
                     }
                   else
                     {
@@ -1960,9 +1960,9 @@ Escape_analysis_assign::call(Call_expression* call)
            ++p)
        {
          if (debug_level > 2)
-           go_inform(call->location(),
-                     "esccall:: indirect call <- %s, untracked",
-                     (*p)->ast_format(gogo).c_str());
+           go_debug(call->location(),
+                    "esccall:: indirect call <- %s, untracked",
+                    (*p)->ast_format(gogo).c_str());
          this->assign(this->context_->sink(), *p);
        }
 
@@ -1987,8 +1987,8 @@ Escape_analysis_assign::call(Call_expression* call)
       && !fntype->is_tagged())
     {
       if (debug_level > 2)
-       go_inform(call->location(), "esccall:: %s in recursive group",
-                 call_node->ast_format(gogo).c_str());
+       go_debug(call->location(), "esccall:: %s in recursive group",
+                call_node->ast_format(gogo).c_str());
 
       Function* f = fn->named_object()->func_value();
       const Bindings* callee_bindings = f->block()->bindings();
@@ -2059,8 +2059,8 @@ Escape_analysis_assign::call(Call_expression* call)
          for (; p != arg_nodes.end(); ++p)
            {
              if (debug_level > 2)
-               go_inform(call->location(), "esccall:: ... <- %s, untracked",
-                         (*p)->ast_format(gogo).c_str());
+               go_debug(call->location(), "esccall:: ... <- %s, untracked",
+                        (*p)->ast_format(gogo).c_str());
              this->assign(this->context_->sink(), *p);
            }
        }
@@ -2069,8 +2069,8 @@ Escape_analysis_assign::call(Call_expression* call)
     }
 
   if (debug_level > 2)
-    go_inform(call->location(), "esccall:: %s not recursive",
-             call_node->ast_format(gogo).c_str());
+    go_debug(call->location(), "esccall:: %s not recursive",
+            call_node->ast_format(gogo).c_str());
 
   Node::Escape_state* call_state = call_node->state(this->context_, NULL);
   if (!call_state->retvals.empty())
@@ -2146,8 +2146,8 @@ Escape_analysis_assign::call(Call_expression* call)
       for (; p != arg_nodes.end(); ++p)
        {
          if (debug_level > 2)
-           go_inform(call->location(), "esccall:: ... <- %s, untracked",
-                      (*p)->ast_format(gogo).c_str());
+           go_debug(call->location(), "esccall:: ... <- %s, untracked",
+                    (*p)->ast_format(gogo).c_str());
          this->assign(this->context_->sink(), *p);
        }
     }
@@ -2165,13 +2165,13 @@ Escape_analysis_assign::assign(Node* dst, Node* src)
   Gogo* gogo = this->context_->gogo();
   int debug_level = gogo->debug_escape_level();
   if (debug_level > 1)
-    go_inform(dst->location(), "[%d] %s escassign: %s(%s)[%s] = %s(%s)[%s]",
-             this->context_->loop_depth(),
-             strip_packed_prefix(gogo, this->context_->current_function_name()).c_str(),
-             dst->ast_format(gogo).c_str(), dst->details().c_str(),
-             dst->op_format().c_str(),
-             src->ast_format(gogo).c_str(), src->details().c_str(),
-             src->op_format().c_str());
+    go_debug(dst->location(), "[%d] %s escassign: %s(%s)[%s] = %s(%s)[%s]",
+            this->context_->loop_depth(),
+            strip_packed_prefix(gogo, this->context_->current_function_name()).c_str(),
+            dst->ast_format(gogo).c_str(), dst->details().c_str(),
+            dst->op_format().c_str(),
+            src->ast_format(gogo).c_str(), src->details().c_str(),
+            src->op_format().c_str());
 
   if (dst->is_indirect())
     // Lose track of the dereference.
@@ -2637,9 +2637,9 @@ Escape_analysis_assign::assign_from_note(std::string* note,
     }
 
   if (this->context_->gogo()->debug_escape_level() > 2)
-    go_inform(src->location(), "assignfromtag:: src=%s em=%s",
-              src->ast_format(context_->gogo()).c_str(),
-             Escape_note::make_tag(enc).c_str());
+    go_debug(src->location(), "assignfromtag:: src=%s em=%s",
+            src->ast_format(context_->gogo()).c_str(),
+            Escape_note::make_tag(enc).c_str());
 
   if (enc == Node::ESCAPE_UNKNOWN)
     {
@@ -2707,8 +2707,8 @@ Escape_analysis_assign::flows(Node* dst, Node* src)
 
   Gogo* gogo = this->context_->gogo();
   if (gogo->debug_escape_level() > 2)
-    go_inform(Linemap::unknown_location(), "flows:: %s <- %s",
-              dst->ast_format(gogo).c_str(), src->ast_format(gogo).c_str());
+    go_debug(Linemap::unknown_location(), "flows:: %s <- %s",
+            dst->ast_format(gogo).c_str(), src->ast_format(gogo).c_str());
 
   if (dst_state->flows.empty())
     this->context_->add_dst(dst);
@@ -2864,18 +2864,18 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
   Gogo* gogo = this->context_->gogo();
   int debug_level = gogo->debug_escape_level();
   if (debug_level > 1)
-    go_inform(Linemap::unknown_location(),
-             "escwalk: level:{%d %d} depth:%d "
-             "op=%s %s(%s) "
-             "scope:%s[%d] "
-             "extraloopdepth=%d",
-             level.value(), level.suffix_value(), this->context_->pdepth(),
-             src->op_format().c_str(),
-             src->ast_format(gogo).c_str(),
-             src->details().c_str(),
-             debug_function_name(src_state->fn).c_str(),
-             src_state->loop_depth,
-             extra_loop_depth);
+    go_debug(Linemap::unknown_location(),
+            "escwalk: level:{%d %d} depth:%d "
+            "op=%s %s(%s) "
+            "scope:%s[%d] "
+            "extraloopdepth=%d",
+            level.value(), level.suffix_value(), this->context_->pdepth(),
+            src->op_format().c_str(),
+            src->ast_format(gogo).c_str(),
+            src->details().c_str(),
+            debug_function_name(src_state->fn).c_str(),
+            src_state->loop_depth,
+            extra_loop_depth);
 
   this->context_->increase_pdepth();
 
@@ -2911,17 +2911,17 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
       if (debug_level != 0)
        {
          if (debug_level == 1)
-           go_inform(src->definition_location(),
-                     "leaking param: %s to result %s level=%d",
-                     src->ast_format(gogo).c_str(),
-                     dst->ast_format(gogo).c_str(),
-                     level.value());
+           go_debug(src->definition_location(),
+                    "leaking param: %s to result %s level=%d",
+                    src->ast_format(gogo).c_str(),
+                    dst->ast_format(gogo).c_str(),
+                    level.value());
          else
-           go_inform(src->definition_location(),
-                     "leaking param: %s to result %s level={%d %d}",
-                     src->ast_format(gogo).c_str(),
-                     dst->ast_format(gogo).c_str(),
-                     level.value(), level.suffix_value());
+           go_debug(src->definition_location(),
+                    "leaking param: %s to result %s level={%d %d}",
+                    src->ast_format(gogo).c_str(),
+                    dst->ast_format(gogo).c_str(),
+                    level.value(), level.suffix_value());
        }
 
       if ((src->encoding() & ESCAPE_MASK) != Node::ESCAPE_RETURN)
@@ -2959,8 +2959,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
                           Node::ESCAPE_NONE);
       src->set_encoding(enc);
       if (debug_level != 0)
-       go_inform(src->definition_location(), "mark escaped content: %s",
-                 src->ast_format(gogo).c_str());
+       go_debug(src->definition_location(), "mark escaped content: %s",
+                src->ast_format(gogo).c_str());
     }
 
   // A src object leaks if its value or address is assigned to a dst object
@@ -2984,14 +2984,14 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
                               Node::ESCAPE_NONE);
          src->set_encoding(enc);
          if (debug_level != 0 && osrcesc != src->encoding())
-           go_inform(src->definition_location(), "leaking param content: %s",
-                     src->ast_format(gogo).c_str());
+           go_debug(src->definition_location(), "leaking param content: %s",
+                    src->ast_format(gogo).c_str());
        }
       else
        {
          if (debug_level != 0)
-           go_inform(src->definition_location(), "leaking param: %s",
-                      src->ast_format(gogo).c_str());
+           go_debug(src->definition_location(), "leaking param: %s",
+                    src->ast_format(gogo).c_str());
          src->set_encoding(Node::ESCAPE_HEAP);
        }
     }
@@ -3001,8 +3001,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
       if (e->enclosed_var_expression() != NULL)
        {
          if (src_leaks && debug_level != 0)
-           go_inform(src->location(), "leaking closure reference %s",
-                     src->ast_format(gogo).c_str());
+           go_debug(src->location(), "leaking closure reference %s",
+                    src->ast_format(gogo).c_str());
 
          Node* enclosed_node =
            Node::make_node(e->enclosed_var_expression()->variable());
@@ -3030,15 +3030,15 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
                 {
                   move_to_heap(gogo, underlying);
                   if (debug_level > 1)
-                    go_inform(src->location(),
-                              "%s escapes to heap, level={%d %d}, "
-                              "dst.eld=%d, src.eld=%d",
-                              src->ast_format(gogo).c_str(), level.value(),
-                              level.suffix_value(), dst_state->loop_depth,
-                              mod_loop_depth);
+                    go_debug(src->location(),
+                            "%s escapes to heap, level={%d %d}, "
+                            "dst.eld=%d, src.eld=%d",
+                            src->ast_format(gogo).c_str(), level.value(),
+                            level.suffix_value(), dst_state->loop_depth,
+                            mod_loop_depth);
                   else if (debug_level > 0)
-                    go_inform(src->location(), "%s escapes to heap",
-                              src->ast_format(gogo).c_str());
+                    go_debug(src->location(), "%s escapes to heap",
+                            src->ast_format(gogo).c_str());
                 }
 
              this->flood(level.decrease(), dst,
@@ -3068,8 +3068,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
            {
              src->set_encoding(Node::ESCAPE_HEAP);
              if (debug_level != 0 && osrcesc != src->encoding())
-               go_inform(src->location(), "%s escapes to heap",
-                         src->ast_format(gogo).c_str());
+               go_debug(src->location(), "%s escapes to heap",
+                        src->ast_format(gogo).c_str());
              extra_loop_depth = mod_loop_depth;
            }
        }
@@ -3100,8 +3100,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
                     {
                       src->set_encoding(Node::ESCAPE_HEAP);
                       if (debug_level != 0 && osrcesc != src->encoding())
-                        go_inform(src->location(), "%s escapes to heap",
-                                  src->ast_format(gogo).c_str());
+                        go_debug(src->location(), "%s escapes to heap",
+                                src->ast_format(gogo).c_str());
                       extra_loop_depth = mod_loop_depth;
                     }
                   break;
@@ -3119,11 +3119,11 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
               // This can only happen with functions returning a single result.
               go_assert(src_state->retvals.size() == 1);
               if (debug_level > 2)
-                go_inform(src->location(), "[%d] dst %s escwalk replace src: %s with %s",
-                          this->context_->loop_depth(),
-                          dst->ast_format(gogo).c_str(),
-                          src->ast_format(gogo).c_str(),
-                          src_state->retvals[0]->ast_format(gogo).c_str());
+                go_debug(src->location(), "[%d] dst %s escwalk replace src: %s with %s",
+                        this->context_->loop_depth(),
+                        dst->ast_format(gogo).c_str(),
+                        src->ast_format(gogo).c_str(),
+                        src_state->retvals[0]->ast_format(gogo).c_str());
               src = src_state->retvals[0];
               src_state = src->state(this->context_, NULL);
             }
@@ -3133,8 +3133,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
          // Calls to Runtime::NEW get lowered into an allocation expression.
          src->set_encoding(Node::ESCAPE_HEAP);
          if (debug_level != 0 && osrcesc != src->encoding())
-           go_inform(src->location(), "%s escapes to heap",
-                      src->ast_format(gogo).c_str());
+           go_debug(src->location(), "%s escapes to heap",
+                    src->ast_format(gogo).c_str());
           extra_loop_depth = mod_loop_depth;
        }
       else if ((e->map_literal() != NULL
@@ -3145,8 +3145,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
         {
           src->set_encoding(Node::ESCAPE_HEAP);
           if (debug_level != 0 && osrcesc != src->encoding())
-            go_inform(src->location(), "%s escapes to heap",
-                      src->ast_format(gogo).c_str());
+            go_debug(src->location(), "%s escapes to heap",
+                    src->ast_format(gogo).c_str());
           extra_loop_depth = mod_loop_depth;
         }
       else if (e->conversion_expression() != NULL && src_leaks)
@@ -3163,8 +3163,8 @@ Escape_analysis_flood::flood(Level level, Node* dst, Node* src,
               // interface(T)
               src->set_encoding(Node::ESCAPE_HEAP);
               if (debug_level != 0 && osrcesc != src->encoding())
-                go_inform(src->location(), "%s escapes to heap",
-                          src->ast_format(gogo).c_str());
+                go_debug(src->location(), "%s escapes to heap",
+                        src->ast_format(gogo).c_str());
               extra_loop_depth = mod_loop_depth;
               if (tt->interface_type() != NULL
                   && ft->has_pointer()
@@ -3276,10 +3276,10 @@ Gogo::propagate_escape(Escape_context* context, Node* dst)
   Node::Escape_state* state = dst->state(context, NULL);
   Gogo* gogo = context->gogo();
   if (gogo->debug_escape_level() > 1)
-    go_inform(Linemap::unknown_location(), "escflood:%d: dst %s scope:%s[%d]",
-             context->flood_id(), dst->ast_format(gogo).c_str(),
-             debug_function_name(state->fn).c_str(),
-             state->loop_depth);
+    go_debug(Linemap::unknown_location(), "escflood:%d: dst %s scope:%s[%d]",
+            context->flood_id(), dst->ast_format(gogo).c_str(),
+            debug_function_name(state->fn).c_str(),
+            state->loop_depth);
 
   Escape_analysis_flood eaf(context);
   for (std::set<Node*>::const_iterator p = state->flows.begin();
index 04aacf8..782899c 100644 (file)
@@ -4026,7 +4026,7 @@ Type_conversion_expression::do_get_backend(Translate_context* context)
           if (this->no_copy_)
             {
               if (gogo->debug_optimization())
-                go_inform(loc, "no copy string([]byte)");
+                go_debug(loc, "no copy string([]byte)");
               Expression* ptr = Expression::make_slice_info(this->expr_,
                                                             SLICE_INFO_VALUE_POINTER,
                                                             loc);
index 21e45b3..4a091e3 100644 (file)
@@ -175,3 +175,25 @@ go_inform(const Location location, const char* fmt, ...)
   go_be_inform(location, expand_message(fmt, ap));
   va_end(ap);
 }
+
+// go_debug uses normal printf formatting, not GCC diagnostic formatting.
+
+void
+go_debug(const Location location, const char* fmt, ...)
+{
+  va_list ap;
+
+  va_start(ap, fmt);
+  char* mbuf = NULL;
+  int nwr = vasprintf(&mbuf, fmt, ap);
+  va_end(ap);
+  if (nwr == -1)
+    {
+      go_be_error_at(Linemap::unknown_location(),
+                    "memory allocation failed in vasprintf");
+      go_assert(0);
+    }
+  std::string rval = std::string(mbuf);
+  free(mbuf);
+  go_be_inform(location, rval);
+}
index 70c97cb..a687553 100644 (file)
 #define GO_ATTRIBUTE_GCC_DIAG(m,  n)
 #endif
 
+#if __GNUC__ >= 3
+#define GO_ATTRIBUTE_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n))) __attribute__ ((__nonnull__ (m)))
+#else
+#define GO_ATTRIBUTE_PRINTF(m, n)
+#endif
+
 // These declarations define the interface through which the frontend
 // reports errors and warnings. These functions accept printf-like
 // format specifiers (e.g. %d, %f, %s, etc), with the following additional
@@ -41,6 +47,12 @@ extern void go_fatal_error(const Location, const char* fmt, ...)
 extern void go_inform(const Location, const char* fmt, ...)
     GO_ATTRIBUTE_GCC_DIAG(2,3);
 
+// go_debug is used to report a debugging message at a location.  This
+// uses standard printf formatting.
+
+extern void go_debug(const Location, const char* fmt, ...)
+  GO_ATTRIBUTE_PRINTF(2, 3);
+
 // These interfaces provide a way for the front end to ask for
 // the open/close quote characters it should use when formatting
 // diagnostics (warnings, errors).
index ad4a353..4a0116c 100644 (file)
@@ -6085,7 +6085,7 @@ For_range_statement::do_lower(Gogo* gogo, Named_object*, Block* enclosing,
       if (clear != NULL)
         {
           if (gogo->debug_optimization())
-            go_inform(loc, "map range clear");
+            go_debug(loc, "map range clear");
           temp_block->add_statement(clear);
           return Statement::make_block_statement(temp_block, loc);
         }
@@ -6102,7 +6102,7 @@ For_range_statement::do_lower(Gogo* gogo, Named_object*, Block* enclosing,
       if (clear != NULL)
         {
           if (gogo->debug_optimization())
-            go_inform(loc, "array range clear");
+            go_debug(loc, "array range clear");
           temp_block->add_statement(clear);
           return Statement::make_block_statement(temp_block, loc);
         }