mirror of
https://github.com/MariaDB/server.git
synced 2025-02-02 03:51:50 +01:00
e49dee377b
This patch was created by running the following commands:
for i in */*[ch]; do doxygenify.pl $i; done
perl -i -pe 's#\*{3} \*/$#****/#' */*[ch]
where doxygenify.pl is
https://svn.innodb.com/svn/misc/trunk/tools/doxygenify.pl r510
Verified the consistency as follows:
(0) not too many /* in: */ or /* out: */ comments left in the code:
grep -l '/\*\s*\(in\|out\)[,:/]' */*[ch]
(1) no difference when ignoring blank lines, after stripping all
C90-style /* comments */, including multi-line ones, before and after
applying this patch:
perl -i -e 'undef $/;while(<ARGV>){s#/\*(.*?)\*/##gs;print}' */*[ch]
diff -I'^\s*$' --exclude .svn -ru TREE1 TREE2
(2) after stripping @return comments and !<, generated a diff and omitted
the hunks where /* out: */ function return comments were removed:
perl -i -e'undef $/;while(<ARGV>){s#!<##g;s#\n\@return\t.*?\*/# \*/#gs;print}'\
*/*[ch]
svn diff|
perl -e 'undef $/;$_=<>;s#\n-\s*/\* out[:,]([^\n]*?)(\n-[^\n]*?)*\*/##gs;print'
Some unintended changes were left. These will be removed in a
subsequent patch.
161 lines
5.1 KiB
C
161 lines
5.1 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 1995, 2009, Innobase Oy. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/******************************************************
|
|
The interface to the operating system
|
|
process and thread control primitives
|
|
|
|
Created 9/8/1995 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef os0thread_h
|
|
#define os0thread_h
|
|
|
|
#include "univ.i"
|
|
|
|
/* Maximum number of threads which can be created in the program;
|
|
this is also the size of the wait slot array for MySQL threads which
|
|
can wait inside InnoDB */
|
|
|
|
#define OS_THREAD_MAX_N srv_max_n_threads
|
|
|
|
|
|
/* Possible fixed priorities for threads */
|
|
#define OS_THREAD_PRIORITY_NONE 100
|
|
#define OS_THREAD_PRIORITY_BACKGROUND 1
|
|
#define OS_THREAD_PRIORITY_NORMAL 2
|
|
#define OS_THREAD_PRIORITY_ABOVE_NORMAL 3
|
|
|
|
#ifdef __WIN__
|
|
typedef void* os_thread_t;
|
|
typedef ulint os_thread_id_t; /* In Windows the thread id
|
|
is an unsigned long int */
|
|
#else
|
|
typedef pthread_t os_thread_t;
|
|
typedef os_thread_t os_thread_id_t; /* In Unix we use the thread
|
|
handle itself as the id of
|
|
the thread */
|
|
#endif
|
|
|
|
/* Define a function pointer type to use in a typecast */
|
|
typedef void* (*os_posix_f_t) (void*);
|
|
|
|
/*******************************************************************
|
|
Compares two thread ids for equality.
|
|
@return TRUE if equal */
|
|
UNIV_INTERN
|
|
ibool
|
|
os_thread_eq(
|
|
/*=========*/
|
|
os_thread_id_t a, /*!< in: OS thread or thread id */
|
|
os_thread_id_t b); /*!< in: OS thread or thread id */
|
|
/********************************************************************
|
|
Converts an OS thread id to a ulint. It is NOT guaranteed that the ulint is
|
|
unique for the thread though!
|
|
@return thread identifier as a number */
|
|
UNIV_INTERN
|
|
ulint
|
|
os_thread_pf(
|
|
/*=========*/
|
|
os_thread_id_t a); /*!< in: OS thread identifier */
|
|
/********************************************************************
|
|
Creates a new thread of execution. The execution starts from
|
|
the function given. The start function takes a void* parameter
|
|
and returns a ulint.
|
|
NOTE: We count the number of threads in os_thread_exit(). A created
|
|
thread should always use that to exit and not use return() to exit.
|
|
@return handle to the thread */
|
|
UNIV_INTERN
|
|
os_thread_t
|
|
os_thread_create(
|
|
/*=============*/
|
|
#ifndef __WIN__
|
|
os_posix_f_t start_f,
|
|
#else
|
|
ulint (*start_f)(void*), /*!< in: pointer to function
|
|
from which to start */
|
|
#endif
|
|
void* arg, /*!< in: argument to start
|
|
function */
|
|
os_thread_id_t* thread_id); /*!< out: id of the created
|
|
thread, or NULL */
|
|
|
|
/*********************************************************************
|
|
Exits the current thread. */
|
|
UNIV_INTERN
|
|
void
|
|
os_thread_exit(
|
|
/*===========*/
|
|
void* exit_value); /*!< in: exit value; in Windows this void*
|
|
is cast as a DWORD */
|
|
/*********************************************************************
|
|
Returns the thread identifier of current thread.
|
|
@return current thread identifier */
|
|
UNIV_INTERN
|
|
os_thread_id_t
|
|
os_thread_get_curr_id(void);
|
|
/*========================*/
|
|
/*********************************************************************
|
|
Returns handle to the current thread.
|
|
@return current thread handle */
|
|
UNIV_INTERN
|
|
os_thread_t
|
|
os_thread_get_curr(void);
|
|
/*====================*/
|
|
/*********************************************************************
|
|
Advises the os to give up remainder of the thread's time slice. */
|
|
UNIV_INTERN
|
|
void
|
|
os_thread_yield(void);
|
|
/*=================*/
|
|
/*********************************************************************
|
|
The thread sleeps at least the time given in microseconds. */
|
|
UNIV_INTERN
|
|
void
|
|
os_thread_sleep(
|
|
/*============*/
|
|
ulint tm); /*!< in: time in microseconds */
|
|
/**********************************************************************
|
|
Gets a thread priority.
|
|
@return priority */
|
|
UNIV_INTERN
|
|
ulint
|
|
os_thread_get_priority(
|
|
/*===================*/
|
|
os_thread_t handle);/*!< in: OS handle to the thread */
|
|
/**********************************************************************
|
|
Sets a thread priority. */
|
|
UNIV_INTERN
|
|
void
|
|
os_thread_set_priority(
|
|
/*===================*/
|
|
os_thread_t handle, /*!< in: OS handle to the thread */
|
|
ulint pri); /*!< in: priority: one of OS_PRIORITY_... */
|
|
/**********************************************************************
|
|
Gets the last operating system error code for the calling thread.
|
|
@return last error on Windows, 0 otherwise */
|
|
UNIV_INTERN
|
|
ulint
|
|
os_thread_get_last_error(void);
|
|
/*==========================*/
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "os0thread.ic"
|
|
#endif
|
|
|
|
#endif
|