← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to storage/innobase/include/sync0arr.h

  • Committer: brian
  • Date: 2008-06-25 05:29:13 UTC
  • Revision ID: brian@localhost.localdomain-20080625052913-6upwo0jsrl4lnapl
clean slate

Show diffs side-by-side

added added

removed removed

Lines of Context:
storage/innobase/include/sync0arr.h
 
1
/******************************************************
 
2
The wait array used in synchronization primitives
 
3
 
 
4
(c) 1995 Innobase Oy
 
5
 
 
6
Created 9/5/1995 Heikki Tuuri
 
7
*******************************************************/
 
8
 
 
9
#ifndef sync0arr_h
 
10
#define sync0arr_h
 
11
 
 
12
#include "univ.i"
 
13
#include "ut0lst.h"
 
14
#include "ut0mem.h"
 
15
#include "os0thread.h"
 
16
 
 
17
typedef struct sync_cell_struct         sync_cell_t;
 
18
typedef struct sync_array_struct        sync_array_t;
 
19
 
 
20
#define SYNC_ARRAY_OS_MUTEX     1
 
21
#define SYNC_ARRAY_MUTEX        2
 
22
 
 
23
/***********************************************************************
 
24
Creates a synchronization wait array. It is protected by a mutex
 
25
which is automatically reserved when the functions operating on it
 
26
are called. */
 
27
 
 
28
sync_array_t*
 
29
sync_array_create(
 
30
/*==============*/
 
31
                                /* out, own: created wait array */
 
32
        ulint   n_cells,        /* in: number of cells in the array
 
33
                                to create */
 
34
        ulint   protection);    /* in: either SYNC_ARRAY_OS_MUTEX or
 
35
                                SYNC_ARRAY_MUTEX: determines the type
 
36
                                of mutex protecting the data structure */
 
37
/**********************************************************************
 
38
Frees the resources in a wait array. */
 
39
 
 
40
void
 
41
sync_array_free(
 
42
/*============*/
 
43
        sync_array_t*   arr);   /* in, own: sync wait array */
 
44
/**********************************************************************
 
45
Reserves a wait array cell for waiting for an object.
 
46
The event of the cell is reset to nonsignalled state. */
 
47
 
 
48
void
 
49
sync_array_reserve_cell(
 
50
/*====================*/
 
51
        sync_array_t*   arr,    /* in: wait array */
 
52
        void*           object, /* in: pointer to the object to wait for */
 
53
        ulint           type,   /* in: lock request type */
 
54
        const char*     file,   /* in: file where requested */
 
55
        ulint           line,   /* in: line where requested */
 
56
        ulint*          index); /* out: index of the reserved cell */
 
57
/**********************************************************************
 
58
This function should be called when a thread starts to wait on
 
59
a wait array cell. In the debug version this function checks
 
60
if the wait for a semaphore will result in a deadlock, in which
 
61
case prints info and asserts. */
 
62
 
 
63
void
 
64
sync_array_wait_event(
 
65
/*==================*/
 
66
        sync_array_t*   arr,    /* in: wait array */
 
67
        ulint           index);  /* in: index of the reserved cell */
 
68
/**********************************************************************
 
69
Frees the cell safely by reserving the sync array mutex and decrementing
 
70
n_reserved if necessary. Should only be called from mutex_spin_wait. */
 
71
 
 
72
void
 
73
sync_array_free_cell_protected(
 
74
/*===========================*/
 
75
        sync_array_t*   arr,    /* in: wait array */
 
76
        ulint           index); /* in: index of the cell in array */
 
77
/**************************************************************************
 
78
Looks for the cells in the wait array which refer
 
79
to the wait object specified,
 
80
and sets their corresponding events to the signaled state. In this
 
81
way releases the threads waiting for the object to contend for the object.
 
82
It is possible that no such cell is found, in which case does nothing. */
 
83
 
 
84
void
 
85
sync_array_signal_object(
 
86
/*=====================*/
 
87
        sync_array_t*   arr,    /* in: wait array */
 
88
        void*           object);/* in: wait object */
 
89
/**************************************************************************
 
90
If the wakeup algorithm does not work perfectly at semaphore relases,
 
91
this function will do the waking (see the comment in mutex_exit). This
 
92
function should be called about every 1 second in the server. */
 
93
 
 
94
void
 
95
sync_arr_wake_threads_if_sema_free(void);
 
96
/*====================================*/
 
97
/**************************************************************************
 
98
Prints warnings of long semaphore waits to stderr. */
 
99
 
 
100
ibool
 
101
sync_array_print_long_waits(void);
 
102
/*=============================*/
 
103
                        /* out: TRUE if fatal semaphore wait threshold
 
104
                        was exceeded */
 
105
/************************************************************************
 
106
Validates the integrity of the wait array. Checks
 
107
that the number of reserved cells equals the count variable. */
 
108
 
 
109
void
 
110
sync_array_validate(
 
111
/*================*/
 
112
        sync_array_t*   arr);   /* in: sync wait array */
 
113
/**************************************************************************
 
114
Prints info of the wait array. */
 
115
 
 
116
void
 
117
sync_array_print_info(
 
118
/*==================*/
 
119
        FILE*           file,   /* in: file where to print */
 
120
        sync_array_t*   arr);   /* in: wait array */
 
121
 
 
122
 
 
123
#ifndef UNIV_NONINL
 
124
#include "sync0arr.ic"
 
125
#endif
 
126
 
 
127
#endif