xref: /aosp_15_r20/art/openjdkjvmti/ti_logging.h (revision 795d594fd825385562da6b089ea9b2033f3abf5a)
1*795d594fSAndroid Build Coastguard Worker /* Copyright (C) 2018 The Android Open Source Project
2*795d594fSAndroid Build Coastguard Worker  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3*795d594fSAndroid Build Coastguard Worker  *
4*795d594fSAndroid Build Coastguard Worker  * This file implements interfaces from the file jvmti.h. This implementation
5*795d594fSAndroid Build Coastguard Worker  * is licensed under the same terms as the file jvmti.h.  The
6*795d594fSAndroid Build Coastguard Worker  * copyright and license information for the file jvmti.h follows.
7*795d594fSAndroid Build Coastguard Worker  *
8*795d594fSAndroid Build Coastguard Worker  * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
9*795d594fSAndroid Build Coastguard Worker  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
10*795d594fSAndroid Build Coastguard Worker  *
11*795d594fSAndroid Build Coastguard Worker  * This code is free software; you can redistribute it and/or modify it
12*795d594fSAndroid Build Coastguard Worker  * under the terms of the GNU General Public License version 2 only, as
13*795d594fSAndroid Build Coastguard Worker  * published by the Free Software Foundation.  Oracle designates this
14*795d594fSAndroid Build Coastguard Worker  * particular file as subject to the "Classpath" exception as provided
15*795d594fSAndroid Build Coastguard Worker  * by Oracle in the LICENSE file that accompanied this code.
16*795d594fSAndroid Build Coastguard Worker  *
17*795d594fSAndroid Build Coastguard Worker  * This code is distributed in the hope that it will be useful, but WITHOUT
18*795d594fSAndroid Build Coastguard Worker  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19*795d594fSAndroid Build Coastguard Worker  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
20*795d594fSAndroid Build Coastguard Worker  * version 2 for more details (a copy is included in the LICENSE file that
21*795d594fSAndroid Build Coastguard Worker  * accompanied this code).
22*795d594fSAndroid Build Coastguard Worker  *
23*795d594fSAndroid Build Coastguard Worker  * You should have received a copy of the GNU General Public License version
24*795d594fSAndroid Build Coastguard Worker  * 2 along with this work; if not, write to the Free Software Foundation,
25*795d594fSAndroid Build Coastguard Worker  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26*795d594fSAndroid Build Coastguard Worker  *
27*795d594fSAndroid Build Coastguard Worker  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
28*795d594fSAndroid Build Coastguard Worker  * or visit www.oracle.com if you need additional information or have any
29*795d594fSAndroid Build Coastguard Worker  * questions.
30*795d594fSAndroid Build Coastguard Worker  */
31*795d594fSAndroid Build Coastguard Worker 
32*795d594fSAndroid Build Coastguard Worker #ifndef ART_OPENJDKJVMTI_TI_LOGGING_H_
33*795d594fSAndroid Build Coastguard Worker #define ART_OPENJDKJVMTI_TI_LOGGING_H_
34*795d594fSAndroid Build Coastguard Worker 
35*795d594fSAndroid Build Coastguard Worker #include "art_jvmti.h"
36*795d594fSAndroid Build Coastguard Worker 
37*795d594fSAndroid Build Coastguard Worker #include <ostream>
38*795d594fSAndroid Build Coastguard Worker #include <sstream>
39*795d594fSAndroid Build Coastguard Worker 
40*795d594fSAndroid Build Coastguard Worker #include <android-base/logging.h>
41*795d594fSAndroid Build Coastguard Worker #include <android-base/macros.h>
42*795d594fSAndroid Build Coastguard Worker 
43*795d594fSAndroid Build Coastguard Worker #include "base/mutex.h"
44*795d594fSAndroid Build Coastguard Worker #include "thread-current-inl.h"
45*795d594fSAndroid Build Coastguard Worker 
46*795d594fSAndroid Build Coastguard Worker namespace openjdkjvmti {
47*795d594fSAndroid Build Coastguard Worker 
48*795d594fSAndroid Build Coastguard Worker // NB Uses implementation details of android-base/logging.h.
49*795d594fSAndroid Build Coastguard Worker #define JVMTI_LOG(severity, env)                             \
50*795d594fSAndroid Build Coastguard Worker   ::openjdkjvmti::JvmtiLogMessage((env),                     \
51*795d594fSAndroid Build Coastguard Worker                                   __FILE__,                  \
52*795d594fSAndroid Build Coastguard Worker                                   __LINE__,                  \
53*795d594fSAndroid Build Coastguard Worker                                   SEVERITY_LAMBDA(severity), \
54*795d594fSAndroid Build Coastguard Worker                                   _LOG_TAG_INTERNAL,         \
55*795d594fSAndroid Build Coastguard Worker                                   -1)
56*795d594fSAndroid Build Coastguard Worker 
57*795d594fSAndroid Build Coastguard Worker class JvmtiLogMessage {
58*795d594fSAndroid Build Coastguard Worker  public:
JvmtiLogMessage(jvmtiEnv * env,const char * file,unsigned int line,android::base::LogSeverity severity,const char * tag,int error)59*795d594fSAndroid Build Coastguard Worker   JvmtiLogMessage(jvmtiEnv* env,
60*795d594fSAndroid Build Coastguard Worker                   const char* file,
61*795d594fSAndroid Build Coastguard Worker                   unsigned int line,
62*795d594fSAndroid Build Coastguard Worker                   android::base::LogSeverity severity,
63*795d594fSAndroid Build Coastguard Worker                   const char* tag,
64*795d594fSAndroid Build Coastguard Worker                   int error)
65*795d594fSAndroid Build Coastguard Worker       : env_(ArtJvmTiEnv::AsArtJvmTiEnv(env)),
66*795d594fSAndroid Build Coastguard Worker         real_log_(file, line, severity, tag, error),
67*795d594fSAndroid Build Coastguard Worker         real_log_stream_(real_log_.stream()) {
68*795d594fSAndroid Build Coastguard Worker     DCHECK(env_ != nullptr);
69*795d594fSAndroid Build Coastguard Worker   }
70*795d594fSAndroid Build Coastguard Worker 
~JvmtiLogMessage()71*795d594fSAndroid Build Coastguard Worker   ~JvmtiLogMessage() {
72*795d594fSAndroid Build Coastguard Worker     art::MutexLock mu(art::Thread::Current(), env_->last_error_mutex_);
73*795d594fSAndroid Build Coastguard Worker     env_->last_error_ = save_stream_.str();
74*795d594fSAndroid Build Coastguard Worker   }
75*795d594fSAndroid Build Coastguard Worker 
76*795d594fSAndroid Build Coastguard Worker   template<typename T>
77*795d594fSAndroid Build Coastguard Worker   JvmtiLogMessage& operator<<(T t) {
78*795d594fSAndroid Build Coastguard Worker     (real_log_stream_ << t);
79*795d594fSAndroid Build Coastguard Worker     (save_stream_ << t);
80*795d594fSAndroid Build Coastguard Worker     return *this;
81*795d594fSAndroid Build Coastguard Worker   }
82*795d594fSAndroid Build Coastguard Worker 
83*795d594fSAndroid Build Coastguard Worker  private:
84*795d594fSAndroid Build Coastguard Worker   ArtJvmTiEnv* env_;
85*795d594fSAndroid Build Coastguard Worker   android::base::LogMessage real_log_;
86*795d594fSAndroid Build Coastguard Worker   // Lifetime of real_log_stream_ is lifetime of real_log_.
87*795d594fSAndroid Build Coastguard Worker   std::ostream& real_log_stream_;
88*795d594fSAndroid Build Coastguard Worker   std::ostringstream save_stream_;
89*795d594fSAndroid Build Coastguard Worker 
90*795d594fSAndroid Build Coastguard Worker   DISALLOW_COPY_AND_ASSIGN(JvmtiLogMessage);
91*795d594fSAndroid Build Coastguard Worker };
92*795d594fSAndroid Build Coastguard Worker 
93*795d594fSAndroid Build Coastguard Worker class LogUtil {
94*795d594fSAndroid Build Coastguard Worker  public:
95*795d594fSAndroid Build Coastguard Worker   static jvmtiError ClearLastError(jvmtiEnv* env);
96*795d594fSAndroid Build Coastguard Worker   static jvmtiError GetLastError(jvmtiEnv* env, char** data);
97*795d594fSAndroid Build Coastguard Worker 
98*795d594fSAndroid Build Coastguard Worker   static jvmtiError SetVerboseFlag(jvmtiEnv* env, jvmtiVerboseFlag flag, jboolean value);
99*795d594fSAndroid Build Coastguard Worker   static jvmtiError SetVerboseFlagExt(jvmtiEnv* env, const char* data, jboolean enable);
100*795d594fSAndroid Build Coastguard Worker };
101*795d594fSAndroid Build Coastguard Worker 
102*795d594fSAndroid Build Coastguard Worker }  // namespace openjdkjvmti
103*795d594fSAndroid Build Coastguard Worker 
104*795d594fSAndroid Build Coastguard Worker #endif  // ART_OPENJDKJVMTI_TI_LOGGING_H_
105