← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to include/thr_lock.h

  • Committer: Brian Aker
  • Date: 2008-07-20 05:41:52 UTC
  • Revision ID: brian@tangent.org-20080720054152-5laf6plsb0o7h6ss
Documentation cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/thr_lock.h
11
11
 
12
12
   You should have received a copy of the GNU General Public License
13
13
   along with this program; if not, write to the Free Software
14
 
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA */
15
 
 
16
 
/* For use with thr_locks */
17
 
 
18
 
#ifndef DRIZZLED_THR_LOCK_H
19
 
#define DRIZZLED_THR_LOCK_H
20
 
 
21
 
#include <boost/thread/mutex.hpp>
22
 
#include <boost/thread/shared_mutex.hpp>
23
 
#include <boost/thread/condition_variable.hpp>
24
 
 
25
 
namespace drizzled
26
 
{
27
 
 
28
 
extern uint64_t max_write_lock_count;
29
 
extern uint64_t table_lock_wait_timeout;
30
 
 
 
14
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
15
 
 
16
/* For use with thr_lock:s */
 
17
 
 
18
#ifndef _thr_lock_h
 
19
#define _thr_lock_h
 
20
#ifdef  __cplusplus
 
21
extern "C" {
 
22
#endif
 
23
 
 
24
#include <my_pthread.h>
 
25
#include <my_list.h>
 
26
 
 
27
struct st_thr_lock;
 
28
extern ulong locks_immediate,locks_waited ;
 
29
extern pthread_mutex_t THR_LOCK_lock;
31
30
 
32
31
enum thr_lock_type { TL_IGNORE=-1,
33
 
                     /* UNLOCK ANY LOCK */
34
 
                     TL_UNLOCK,
35
 
                     /* Read lock */
36
 
                     TL_READ,
37
 
                     TL_READ_WITH_SHARED_LOCKS,
38
 
                     /* READ, Don't allow concurrent insert */
39
 
                     TL_READ_NO_INSERT,
40
 
                     /*
41
 
                       Write lock, but allow other threads to read / write.
42
 
                       Used by BDB tables in MySQL to mark that someone is
43
 
                       reading/writing to the table.
44
 
                     */
45
 
                     TL_WRITE_ALLOW_WRITE,
46
 
                     /*
47
 
                       Write lock, but allow other threads to read.
48
 
                       Used by ALTER TABLE in MySQL to allow readers
49
 
                       to use the table until ALTER TABLE is finished.
50
 
                     */
51
 
                     TL_WRITE_ALLOW_READ,
52
 
                     /*
53
 
                       WRITE lock used by concurrent insert. Will allow
54
 
                       READ, if one could use concurrent insert on table.
55
 
                     */
56
 
                     TL_WRITE_CONCURRENT_INSERT,
57
 
                     /*
58
 
                       parser only! Late bound low_priority flag.
 
32
                     TL_UNLOCK,                 /* UNLOCK ANY LOCK */
 
33
                     TL_READ,                   /* Read lock */
 
34
                     TL_READ_WITH_SHARED_LOCKS,
 
35
                     /* High prior. than TL_WRITE. Allow concurrent insert */
 
36
                     TL_READ_HIGH_PRIORITY,
 
37
                     /* READ, Don't allow concurrent insert */
 
38
                     TL_READ_NO_INSERT,
 
39
                     /* 
 
40
                        Write lock, but allow other threads to read / write.
 
41
                        Used by BDB tables in MySQL to mark that someone is
 
42
                        reading/writing to the table.
 
43
                      */
 
44
                     TL_WRITE_ALLOW_WRITE,
 
45
                     /*
 
46
                        Write lock, but allow other threads to read.
 
47
                        Used by ALTER TABLE in MySQL to allow readers
 
48
                        to use the table until ALTER TABLE is finished.
 
49
                     */
 
50
                     TL_WRITE_ALLOW_READ,
 
51
                     /*
 
52
                       WRITE lock used by concurrent insert. Will allow
 
53
                       READ, if one could use concurrent insert on table.
 
54
                     */
 
55
                     TL_WRITE_CONCURRENT_INSERT,
 
56
                     /* Write used by INSERT DELAYED.  Allows READ locks */
 
57
                     TL_WRITE_DELAYED,
 
58
                     /* 
 
59
                       parser only! Late bound low_priority flag. 
59
60
                       At open_tables() becomes thd->update_lock_default.
60
61
                     */
61
62
                     TL_WRITE_DEFAULT,
62
 
                     /* Normal WRITE lock */
63
 
                     TL_WRITE,
64
 
                     /* Abort new lock request with an error */
65
 
                     TL_WRITE_ONLY};
 
63
                     /* WRITE lock that has lower priority than TL_READ */
 
64
                     TL_WRITE_LOW_PRIORITY,
 
65
                     /* Normal WRITE lock */
 
66
                     TL_WRITE,
 
67
                     /* Abort new lock request with an error */
 
68
                     TL_WRITE_ONLY};
66
69
 
67
70
enum enum_thr_lock_result { THR_LOCK_SUCCESS= 0, THR_LOCK_ABORTED= 1,
68
71
                            THR_LOCK_WAIT_TIMEOUT= 2, THR_LOCK_DEADLOCK= 3 };
 
72
 
 
73
 
 
74
extern ulong max_write_lock_count;
 
75
extern ulong table_lock_wait_timeout;
 
76
extern bool thr_lock_inited;
 
77
extern enum thr_lock_type thr_upgraded_concurrent_insert_lock;
 
78
 
69
79
/*
70
80
  A description of the thread which owns the lock. The address
71
81
  of an instance of this structure is used to uniquely identify the thread.
72
82
*/
73
83
 
74
 
struct THR_LOCK_INFO
 
84
typedef struct st_thr_lock_info
75
85
{
76
 
  uint64_t thread_id;
77
 
  uint32_t n_cursors;
78
 
 
79
 
  THR_LOCK_INFO() : 
80
 
    thread_id(0),
81
 
    n_cursors(0)
82
 
  { }
83
 
 
84
 
  void init();
85
 
 
86
 
};
 
86
  pthread_t thread;
 
87
  my_thread_id thread_id;
 
88
  ulong n_cursors;
 
89
} THR_LOCK_INFO;
87
90
 
88
91
/*
89
92
  Lock owner identifier. Globally identifies the lock owner within the
91
94
  structure is used as id.
92
95
*/
93
96
 
94
 
struct THR_LOCK_OWNER
 
97
typedef struct st_thr_lock_owner
95
98
{
96
99
  THR_LOCK_INFO *info;
97
 
 
98
 
  THR_LOCK_OWNER() :
99
 
    info(0)
100
 
  { }
101
 
 
102
 
};
103
 
 
104
 
struct THR_LOCK;
105
 
struct THR_LOCK_DATA;
106
 
 
107
 
struct THR_LOCK_DATA {
 
100
} THR_LOCK_OWNER;
 
101
 
 
102
 
 
103
typedef struct st_thr_lock_data {
108
104
  THR_LOCK_OWNER *owner;
109
 
  struct THR_LOCK_DATA *next,**prev;
110
 
  struct THR_LOCK *lock;
111
 
  boost::condition_variable_any *cond;
 
105
  struct st_thr_lock_data *next,**prev;
 
106
  struct st_thr_lock *lock;
 
107
  pthread_cond_t *cond;
112
108
  enum thr_lock_type type;
113
109
  void *status_param;                   /* Param to status functions */
114
 
 
115
 
  THR_LOCK_DATA() :
116
 
    owner(0),
117
 
    next(0),
118
 
    prev(0),
119
 
    lock(0),
120
 
    cond(0),
121
 
    type(TL_UNLOCK),
122
 
    status_param(0)
123
 
  { }
124
 
 
125
 
  void init(THR_LOCK *lock,
126
 
            void *status_param= NULL);
127
 
};
 
110
} THR_LOCK_DATA;
128
111
 
129
112
struct st_lock_list {
130
113
  THR_LOCK_DATA *data,**last;
131
 
 
132
 
  st_lock_list() :
133
 
    data(0),
134
 
    last(0)
135
 
  { }
136
114
};
137
115
 
138
 
struct THR_LOCK {
139
 
private:
140
 
  boost::mutex mutex;
141
 
public:
 
116
typedef struct st_thr_lock {
 
117
  LIST list;
 
118
  pthread_mutex_t mutex;
142
119
  struct st_lock_list read_wait;
143
120
  struct st_lock_list read;
144
121
  struct st_lock_list write_wait;
145
122
  struct st_lock_list write;
146
123
  /* write_lock_count is incremented for write locks and reset on read locks */
147
 
  uint32_t write_lock_count;
148
 
  uint32_t read_no_write_count;
149
 
 
150
 
  THR_LOCK() :
151
 
    write_lock_count(0),
152
 
    read_no_write_count(0)
153
 
  { }
154
 
 
155
 
  ~THR_LOCK()
156
 
  { }
157
 
 
158
 
  void abort_locks();
159
 
  bool abort_locks_for_thread(uint64_t thread);
160
 
 
161
 
  void lock()
162
 
  {
163
 
    mutex.lock();
164
 
  }
165
 
 
166
 
  void unlock()
167
 
  {
168
 
    mutex.unlock();
169
 
  }
170
 
 
171
 
  void init()
172
 
  {
173
 
  }
174
 
 
175
 
  void deinit()
176
 
  {
177
 
  }
178
 
 
179
 
  boost::mutex *native_handle()
180
 
  {
181
 
    return &mutex;
182
 
  }
183
 
};
184
 
 
185
 
class Session; 
186
 
 
 
124
  ulong write_lock_count;
 
125
  uint read_no_write_count;
 
126
  void (*get_status)(void*, int);       /* When one gets a lock */
 
127
  void (*copy_status)(void*,void*);
 
128
  void (*update_status)(void*);         /* Before release of write */
 
129
  void (*restore_status)(void*);         /* Before release of read */
 
130
  bool (*check_status)(void *);
 
131
} THR_LOCK;
 
132
 
 
133
 
 
134
extern LIST *thr_lock_thread_list;
 
135
 
 
136
bool init_thr_lock(void);               /* Must be called once/thread */
187
137
#define thr_lock_owner_init(owner, info_arg) (owner)->info= (info_arg)
 
138
void thr_lock_info_init(THR_LOCK_INFO *info);
188
139
void thr_lock_init(THR_LOCK *lock);
189
 
enum enum_thr_lock_result thr_multi_lock(Session &session, THR_LOCK_DATA **data,
190
 
                                         uint32_t count, THR_LOCK_OWNER *owner);
191
 
void thr_multi_unlock(THR_LOCK_DATA **data,uint32_t count);
192
 
 
193
 
} /* namespace drizzled */
194
 
 
195
 
#endif /* DRIZZLED_THR_LOCK_H */
 
140
void thr_lock_delete(THR_LOCK *lock);
 
141
void thr_lock_data_init(THR_LOCK *lock,THR_LOCK_DATA *data,
 
142
                        void *status_param);
 
143
enum enum_thr_lock_result thr_lock(THR_LOCK_DATA *data,
 
144
                                   THR_LOCK_OWNER *owner,
 
145
                                   enum thr_lock_type lock_type);
 
146
void thr_unlock(THR_LOCK_DATA *data);
 
147
enum enum_thr_lock_result thr_multi_lock(THR_LOCK_DATA **data,
 
148
                                         uint count, THR_LOCK_OWNER *owner);
 
149
void thr_multi_unlock(THR_LOCK_DATA **data,uint count);
 
150
void thr_abort_locks(THR_LOCK *lock, bool upgrade_lock);
 
151
bool thr_abort_locks_for_thread(THR_LOCK *lock, my_thread_id thread);
 
152
void thr_print_locks(void);             /* For debugging */
 
153
bool thr_upgrade_write_delay_lock(THR_LOCK_DATA *data);
 
154
void    thr_downgrade_write_lock(THR_LOCK_DATA *data,
 
155
                                 enum thr_lock_type new_lock_type);
 
156
bool thr_reschedule_write_lock(THR_LOCK_DATA *data);
 
157
#ifdef  __cplusplus
 
158
}
 
159
#endif
 
160
#endif /* _thr_lock_h */