hotspot/src/share/vm/runtime/osThread.hpp
author kvn
Fri, 12 Feb 2010 15:27:36 -0800
changeset 4898 b5bbb74def0b
parent 1 489c9b5090e2
child 5547 f4b087cbb361
permissions -rw-r--r--
Merge
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
// The OSThread class holds OS-specific thread information.  It is equivalent
489c9b5090e2 Initial load
duke
parents:
diff changeset
    26
// to the sys_thread_t structure of the classic JVM implementation.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    27
489c9b5090e2 Initial load
duke
parents:
diff changeset
    28
// The thread states represented by the ThreadState values are platform-specific
489c9b5090e2 Initial load
duke
parents:
diff changeset
    29
// and are likely to be only approximate, because most OSes don't give you access
489c9b5090e2 Initial load
duke
parents:
diff changeset
    30
// to precise thread state information.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    31
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
// Note: the ThreadState is legacy code and is not correctly implemented.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
// Uses of ThreadState need to be replaced by the state in the JavaThread.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
489c9b5090e2 Initial load
duke
parents:
diff changeset
    35
enum ThreadState {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
  ALLOCATED,                    // Memory has been allocated but not initialized
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
  INITIALIZED,                  // The thread has been initialized but yet started
489c9b5090e2 Initial load
duke
parents:
diff changeset
    38
  RUNNABLE,                     // Has been started and is runnable, but not necessarily running
489c9b5090e2 Initial load
duke
parents:
diff changeset
    39
  MONITOR_WAIT,                 // Waiting on a contended monitor lock
489c9b5090e2 Initial load
duke
parents:
diff changeset
    40
  CONDVAR_WAIT,                 // Waiting on a condition variable
489c9b5090e2 Initial load
duke
parents:
diff changeset
    41
  OBJECT_WAIT,                  // Waiting on an Object.wait() call
489c9b5090e2 Initial load
duke
parents:
diff changeset
    42
  BREAKPOINTED,                 // Suspended at breakpoint
489c9b5090e2 Initial load
duke
parents:
diff changeset
    43
  SLEEPING,                     // Thread.sleep()
489c9b5090e2 Initial load
duke
parents:
diff changeset
    44
  ZOMBIE                        // All done, but not reclaimed yet
489c9b5090e2 Initial load
duke
parents:
diff changeset
    45
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
    46
489c9b5090e2 Initial load
duke
parents:
diff changeset
    47
// I'd make OSThread a ValueObj embedded in Thread to avoid an indirection, but
489c9b5090e2 Initial load
duke
parents:
diff changeset
    48
// the assembler test in java.cpp expects that it can install the OSThread of
489c9b5090e2 Initial load
duke
parents:
diff changeset
    49
// the main thread into its own Thread at will.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    50
489c9b5090e2 Initial load
duke
parents:
diff changeset
    51
489c9b5090e2 Initial load
duke
parents:
diff changeset
    52
class OSThread: public CHeapObj {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    53
  friend class VMStructs;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    54
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    55
  //void* _start_proc;            // Thread start routine
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
  OSThreadStartFunc _start_proc;  // Thread start routine
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
  void* _start_parm;              // Thread start routine parameter
489c9b5090e2 Initial load
duke
parents:
diff changeset
    58
  volatile ThreadState _state;    // Thread state *hint*
489c9b5090e2 Initial load
duke
parents:
diff changeset
    59
  jint _interrupted;              // Thread.isInterrupted state
489c9b5090e2 Initial load
duke
parents:
diff changeset
    60
489c9b5090e2 Initial load
duke
parents:
diff changeset
    61
  // Note:  _interrupted must be jint, so that Java intrinsics can access it.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    62
  // The value stored there must be either 0 or 1.  It must be possible
489c9b5090e2 Initial load
duke
parents:
diff changeset
    63
  // for Java to emulate Thread.currentThread().isInterrupted() by performing
489c9b5090e2 Initial load
duke
parents:
diff changeset
    64
  // the double indirection Thread::current()->_osthread->_interrupted.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    65
489c9b5090e2 Initial load
duke
parents:
diff changeset
    66
  // Methods
489c9b5090e2 Initial load
duke
parents:
diff changeset
    67
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    68
  void set_state(ThreadState state)                { _state = state; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    69
  ThreadState get_state()                          { return _state; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    70
489c9b5090e2 Initial load
duke
parents:
diff changeset
    71
  // Constructor
489c9b5090e2 Initial load
duke
parents:
diff changeset
    72
  OSThread(OSThreadStartFunc start_proc, void* start_parm);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    73
489c9b5090e2 Initial load
duke
parents:
diff changeset
    74
  // Destructor
489c9b5090e2 Initial load
duke
parents:
diff changeset
    75
  ~OSThread();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    76
489c9b5090e2 Initial load
duke
parents:
diff changeset
    77
  // Accessors
489c9b5090e2 Initial load
duke
parents:
diff changeset
    78
  OSThreadStartFunc start_proc() const              { return _start_proc; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    79
  void set_start_proc(OSThreadStartFunc start_proc) { _start_proc = start_proc; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    80
  void* start_parm() const                          { return _start_parm; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    81
  void set_start_parm(void* start_parm)             { _start_parm = start_parm; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    82
489c9b5090e2 Initial load
duke
parents:
diff changeset
    83
  bool interrupted() const                          { return _interrupted != 0; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    84
  void set_interrupted(bool z)                      { _interrupted = z ? 1 : 0; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    85
489c9b5090e2 Initial load
duke
parents:
diff changeset
    86
  // Printing
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
  void print_on(outputStream* st) const;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
  void print() const                                { print_on(tty); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
  // For java intrinsics:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
  static ByteSize interrupted_offset()            { return byte_offset_of(OSThread, _interrupted); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
489c9b5090e2 Initial load
duke
parents:
diff changeset
    93
  // Platform dependent stuff
489c9b5090e2 Initial load
duke
parents:
diff changeset
    94
  #include "incls/_osThread_pd.hpp.incl"
489c9b5090e2 Initial load
duke
parents:
diff changeset
    95
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
    96
489c9b5090e2 Initial load
duke
parents:
diff changeset
    97
489c9b5090e2 Initial load
duke
parents:
diff changeset
    98
// Utility class for use with condition variables:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    99
class OSThreadWaitState : public StackObj {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   100
  OSThread*   _osthread;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   101
  ThreadState _old_state;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   102
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   103
  OSThreadWaitState(OSThread* osthread, bool is_object_wait) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   104
    _osthread  = osthread;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   105
    _old_state = osthread->get_state();
489c9b5090e2 Initial load
duke
parents:
diff changeset
   106
    if (is_object_wait) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   107
      osthread->set_state(OBJECT_WAIT);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   108
    } else {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   109
      osthread->set_state(CONDVAR_WAIT);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   110
    }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   111
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   112
  ~OSThreadWaitState() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   113
    _osthread->set_state(_old_state);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   114
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   115
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
   116
489c9b5090e2 Initial load
duke
parents:
diff changeset
   117
489c9b5090e2 Initial load
duke
parents:
diff changeset
   118
// Utility class for use with contended monitors:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   119
class OSThreadContendState : public StackObj {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   120
  OSThread*   _osthread;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   121
  ThreadState _old_state;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   122
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   123
  OSThreadContendState(OSThread* osthread) {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   124
    _osthread  = osthread;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   125
    _old_state = osthread->get_state();
489c9b5090e2 Initial load
duke
parents:
diff changeset
   126
    osthread->set_state(MONITOR_WAIT);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   127
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   128
  ~OSThreadContendState() {
489c9b5090e2 Initial load
duke
parents:
diff changeset
   129
    _osthread->set_state(_old_state);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   130
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   131
};