1 /*

     2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.

     8  *

     9  * This code is distributed in the hope that it will be useful, but WITHOUT

    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    12  * version 2 for more details (a copy is included in the LICENSE file that

    13  * accompanied this code).

    14  *

    15  * You should have received a copy of the GNU General Public License version

    16  * 2 along with this work; if not, write to the Free Software Foundation,

    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    18  *

    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    20  * or visit www.oracle.com if you need additional information or have any

    21  * questions.

    22  *

    23  */

    24 #ifndef SHARE_VM_LOGGING_LOGCONFIGURATION_HPP

    25 #define SHARE_VM_LOGGING_LOGCONFIGURATION_HPP

    26 

    27 #include "memory/allocation.hpp"

    28 #include "utilities/globalDefinitions.hpp"

    29 

    30 class LogOutput;

    31 class LogDecorators;

    32 class LogTagLevelExpression;

    33 

    34 // Global configuration of logging. Handles parsing and configuration of the logging framework,

    35 // and manages the list of configured log outputs. The actual tag and level configuration is

    36 // kept implicitly in the LogTagSets and their LogOutputLists. During configuration the tagsets

    37 // are iterated over and updated accordingly.

    38 class LogConfiguration : public AllStatic {

    39  private:

    40   static LogOutput**  _outputs;

    41   static size_t       _n_outputs;

    42 

    43   // Create a new output. Returns NULL if failed.

    44   static LogOutput* new_output(char* name, const char* options = NULL);

    45 

    46   // Add an output to the list of configured outputs. Returns the assigned index.

    47   static size_t add_output(LogOutput* out);

    48 

    49   // Delete a configured output. The stderr/stdout outputs can not be removed.

    50   // Output should be completely disabled before it is deleted.

    51   static void delete_output(size_t idx);

    52 

    53   // Disable all logging to the specified output and then delete it (unless it is stdout/stderr).

    54   static void disable_output(size_t idx);

    55 

    56   // Get output index by name. Returns SIZE_MAX if output not found.

    57   static size_t find_output(const char* name);

    58 

    59   // Configure output (add or update existing configuration) to log on tag-level combination using specified decorators.

    60   static void configure_output(size_t idx, const LogTagLevelExpression& tag_level_expression, const LogDecorators& decorators);

    61 

    62  public:

    63   // Initialization and finalization of log configuration, to be run at vm startup and shutdown respectively.

    64   static void initialize(jlong vm_start_time);

    65   static void finalize();

    66 

    67   // Perform necessary post-initialization after VM startup. Enables reconfiguration of logging.

    68   static void post_initialize();

    69 

    70   // Disable all logging, equivalent to -Xlog:disable.

    71   static void disable_logging();

    72 

    73   // Parse command line configuration. Parameter 'opts' is the string immediately following the -Xlog: argument ("gc" for -Xlog:gc).

    74   static bool parse_command_line_arguments(const char* opts = "all");

    75 

    76   // Parse separated configuration arguments (from JCmd/MBean and command line).

    77   static bool parse_log_arguments(const char* outputstr,

    78                                   const char* what,

    79                                   const char* decoratorstr,

    80                                   const char* output_options,

    81                                   outputStream* errstream);

    82 

    83   // Prints log configuration to outputStream, used by JCmd/MBean.

    84   static void describe(outputStream* out);

    85 

    86   // Prints usage help for command line log configuration.

    87   static void print_command_line_help(FILE* out);

    88 };

    89 

    90 #endif // SHARE_VM_LOGGING_LOGCONFIGURATION_HPP