add .Mt to man pages in lib/
[dragonfly.git] / lib / libpthread / pthread_switch_add_np.3
1 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man3/pthread_switch_add_np.3,v 1.5 2007/10/22 10:08:01 ru Exp $
26 .\"
27 .Dd July 10, 2009
28 .Dt PTHREAD_SWITCH_ADD_NP 3
29 .Os
30 .Sh NAME
31 .Nm pthread_switch_add_np ,
32 .Nm pthread_switch_delete_np
33 .Nd thread context switches debugging primitives
34 .Sh LIBRARY
35 .Lb libpthread
36 .Sh SYNOPSIS
37 .In pthread.h
38 .In pthread_np.h
39 .Ft int
40 .Fn pthread_switch_add_np "pthread_switch_routine_t routine"
41 .Ft int
42 .Fn pthread_switch_delete_np "pthread_switch_routine_t routine"
43 .Sh DESCRIPTION
44 An application is allowed to monitor the thread context switches inside
45 the threading library.
46 An application can install a routine that gets called every time a thread
47 (explicitly created by an application with the
48 .Xr pthread_create 3
49 function) gets the context switched.
50 The routine is passed the thread IDs of the threads that are
51 being switched in and out.
52 Installation and removal of these hooks may be done using the
53 .Fn pthread_switch_add_np
54 and
55 .Fn pthread_switch_delete_np
56 functions respectively.
57 .Sh RETURN VALUES
58 If successful,
59 these functions return 0.
60 Otherwise, an error number is returned to indicate the error.
61 .Sh ERRORS
62 The
63 .Fn pthread_switch_add_np
64 may fail if:
65 .Bl -tag -width Er
66 .It Bq Er EINVAL
67 .Dv NULL
68 pointer was passed in the
69 .Fa routine
70 argument.
71 .El
72 .Pp
73 The
74 .Fn pthread_switch_delete_np
75 may fail if:
76 .Bl -tag -width Er
77 .It Bq Er EINVAL
78 The
79 .Fa routine
80 argument is different from the argument previously passed to the
81 .Fn pthread_switch_add_np
82 function.
83 .El
84 .Sh SEE ALSO
85 .Xr pthread_create 3
86 .Sh AUTHORS
87 This manual page was written by
88 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org .