From patchwork Sat Nov 16 01:23:10 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Malcolm X-Patchwork-Id: 1196016 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gcc.gnu.org (client-ip=209.132.180.131; helo=sourceware.org; envelope-from=gcc-patches-return-513740-incoming=patchwork.ozlabs.org@gcc.gnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=gcc.gnu.org header.i=@gcc.gnu.org header.b="fgOIje/d"; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.b="d0aLWBhZ"; dkim-atps=neutral Received: from sourceware.org (server1.sourceware.org [209.132.180.131]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 47FHXP2ZTrz9s7T for ; Sat, 16 Nov 2019 12:23:01 +1100 (AEDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender:from :to:cc:subject:date:message-id:in-reply-to:references :content-type:content-transfer-encoding; q=dns; s=default; b=G8C iaEz6lggglfBS9EkR+HSV2QbHwGxGzZ0e9N1diETeAyt+oiu304bjVUbHyWmqTcS lBl1oa74+hMsV3PL0vQhKEydKA17o/3bW9lTAzMJQOQKo7jDvHshRmfbDSayS/a7 bw+g9TYI5p/Fq4oa5yD+FFUcEmkm/084Fu7rK4DA= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender:from :to:cc:subject:date:message-id:in-reply-to:references :content-type:content-transfer-encoding; s=default; bh=kUm59dI0G f8vJfF93CSVDZwHUxk=; b=fgOIje/di6AkmHO96mAZd2yl4wCBlGVNH8uuI0IVD dVFSmWI+CpNSLWuOxvZizk7A8az3ReTl0GOtSBioM1LS4Oep/tRU9+yNCa9Qd3Bj drdxFPRUcqaDMFoEaVmBj1IwCdMJKGqCXTYy1o9bUqrJoxVN9uPn4VYlgeb2eSzv 2M= Received: (qmail 61104 invoked by alias); 16 Nov 2019 01:18:06 -0000 Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Archive: List-Post: List-Help: Sender: gcc-patches-owner@gcc.gnu.org Delivered-To: mailing list gcc-patches@gcc.gnu.org Received: (qmail 58422 invoked by uid 89); 16 Nov 2019 01:17:40 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-21.4 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, KAM_SHORT autolearn=ham version=3.3.1 spammy= X-HELO: us-smtp-1.mimecast.com Received: from us-smtp-delivery-1.mimecast.com (HELO us-smtp-1.mimecast.com) (207.211.31.120) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Sat, 16 Nov 2019 01:17:36 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1573867054; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=fI4cu+C0ELtmBQCE8HYZMYw01L/yiMpDDx+bETGOa9s=; b=d0aLWBhZqI4Nibet+6m4K66WBXtclbIOGJ262IrCsQaR9ln6cmO3EjygOWl0FLPJmwKqGg oAZJoOrJxQhL5sS0eYKyu+s3/nKolX+8STsbS+1X5chWiUlfu5fcvFis92IRa5RydEd5CW ycxCIaIM87KZKR3Joi8AMD3vy1Otb4Q= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-213-gesbJ3xeNReE5KJ-vn5sSQ-1; Fri, 15 Nov 2019 20:17:33 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 33935107ACC5 for ; Sat, 16 Nov 2019 01:17:32 +0000 (UTC) Received: from c64.redhat.com (ovpn-112-32.phx2.redhat.com [10.3.112.32]) by smtp.corp.redhat.com (Postfix) with ESMTP id 82FD810246FB; Sat, 16 Nov 2019 01:17:29 +0000 (UTC) From: David Malcolm To: gcc-patches@gcc.gnu.org Cc: David Malcolm Subject: [PATCH 23/49] analyzer: logging support Date: Fri, 15 Nov 2019 20:23:10 -0500 Message-Id: <1573867416-55618-24-git-send-email-dmalcolm@redhat.com> In-Reply-To: <1573867416-55618-1-git-send-email-dmalcolm@redhat.com> References: <1573867416-55618-1-git-send-email-dmalcolm@redhat.com> X-Mimecast-Spam-Score: 0 X-IsSubscribed: yes This patch adds a logging framework to the analyzer which handles hierarchical messages (showing the nested structure of the calls). This code is largely based on that in the "jit" subdirectory (with a few changes). An alternative would be to generalize that code and move it to the gcc parent directory. gcc/ChangeLog: * analyzer/analyzer-logging.cc: New file. * analyzer/analyzer-logging.h: New file. --- gcc/analyzer/analyzer-logging.cc | 220 +++++++++++++++++++++++++++++++++ gcc/analyzer/analyzer-logging.h | 256 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 476 insertions(+) create mode 100644 gcc/analyzer/analyzer-logging.cc create mode 100644 gcc/analyzer/analyzer-logging.h diff --git a/gcc/analyzer/analyzer-logging.cc b/gcc/analyzer/analyzer-logging.cc new file mode 100644 index 0000000..575435c --- /dev/null +++ b/gcc/analyzer/analyzer-logging.cc @@ -0,0 +1,220 @@ +/* Hierarchical log messages for the analyzer. + Copyright (C) 2014-2019 Free Software Foundation, Inc. + Contributed by David Malcolm . + +This file is part of GCC. + +GCC is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3, or (at your option) +any later version. + +GCC is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GCC; see the file COPYING3. If not see +. */ + +#include "config.h" +#include "system.h" +#include "coretypes.h" +#include "toplev.h" /* for print_version */ +#include "pretty-print.h" /* for print_version */ +#include "diagnostic.h" +#include "tree-diagnostic.h" + +#include "analyzer/analyzer-logging.h" + +/* Implementation of class logger. */ + +/* ctor for logger. */ + +logger::logger (FILE *f_out, + int, /* flags */ + int /* verbosity */, + const pretty_printer &reference_pp) : + m_refcount (0), + m_f_out (f_out), + m_indent_level (0), + m_log_refcount_changes (false), + m_pp (reference_pp.clone ()) +{ + pp_show_color (m_pp) = 0; + pp_buffer (m_pp)->stream = f_out; + + /* %qE in logs for SSA_NAMEs should show the ssa names, rather than + trying to prettify things by showing the underlying var. */ + pp_format_decoder (m_pp) = default_tree_printer; + + /* Begin the log by writing the GCC version. */ + print_version (f_out, "", false); +} + +/* The destructor for logger, invoked via + the decref method when the refcount hits zero. + Note that we do not close the underlying FILE * (m_f_out). */ + +logger::~logger () +{ + /* This should be the last message emitted. */ + log ("%s", __PRETTY_FUNCTION__); + gcc_assert (m_refcount == 0); + delete m_pp; +} + +/* Increment the reference count of the logger. */ + +void +logger::incref (const char *reason) +{ + m_refcount++; + if (m_log_refcount_changes) + log ("%s: reason: %s refcount now %i ", + __PRETTY_FUNCTION__, reason, m_refcount); +} + +/* Decrement the reference count of the logger, + deleting it if nothing is referring to it. */ + +void +logger::decref (const char *reason) +{ + gcc_assert (m_refcount > 0); + --m_refcount; + if (m_log_refcount_changes) + log ("%s: reason: %s refcount now %i", + __PRETTY_FUNCTION__, reason, m_refcount); + if (m_refcount == 0) + delete this; +} + +/* Write a formatted message to the log, by calling the log_va method. */ + +void +logger::log (const char *fmt, ...) +{ + va_list ap; + va_start (ap, fmt); + log_va (fmt, &ap); + va_end (ap); +} + +/* Write an indented line to the log file. + + We explicitly flush after each line: if something crashes the process, + we want the logfile/stream to contain the most up-to-date hint about the + last thing that was happening, without it being hidden in an in-process + buffer. */ + +void +logger::log_va (const char *fmt, va_list *ap) +{ + start_log_line (); + log_va_partial (fmt, ap); + end_log_line (); +} + +void +logger::start_log_line () +{ + for (int i = 0; i < m_indent_level; i++) + fputc (' ', m_f_out); +} + +void +logger::log_partial (const char *fmt, ...) +{ + va_list ap; + va_start (ap, fmt); + log_va_partial (fmt, &ap); + va_end (ap); +} + +void +logger::log_va_partial (const char *fmt, va_list *ap) +{ + text_info text; + text.format_spec = fmt; + text.args_ptr = ap; + text.err_no = 0; + pp_format (m_pp, &text); + pp_output_formatted_text (m_pp); +} + +void +logger::end_log_line () +{ + pp_flush (m_pp); + pp_clear_output_area (m_pp); + fprintf (m_f_out, "\n"); + fflush (m_f_out); +} + +/* Record the entry within a particular scope, indenting subsequent + log lines accordingly. */ + +void +logger::enter_scope (const char *scope_name) +{ + log ("entering: %s", scope_name); + m_indent_level += 1; +} + +void +logger::enter_scope (const char *scope_name, const char *fmt, va_list *ap) +{ + start_log_line (); + log_partial ("entering: %s: ", scope_name); + log_va_partial (fmt, ap); + end_log_line (); + + m_indent_level += 1; +} + + +/* Record the exit from a particular scope, restoring the indent level to + before the scope was entered. */ + +void +logger::exit_scope (const char *scope_name) +{ + if (m_indent_level) + m_indent_level -= 1; + else + log ("(mismatching indentation)"); + log ("exiting: %s", scope_name); +} + +/* Implementation of class log_user. */ + +/* The constructor for log_user. */ + +log_user::log_user (logger *logger) : m_logger (logger) +{ + if (m_logger) + m_logger->incref("log_user ctor"); +} + +/* The destructor for log_user. */ + +log_user::~log_user () +{ + if (m_logger) + m_logger->decref("log_user dtor"); +} + +/* Set the logger for a log_user, managing the reference counts + of the old and new logger (either of which might be NULL). */ + +void +log_user::set_logger (logger *logger) +{ + if (logger) + logger->incref ("log_user::set_logger"); + if (m_logger) + m_logger->decref ("log_user::set_logger"); + m_logger = logger; +} diff --git a/gcc/analyzer/analyzer-logging.h b/gcc/analyzer/analyzer-logging.h new file mode 100644 index 0000000..3e000b6 --- /dev/null +++ b/gcc/analyzer/analyzer-logging.h @@ -0,0 +1,256 @@ +/* Hierarchical log messages for the analyzer. + Copyright (C) 2014-2019 Free Software Foundation, Inc. + Contributed by David Malcolm . + +This file is part of GCC. + +GCC is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3, or (at your option) +any later version. + +GCC is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GCC; see the file COPYING3. If not see +. */ + +/* Adapted from jit-logging.h. */ + +#ifndef ANALYZER_LOGGING_H +#define ANALYZER_LOGGING_H + +#include "diagnostic-core.h" + +/* A logger encapsulates a logging stream: a way to send + lines of pertinent information to a FILE *. */ + +class logger +{ + public: + logger (FILE *f_out, int flags, int verbosity, const pretty_printer &reference_pp); + ~logger (); + + void incref (const char *reason); + void decref (const char *reason); + + void log (const char *fmt, ...) + ATTRIBUTE_GCC_DIAG(2, 3); + void log_va (const char *fmt, va_list *ap) + ATTRIBUTE_GCC_DIAG(2, 0); + void start_log_line (); + void log_partial (const char *fmt, ...) + ATTRIBUTE_GCC_DIAG(2, 3); + void log_va_partial (const char *fmt, va_list *ap) + ATTRIBUTE_GCC_DIAG(2, 0); + void end_log_line (); + + void enter_scope (const char *scope_name); + void enter_scope (const char *scope_name, const char *fmt, va_list *ap) + ATTRIBUTE_GCC_DIAG(3, 0); + void exit_scope (const char *scope_name); + + pretty_printer *get_printer () const { return m_pp; } + FILE *get_file () const { return m_f_out; } + +private: + int m_refcount; + FILE *m_f_out; + int m_indent_level; + bool m_log_refcount_changes; + pretty_printer *m_pp; +}; + +/* The class log_scope is an RAII-style class intended to make + it easy to notify a logger about entering and exiting the body of a + given function. */ + +class log_scope +{ +public: + log_scope (logger *logger, const char *name); + log_scope (logger *logger, const char *name, const char *fmt, ...) + ATTRIBUTE_GCC_DIAG(4, 5); + ~log_scope (); + + private: + logger *m_logger; + const char *m_name; +}; + +/* The constructor for log_scope. + + The normal case is that the logger is NULL, in which case this should + be largely a no-op. + + If we do have a logger, notify it that we're entering the given scope. + We also need to hold a reference on it, to avoid a use-after-free + when logging the cleanup of the owner of the logger. */ + +inline +log_scope::log_scope (logger *logger, const char *name) : + m_logger (logger), + m_name (name) +{ + if (m_logger) + { + m_logger->incref ("log_scope ctor"); + m_logger->enter_scope (m_name); + } +} + +inline +log_scope::log_scope (logger *logger, const char *name, const char *fmt, ...): + m_logger (logger), + m_name (name) +{ + if (m_logger) + { + m_logger->incref ("log_scope ctor"); + va_list ap; + va_start (ap, fmt); + m_logger->enter_scope (m_name, fmt, &ap); + va_end (ap); + } +} + + +/* The destructor for log_scope; essentially the opposite of + the constructor. */ + +inline +log_scope::~log_scope () +{ + if (m_logger) + { + m_logger->exit_scope (m_name); + m_logger->decref ("log_scope dtor"); + } +} + +/* A log_user is something that potentially uses a logger (which could be NULL). + + The log_user class keeps the reference-count of a logger up-to-date. */ + +class log_user +{ + public: + log_user (logger *logger); + ~log_user (); + + logger * get_logger () const { return m_logger; } + void set_logger (logger * logger); + + void log (const char *fmt, ...) const + ATTRIBUTE_GCC_DIAG(2, 3); + + void start_log_line () const; + void end_log_line () const; + + void enter_scope (const char *scope_name); + void exit_scope (const char *scope_name); + + pretty_printer *get_logger_pp () const + { + gcc_assert (m_logger); + return m_logger->get_printer (); + } + + FILE *get_logger_file () const + { + if (m_logger == NULL) + return NULL; + return m_logger->get_file (); + } + + private: + logger *m_logger; +}; + +/* A shortcut for calling log from a log_user, handling the common + case where the underlying logger is NULL via a no-op. */ + +inline void +log_user::log (const char *fmt, ...) const +{ + if (m_logger) + { + va_list ap; + va_start (ap, fmt); + m_logger->log_va (fmt, &ap); + va_end (ap); + } +} + +/* A shortcut for starting a log line from a log_user, + handling the common case where the underlying logger is NULL via + a no-op. */ + +inline void +log_user::start_log_line () const +{ + if (m_logger) + m_logger->start_log_line (); +} + +/* A shortcut for ending a log line from a log_user, + handling the common case where the underlying logger is NULL via + a no-op. */ + +inline void +log_user::end_log_line () const +{ + if (m_logger) + m_logger->end_log_line (); +} + +/* A shortcut for recording entry into a scope from a log_user, + handling the common case where the underlying logger is NULL via + a no-op. */ + +inline void +log_user::enter_scope (const char *scope_name) +{ + if (m_logger) + m_logger->enter_scope (scope_name); +} + +/* A shortcut for recording exit from a scope from a log_user, + handling the common case where the underlying logger is NULL via + a no-op. */ + +inline void +log_user::exit_scope (const char *scope_name) +{ + if (m_logger) + m_logger->exit_scope (scope_name); +} + +/* If the given logger is non-NULL, log entry/exit of this scope to + it, identifying it using __PRETTY_FUNCTION__. */ + +#define LOG_SCOPE(LOGGER) \ + log_scope s (LOGGER, __PRETTY_FUNCTION__) + +/* If the given logger is non-NULL, log entry/exit of this scope to + it, identifying it using __func__. */ + +#define LOG_FUNC(LOGGER) \ + log_scope s (LOGGER, __func__) + +#define LOG_FUNC_1(LOGGER, FMT, A0) \ + log_scope s (LOGGER, __func__, FMT, A0) + +#define LOG_FUNC_2(LOGGER, FMT, A0, A1) \ + log_scope s (LOGGER, __func__, FMT, A0, A1) + +#define LOG_FUNC_3(LOGGER, FMT, A0, A1, A2) \ + log_scope s (LOGGER, __func__, FMT, A0, A1, A2) + +#define LOG_FUNC_4(LOGGER, FMT, A0, A1, A2, A3) \ + log_scope s (LOGGER, __func__, FMT, A0, A1, A2, A3) + +#endif /* ANALYZER_LOGGING_H */