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 #include "memory/allocation.hpp"
27 #include "utilities/globalDefinitions.hpp"
28
29 class LogOutput;
30 class LogDecorators;
31 class LogTagLevelExpression;
32
33 // Global configuration of logging. Handles parsing and configuration of the logging framework,
34 // and manages the list of configured log outputs. The actual tag and level configuration is
35 // kept implicitly in the LogTagSets and their LogOutputLists. During configuration the tagsets
36 // are iterated over and updated accordingly.
37 class LogConfiguration : public AllStatic {
38 private:
39 static LogOutput** _outputs;
40 static size_t _n_outputs;
41
42 // Create a new output. Returns NULL if failed.
43 static LogOutput* new_output(char* name, const char* options = NULL);
44
45 // Add an output to the list of configured outputs. Returns the assigned index.
46 static size_t add_output(LogOutput* out);
47
48 // Delete a configured output. The stderr/stdout outputs can not be removed.
49 // Output should be completely disabled before it is deleted.
50 static void delete_output(size_t idx);
51
52 // Disable all logging to the specified output and then delete it (unless it is stdout/stderr).
53 static void disable_output(size_t idx);
54
55 // Get output index by name. Returns SIZE_MAX if output not found.
56 static size_t find_output(const char* name);
57
58 // Configure output (add or update existing configuration) to log on tag-level combination using specified decorators.
59 static void configure_output(size_t idx, const LogTagLevelExpression& tag_level_expression, const LogDecorators& decorators);
60
61 public:
62 // Initialization and finalization of log configuration, to be run at vm startup and shutdown respectively.
63 static void initialize(jlong vm_start_time);
64 static void finalize();
65
66 // Perform necessary post-initialization after VM startup. Enables reconfiguration of logging.
67 static void post_initialize();
68
69 // Disable all logging, equivalent to -Xlog:disable.
70 static void disable_logging();
71
72 // Parse command line configuration. Parameter 'opts' is the string immediately following the -Xlog: argument ("gc" for -Xlog:gc).
73 static bool parse_command_line_arguments(const char* opts = "all");
74
75 // Parse separated configuration arguments (from JCmd/MBean and command line).
76 static bool parse_log_arguments(const char* outputstr,
77 const char* what,
78 const char* decoratorstr,
79 const char* output_options,
80 outputStream* errstream);
81
82 // Prints log configuration to outputStream, used by JCmd/MBean.
83 static void describe(outputStream* out);
84
85 // Prints usage help for command line log configuration.
86 static void print_command_line_help(FILE* out);
87 };
88
89 #endif