src/threads/native/lock.h

   1 /* src/threads/native/lock.h - lock implementation
   2
   3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Stefan Ring
  28
  29    Changes: Christian Thalinger
  30                         Edwin Steiner
  31
  32    $Id: threads.h 4866 2006-05-01 21:40:38Z edwin $
  33
  34 */
  35
  36 #ifndef _LOCK_H
  37 #define _LOCK_H
  38
  39 #include "config.h"
  40 #include "vm/types.h"
  41 #include "vm/global.h"
  42
  43
  44 /* typedefs *******************************************************************/
  45
  46 typedef struct lock_execution_env_t      lock_execution_env_t;
  47 typedef struct lock_record_t             lock_record_t;
  48 typedef struct lock_record_pool_header_t lock_record_pool_header_t;
  49 typedef struct lock_record_pool_t        lock_record_pool_t;
  50 typedef struct lock_waiter_t             lock_waiter_t;
  51
  52
  53 /* lock_execution_env_t ********************************************************
  54
  55    Execution environment. Contains the lock record freelist and pools.
  56
  57 *******************************************************************************/
  58
  59 struct lock_execution_env_t {
  60         lock_record_t         *firstfree;        /* lock record freelist          */
  61         lock_record_pool_t    *lockrecordpools;  /* list of per-thread pools      */
  62         int                    lockrecordcount;  /* # of records for this thread  */
  63 };
  64
  65
  66 /* lock_waiter_t ***************************************************************
  67
  68    List node for storing a waiting thread.
  69
  70 *******************************************************************************/
  71
  72 struct lock_waiter_t {
  73         struct threadobject *waiter;         /* the waiting thread                */
  74         lock_waiter_t       *next;           /* next in list                      */
  75 };
  76
  77
  78 /* lock_record_t ***************************************************************
  79
  80    Lock record struct representing an inflated ("fat") lock.
  81
  82 *******************************************************************************/
  83
  84 struct lock_record_t {
  85         struct threadobject *owner;              /* current owner of this monitor */
  86         s4                   count;              /* recursive lock count          */
  87         pthread_mutex_t      mutex;              /* mutex for synchronizing       */
  88         lock_waiter_t       *waiters;            /* list of threads waiting       */
  89         lock_record_t       *nextfree;           /* next in free list             */
  90 };
  91
  92
  93 /* lock_record_pool_header_t ***************************************************
  94
  95    Lock records are allocated in pools. Each pool has on of these headers.
  96
  97 *******************************************************************************/
  98
  99 struct lock_record_pool_header_t {
 100         lock_record_pool_t *next;                /* next pool                     */
 101         int                 size;                /* records in this pool          */
 102 };
 103
 104
 105 /* lock_record_pool_t **********************************************************
 106
 107    Lock records are allocated in such pools.
 108
 109 *******************************************************************************/
 110
 111 struct lock_record_pool_t {
 112         lock_record_pool_header_t header;        /* pool header (see above)       */
 113         lock_record_t             lr[1];         /* variable array of records     */
 114 };
 115
 116
 117 /* functions ******************************************************************/
 118
 119 void lock_init(void);
 120
 121 void lock_init_execution_env(struct threadobject *thread);
 122 void lock_record_free_pools(lock_record_pool_t *pool);
 123
 124 void lock_init_object_lock(java_objectheader *);
 125 lock_record_t *lock_get_initial_lock_word(void);
 126
 127 ptrint lock_pre_compute_thinlock(s4 index);
 128
 129 void lock_monitor_enter(struct threadobject *, java_objectheader *);
 130 bool lock_monitor_exit(struct threadobject *, java_objectheader *);
 131
 132 bool lock_is_held_by_current_thread(java_objectheader *o);
 133
 134 void lock_wait_for_object(java_objectheader *o, s8 millis, s4 nanos);
 135 void lock_notify_object(java_objectheader *o);
 136 void lock_notify_all_object(java_objectheader *o);
 137
 138 #endif /* _LOCK_H */
 139
 140
 141 /*
 142  * These are local overrides for various environment variables in Emacs.
 143  * Please do not remove this and leave it at the end of the file, where
 144  * Emacs will automagically detect them.
 145  * ---------------------------------------------------------------------
 146  * Local variables:
 147  * mode: c
 148  * indent-tabs-mode: t
 149  * c-basic-offset: 4
 150  * tab-width: 4
 151  * End:
 152  * vim:noexpandtab:sw=4:ts=4:
 153  */