1 /*
2  * Copyright (c) 1997, 2019, 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 
25 #ifndef SHARE_CODE_PCDESC_HPP
26 #define SHARE_CODE_PCDESC_HPP
27 
28 
29 // PcDescs map a physical PC (given as offset from start of nmethod) to
30 // the corresponding source scope and byte code index.
31 
32 class CompiledMethod;
33 
34 class PcDesc {
35   friend class VMStructs;
36  private:
37   int _pc_offset;           // offset from start of nmethod
38   int _scope_decode_offset; // offset for scope in nmethod
39   int _obj_decode_offset;
40 
41   enum {
42     PCDESC_reexecute               = 1 << 0,
43     PCDESC_is_method_handle_invoke = 1 << 1,
44     PCDESC_return_oop              = 1 << 2,
45     PCDESC_rethrow_exception       = 1 << 3
46   };
47 
48   int _flags;
49 
set_flag(int mask,bool z)50   void set_flag(int mask, bool z) {
51     _flags = z ? (_flags | mask) : (_flags & ~mask);
52   }
53 
54  public:
pc_offset() const55   int pc_offset() const           { return _pc_offset;   }
scope_decode_offset() const56   int scope_decode_offset() const { return _scope_decode_offset; }
obj_decode_offset() const57   int obj_decode_offset() const   { return _obj_decode_offset; }
58 
set_pc_offset(int x)59   void set_pc_offset(int x)           { _pc_offset           = x; }
set_scope_decode_offset(int x)60   void set_scope_decode_offset(int x) { _scope_decode_offset = x; }
set_obj_decode_offset(int x)61   void set_obj_decode_offset(int x)   { _obj_decode_offset   = x; }
62 
63   // Constructor (only used for static in nmethod.cpp)
64   // Also used by ScopeDesc::sender()]
65   PcDesc(int pc_offset, int scope_decode_offset, int obj_decode_offset);
66 
67   enum {
68     // upper and lower exclusive limits real offsets:
69     lower_offset_limit = -1,
70     upper_offset_limit = (unsigned int)-1 >> 1
71   };
72 
73   // Flags
rethrow_exception() const74   bool     rethrow_exception()              const { return (_flags & PCDESC_rethrow_exception) != 0; }
set_rethrow_exception(bool z)75   void set_rethrow_exception(bool z)              { set_flag(PCDESC_rethrow_exception, z); }
should_reexecute() const76   bool     should_reexecute()              const { return (_flags & PCDESC_reexecute) != 0; }
set_should_reexecute(bool z)77   void set_should_reexecute(bool z)              { set_flag(PCDESC_reexecute, z); }
78 
79   // Does pd refer to the same information as pd?
is_same_info(const PcDesc * pd)80   bool is_same_info(const PcDesc* pd) {
81     return _scope_decode_offset == pd->_scope_decode_offset &&
82       _obj_decode_offset == pd->_obj_decode_offset &&
83       _flags == pd->_flags;
84   }
85 
is_method_handle_invoke() const86   bool     is_method_handle_invoke()       const { return (_flags & PCDESC_is_method_handle_invoke) != 0;     }
set_is_method_handle_invoke(bool z)87   void set_is_method_handle_invoke(bool z)       { set_flag(PCDESC_is_method_handle_invoke, z); }
88 
return_oop() const89   bool     return_oop()                    const { return (_flags & PCDESC_return_oop) != 0;     }
set_return_oop(bool z)90   void set_return_oop(bool z)                    { set_flag(PCDESC_return_oop, z); }
91 
92   // Returns the real pc
93   address real_pc(const CompiledMethod* code) const;
94 
print(CompiledMethod * code)95   void print(CompiledMethod* code) { print_on(tty, code); }
96   void print_on(outputStream* st, CompiledMethod* code);
97   bool verify(CompiledMethod* code);
98 };
99 
100 #endif // SHARE_CODE_PCDESC_HPP
101