← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/innobase/include/os0thread.h

  • Committer: Brian Aker
  • Date: 2009-12-06 01:55:53 UTC
  • mfrom: (1238.1.5 push)
  • Revision ID: brian@gaz-20091206015553-cva833q4gvwj11ob
Bundle for staging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/innobase/include/os0thread.h
1
 
/*****************************************************************************
2
 
 
3
 
Copyright (C) 1995, 2009, Innobase Oy. All Rights Reserved.
4
 
 
5
 
This program is free software; you can redistribute it and/or modify it under
6
 
the terms of the GNU General Public License as published by the Free Software
7
 
Foundation; version 2 of the License.
8
 
 
9
 
This program is distributed in the hope that it will be useful, but WITHOUT
10
 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11
 
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12
 
 
13
 
You should have received a copy of the GNU General Public License along with
14
 
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
15
 
St, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
*****************************************************************************/
18
 
 
19
 
/**************************************************//**
20
 
@file include/os0thread.h
21
 
The interface to the operating system
22
 
process and thread control primitives
23
 
 
24
 
Created 9/8/1995 Heikki Tuuri
25
 
*******************************************************/
26
 
 
27
 
#ifndef os0thread_h
28
 
#define os0thread_h
29
 
 
30
 
#include "univ.i"
31
 
 
32
 
/* Maximum number of threads which can be created in the program;
33
 
this is also the size of the wait slot array for MySQL threads which
34
 
can wait inside InnoDB */
35
 
 
36
 
#define OS_THREAD_MAX_N         srv_max_n_threads
37
 
 
38
 
 
39
 
/* Possible fixed priorities for threads */
40
 
#define OS_THREAD_PRIORITY_NONE         100
41
 
#define OS_THREAD_PRIORITY_BACKGROUND   1
42
 
#define OS_THREAD_PRIORITY_NORMAL       2
43
 
#define OS_THREAD_PRIORITY_ABOVE_NORMAL 3
44
 
 
45
 
#ifdef __WIN__
46
 
typedef void*                   os_thread_t;
47
 
typedef unsigned long           os_thread_id_t; /*!< In Windows the thread id
48
 
                                                is an unsigned long int */
49
 
#else
50
 
#include <pthread.h>
51
 
typedef pthread_t               os_thread_t;
52
 
typedef os_thread_t             os_thread_id_t; /*!< In Unix we use the thread
53
 
                                                handle itself as the id of
54
 
                                                the thread */
55
 
#endif
56
 
 
57
 
/* Define a function pointer type to use in a typecast */
58
 
typedef void* (*os_posix_f_t) (void*);
59
 
 
60
 
#ifdef HAVE_PSI_INTERFACE
61
 
/* Define for performance schema registration key */
62
 
typedef unsigned int    mysql_pfs_key_t;
63
 
#endif
64
 
 
65
 
/***************************************************************//**
66
 
Compares two thread ids for equality.
67
 
@return TRUE if equal */
68
 
UNIV_INTERN
69
 
ibool
70
 
os_thread_eq(
71
 
/*=========*/
72
 
        os_thread_id_t  a,      /*!< in: OS thread or thread id */
73
 
        os_thread_id_t  b);     /*!< in: OS thread or thread id */
74
 
/****************************************************************//**
75
 
Converts an OS thread id to a ulint. It is NOT guaranteed that the ulint is
76
 
unique for the thread though!
77
 
@return thread identifier as a number */
78
 
UNIV_INTERN
79
 
ulint
80
 
os_thread_pf(
81
 
/*=========*/
82
 
        os_thread_id_t  a);     /*!< in: OS thread identifier */
83
 
/****************************************************************//**
84
 
Creates a new thread of execution. The execution starts from
85
 
the function given. The start function takes a void* parameter
86
 
and returns a ulint.
87
 
NOTE: We count the number of threads in os_thread_exit(). A created
88
 
thread should always use that to exit and not use return() to exit.
89
 
@return handle to the thread */
90
 
UNIV_INTERN
91
 
os_thread_t
92
 
os_thread_create(
93
 
/*=============*/
94
 
#ifndef __WIN__
95
 
        os_posix_f_t            start_f,
96
 
#else
97
 
        ulint (*start_f)(void*),                /*!< in: pointer to function
98
 
                                                from which to start */
99
 
#endif
100
 
        void*                   arg,            /*!< in: argument to start
101
 
                                                function */
102
 
        os_thread_id_t*         thread_id);     /*!< out: id of the created
103
 
                                                thread, or NULL */
104
 
/*****************************************************************//**
105
 
Exits the current thread. */
106
 
UNIV_INTERN
107
 
void
108
 
os_thread_exit(
109
 
/*===========*/
110
 
        void*   exit_value);    /*!< in: exit value; in Windows this void*
111
 
                                is cast as a DWORD */
112
 
/*****************************************************************//**
113
 
Returns the thread identifier of current thread.
114
 
@return current thread identifier */
115
 
UNIV_INTERN
116
 
os_thread_id_t
117
 
os_thread_get_curr_id(void);
118
 
/*========================*/
119
 
/*****************************************************************//**
120
 
Returns handle to the current thread.
121
 
@return current thread handle */
122
 
UNIV_INTERN
123
 
os_thread_t
124
 
os_thread_get_curr(void);
125
 
/*====================*/
126
 
/*****************************************************************//**
127
 
Advises the os to give up remainder of the thread's time slice. */
128
 
UNIV_INTERN
129
 
void
130
 
os_thread_yield(void);
131
 
/*=================*/
132
 
/*****************************************************************//**
133
 
The thread sleeps at least the time given in microseconds. */
134
 
UNIV_INTERN
135
 
void
136
 
os_thread_sleep(
137
 
/*============*/
138
 
        ulint   tm);    /*!< in: time in microseconds */
139
 
/******************************************************************//**
140
 
Gets a thread priority.
141
 
@return priority */
142
 
UNIV_INTERN
143
 
ulint
144
 
os_thread_get_priority(
145
 
/*===================*/
146
 
        os_thread_t     handle);/*!< in: OS handle to the thread */
147
 
/******************************************************************//**
148
 
Sets a thread priority. */
149
 
UNIV_INTERN
150
 
void
151
 
os_thread_set_priority(
152
 
/*===================*/
153
 
        os_thread_t     handle, /*!< in: OS handle to the thread */
154
 
        ulint           pri);   /*!< in: priority: one of OS_PRIORITY_... */
155
 
/******************************************************************//**
156
 
Gets the last operating system error code for the calling thread.
157
 
@return last error on Windows, 0 otherwise */
158
 
UNIV_INTERN
159
 
ulint
160
 
os_thread_get_last_error(void);
161
 
/*==========================*/
162
 
 
163
 
#ifndef UNIV_NONINL
164
 
#include "os0thread.ic"
165
 
#endif
166
 
 
167
 
#endif