hotspot/src/share/vm/runtime/javaCalls.hpp
author poonam
Thu, 04 Dec 2008 17:29:56 -0800
changeset 1618 2d86b9b84aa5
parent 1 489c9b5090e2
child 1623 a0dd9009e992
permissions -rw-r--r--
6739363: Xcheck jni doesn't check native function arguments Summary: Fix adds support for verifying arguments with -Xcheck:jni. Reviewed-by: coleenp
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     1
/*
489c9b5090e2 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1997-2005 Sun Microsystems, Inc.  All Rights Reserved.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     4
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
489c9b5090e2 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
489c9b5090e2 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     8
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
489c9b5090e2 Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
489c9b5090e2 Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
489c9b5090e2 Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
489c9b5090e2 Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
489c9b5090e2 Initial load
duke
parents:
diff changeset
    14
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
489c9b5090e2 Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    18
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    19
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    20
 * CA 95054 USA or visit www.sun.com if you need additional information or
489c9b5090e2 Initial load
duke
parents:
diff changeset
    21
 * have any questions.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    22
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    23
 */
489c9b5090e2 Initial load
duke
parents:
diff changeset
    24
489c9b5090e2 Initial load
duke
parents:
diff changeset
    25
// A JavaCallWrapper is constructed before each JavaCall and destructed after the call.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    26
// Its purpose is to allocate/deallocate a new handle block and to save/restore the last
489c9b5090e2 Initial load
duke
parents:
diff changeset
    27
// Java fp/sp. A pointer to the JavaCallWrapper is stored on the stack.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    28
489c9b5090e2 Initial load
duke
parents:
diff changeset
    29
class JavaCallWrapper: StackObj {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    30
  friend class VMStructs;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    31
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
  JavaThread*      _thread;                 // the thread to which this call belongs
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
  JNIHandleBlock*  _handles;                // the saved handle block
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
  methodOop        _callee_method;          // to be able to collect arguments if entry frame is top frame
489c9b5090e2 Initial load
duke
parents:
diff changeset
    35
  oop              _receiver;               // the receiver of the call (if a non-static call)
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
  JavaFrameAnchor  _anchor;                 // last thread anchor state that we must restore
489c9b5090e2 Initial load
duke
parents:
diff changeset
    38
489c9b5090e2 Initial load
duke
parents:
diff changeset
    39
  JavaValue*       _result;                 // result value
489c9b5090e2 Initial load
duke
parents:
diff changeset
    40
489c9b5090e2 Initial load
duke
parents:
diff changeset
    41
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    42
  // Construction/destruction
489c9b5090e2 Initial load
duke
parents:
diff changeset
    43
   JavaCallWrapper(methodHandle callee_method, Handle receiver, JavaValue* result, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    44
  ~JavaCallWrapper();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    45
489c9b5090e2 Initial load
duke
parents:
diff changeset
    46
  // Accessors
489c9b5090e2 Initial load
duke
parents:
diff changeset
    47
  JavaThread*      thread() const           { return _thread; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    48
  JNIHandleBlock*  handles() const          { return _handles; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    49
489c9b5090e2 Initial load
duke
parents:
diff changeset
    50
  JavaFrameAnchor* anchor(void)             { return &_anchor; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    51
489c9b5090e2 Initial load
duke
parents:
diff changeset
    52
  JavaValue*       result() const           { return _result; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    53
  // GC support
489c9b5090e2 Initial load
duke
parents:
diff changeset
    54
  methodOop        callee_method()          { return _callee_method; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    55
  oop              receiver()               { return _receiver; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
  void             oops_do(OopClosure* f);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
489c9b5090e2 Initial load
duke
parents:
diff changeset
    58
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
    59
489c9b5090e2 Initial load
duke
parents:
diff changeset
    60
489c9b5090e2 Initial load
duke
parents:
diff changeset
    61
// Encapsulates arguments to a JavaCall (faster, safer, and more convenient than using var-args)
489c9b5090e2 Initial load
duke
parents:
diff changeset
    62
class JavaCallArguments : public StackObj {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    63
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    64
  enum Constants {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    65
   _default_size = 8    // Must be at least # of arguments in JavaCalls methods
489c9b5090e2 Initial load
duke
parents:
diff changeset
    66
  };
489c9b5090e2 Initial load
duke
parents:
diff changeset
    67
489c9b5090e2 Initial load
duke
parents:
diff changeset
    68
  intptr_t    _value_buffer [_default_size + 1];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    69
  intptr_t    _parameter_buffer [_default_size*2 + 1];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    70
  bool        _is_oop_buffer[_default_size + 1];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    71
489c9b5090e2 Initial load
duke
parents:
diff changeset
    72
  intptr_t*   _value;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    73
  intptr_t*   _parameters;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    74
  bool*       _is_oop;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    75
  int         _size;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    76
  int         _max_size;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    77
  bool        _start_at_zero;      // Support late setting of receiver
489c9b5090e2 Initial load
duke
parents:
diff changeset
    78
489c9b5090e2 Initial load
duke
parents:
diff changeset
    79
  void initialize() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    80
    // Starts at first element to support set_receiver.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    81
    _value    = &_value_buffer[1];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    82
    _is_oop   = &_is_oop_buffer[1];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    83
489c9b5090e2 Initial load
duke
parents:
diff changeset
    84
    _parameters = &_parameter_buffer[0];
489c9b5090e2 Initial load
duke
parents:
diff changeset
    85
    _max_size = _default_size;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    86
    _size = 0;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
    _start_at_zero = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
  JavaCallArguments() { initialize(); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
489c9b5090e2 Initial load
duke
parents:
diff changeset
    93
  JavaCallArguments(Handle receiver) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    94
    initialize();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    95
    push_oop(receiver);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    96
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    97
489c9b5090e2 Initial load
duke
parents:
diff changeset
    98
  JavaCallArguments(int max_size) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    99
    if (max_size > _default_size) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   100
      _value  = NEW_RESOURCE_ARRAY(intptr_t, max_size + 1);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   101
      _is_oop = NEW_RESOURCE_ARRAY(bool, max_size + 1);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   102
      if (TaggedStackInterpreter) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   103
        _parameters  = NEW_RESOURCE_ARRAY(intptr_t, max_size*2 + 1);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   104
      }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   105
      // Reserve room for potential receiver in value and is_oop
489c9b5090e2 Initial load
duke
parents:
diff changeset
   106
      _value++; _is_oop++;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   107
      _max_size = max_size;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   108
      _size = 0;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   109
      _start_at_zero = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   110
    } else {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   111
      initialize();
489c9b5090e2 Initial load
duke
parents:
diff changeset
   112
    }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   113
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   114
489c9b5090e2 Initial load
duke
parents:
diff changeset
   115
  inline void push_oop(Handle h)    { _is_oop[_size] = true;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   116
                               JNITypes::put_obj((oop)h.raw_value(), _value, _size); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   117
489c9b5090e2 Initial load
duke
parents:
diff changeset
   118
  inline void push_int(int i)       { _is_oop[_size] = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   119
                               JNITypes::put_int(i, _value, _size); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   120
489c9b5090e2 Initial load
duke
parents:
diff changeset
   121
  inline void push_double(double d) { _is_oop[_size] = false; _is_oop[_size + 1] = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   122
                               JNITypes::put_double(d, _value, _size); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   123
489c9b5090e2 Initial load
duke
parents:
diff changeset
   124
  inline void push_long(jlong l)    { _is_oop[_size] = false; _is_oop[_size + 1] = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   125
                               JNITypes::put_long(l, _value, _size); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   126
489c9b5090e2 Initial load
duke
parents:
diff changeset
   127
  inline void push_float(float f)   { _is_oop[_size] = false;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   128
                               JNITypes::put_float(f, _value, _size); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   129
489c9b5090e2 Initial load
duke
parents:
diff changeset
   130
  // receiver
489c9b5090e2 Initial load
duke
parents:
diff changeset
   131
  Handle receiver() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   132
    assert(_size > 0, "must at least be one argument");
489c9b5090e2 Initial load
duke
parents:
diff changeset
   133
    assert(_is_oop[0], "first argument must be an oop");
489c9b5090e2 Initial load
duke
parents:
diff changeset
   134
    assert(_value[0] != 0, "receiver must be not-null");
489c9b5090e2 Initial load
duke
parents:
diff changeset
   135
    return Handle((oop*)_value[0], false);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   136
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   137
489c9b5090e2 Initial load
duke
parents:
diff changeset
   138
  void set_receiver(Handle h) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   139
    assert(_start_at_zero == false, "can only be called once");
489c9b5090e2 Initial load
duke
parents:
diff changeset
   140
    _start_at_zero = true;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   141
    _is_oop--;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   142
    _value--;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   143
    _size++;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   144
    _is_oop[0] = true;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   145
    _value[0] = (intptr_t)h.raw_value();
489c9b5090e2 Initial load
duke
parents:
diff changeset
   146
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   147
489c9b5090e2 Initial load
duke
parents:
diff changeset
   148
  // Converts all Handles to oops, and returns a reference to parameter vector
489c9b5090e2 Initial load
duke
parents:
diff changeset
   149
  intptr_t* parameters() ;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   150
  int   size_of_parameters() const { return _size; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   151
489c9b5090e2 Initial load
duke
parents:
diff changeset
   152
  // Verify that pushed arguments fits a given method
1618
2d86b9b84aa5 6739363: Xcheck jni doesn't check native function arguments
poonam
parents: 1
diff changeset
   153
  void verify(methodHandle method, BasicType return_type, Thread *thread);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   154
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
   155
489c9b5090e2 Initial load
duke
parents:
diff changeset
   156
// All calls to Java have to go via JavaCalls. Sets up the stack frame
489c9b5090e2 Initial load
duke
parents:
diff changeset
   157
// and makes sure that the last_Java_frame pointers are chained correctly.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   158
//
489c9b5090e2 Initial load
duke
parents:
diff changeset
   159
489c9b5090e2 Initial load
duke
parents:
diff changeset
   160
class JavaCalls: AllStatic {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   161
  static void call_helper(JavaValue* result, methodHandle* method, JavaCallArguments* args, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   162
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   163
  // Optimized Constuctor call
489c9b5090e2 Initial load
duke
parents:
diff changeset
   164
  static void call_default_constructor(JavaThread* thread, methodHandle method, Handle receiver, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   165
489c9b5090e2 Initial load
duke
parents:
diff changeset
   166
  // call_special
489c9b5090e2 Initial load
duke
parents:
diff changeset
   167
  // ------------
489c9b5090e2 Initial load
duke
parents:
diff changeset
   168
  // The receiver must be first oop in argument list
489c9b5090e2 Initial load
duke
parents:
diff changeset
   169
  static void call_special(JavaValue* result, KlassHandle klass, symbolHandle name, symbolHandle signature, JavaCallArguments* args, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   170
489c9b5090e2 Initial load
duke
parents:
diff changeset
   171
  static void call_special(JavaValue* result, Handle receiver, KlassHandle klass, symbolHandle name, symbolHandle signature, TRAPS); // No args
489c9b5090e2 Initial load
duke
parents:
diff changeset
   172
  static void call_special(JavaValue* result, Handle receiver, KlassHandle klass, symbolHandle name, symbolHandle signature, Handle arg1, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   173
  static void call_special(JavaValue* result, Handle receiver, KlassHandle klass, symbolHandle name, symbolHandle signature, Handle arg1, Handle arg2, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   174
489c9b5090e2 Initial load
duke
parents:
diff changeset
   175
  // virtual call
489c9b5090e2 Initial load
duke
parents:
diff changeset
   176
  // ------------
489c9b5090e2 Initial load
duke
parents:
diff changeset
   177
489c9b5090e2 Initial load
duke
parents:
diff changeset
   178
  // The receiver must be first oop in argument list
489c9b5090e2 Initial load
duke
parents:
diff changeset
   179
  static void call_virtual(JavaValue* result, KlassHandle spec_klass, symbolHandle name, symbolHandle signature, JavaCallArguments* args, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   180
489c9b5090e2 Initial load
duke
parents:
diff changeset
   181
  static void call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, symbolHandle name, symbolHandle signature, TRAPS); // No args
489c9b5090e2 Initial load
duke
parents:
diff changeset
   182
  static void call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, symbolHandle name, symbolHandle signature, Handle arg1, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   183
  static void call_virtual(JavaValue* result, Handle receiver, KlassHandle spec_klass, symbolHandle name, symbolHandle signature, Handle arg1, Handle arg2, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   184
489c9b5090e2 Initial load
duke
parents:
diff changeset
   185
  // Static call
489c9b5090e2 Initial load
duke
parents:
diff changeset
   186
  // -----------
489c9b5090e2 Initial load
duke
parents:
diff changeset
   187
  static void call_static(JavaValue* result, KlassHandle klass, symbolHandle name, symbolHandle signature, JavaCallArguments* args, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   188
489c9b5090e2 Initial load
duke
parents:
diff changeset
   189
  static void call_static(JavaValue* result, KlassHandle klass, symbolHandle name, symbolHandle signature, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   190
  static void call_static(JavaValue* result, KlassHandle klass, symbolHandle name, symbolHandle signature, Handle arg1, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   191
  static void call_static(JavaValue* result, KlassHandle klass, symbolHandle name, symbolHandle signature, Handle arg1, Handle arg2, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   192
489c9b5090e2 Initial load
duke
parents:
diff changeset
   193
  // Low-level interface
489c9b5090e2 Initial load
duke
parents:
diff changeset
   194
  static void call(JavaValue* result, methodHandle method, JavaCallArguments* args, TRAPS);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   195
};