1*062c5bc4SJason Schmidlapp /*
2*062c5bc4SJason Schmidlapp * cleanup.c
3*062c5bc4SJason Schmidlapp *
4*062c5bc4SJason Schmidlapp * Description:
5*062c5bc4SJason Schmidlapp * This translation unit implements routines associated
6*062c5bc4SJason Schmidlapp * with cleaning up threads.
7*062c5bc4SJason Schmidlapp *
8*062c5bc4SJason Schmidlapp *
9*062c5bc4SJason Schmidlapp * --------------------------------------------------------------------------
10*062c5bc4SJason Schmidlapp *
11*062c5bc4SJason Schmidlapp * Pthreads-embedded (PTE) - POSIX Threads Library for embedded systems
12*062c5bc4SJason Schmidlapp * Copyright(C) 2008 Jason Schmidlapp
13*062c5bc4SJason Schmidlapp *
14*062c5bc4SJason Schmidlapp * Contact Email: jschmidlapp@users.sourceforge.net
15*062c5bc4SJason Schmidlapp *
16*062c5bc4SJason Schmidlapp *
17*062c5bc4SJason Schmidlapp * Based upon Pthreads-win32 - POSIX Threads Library for Win32
18*062c5bc4SJason Schmidlapp * Copyright(C) 1998 John E. Bossom
19*062c5bc4SJason Schmidlapp * Copyright(C) 1999,2005 Pthreads-win32 contributors
20*062c5bc4SJason Schmidlapp *
21*062c5bc4SJason Schmidlapp * Contact Email: rpj@callisto.canberra.edu.au
22*062c5bc4SJason Schmidlapp *
23*062c5bc4SJason Schmidlapp * The original list of contributors to the Pthreads-win32 project
24*062c5bc4SJason Schmidlapp * is contained in the file CONTRIBUTORS.ptw32 included with the
25*062c5bc4SJason Schmidlapp * source code distribution. The list can also be seen at the
26*062c5bc4SJason Schmidlapp * following World Wide Web location:
27*062c5bc4SJason Schmidlapp * http://sources.redhat.com/pthreads-win32/contributors.html
28*062c5bc4SJason Schmidlapp *
29*062c5bc4SJason Schmidlapp * This library is free software; you can redistribute it and/or
30*062c5bc4SJason Schmidlapp * modify it under the terms of the GNU Lesser General Public
31*062c5bc4SJason Schmidlapp * License as published by the Free Software Foundation; either
32*062c5bc4SJason Schmidlapp * version 2 of the License, or (at your option) any later version.
33*062c5bc4SJason Schmidlapp *
34*062c5bc4SJason Schmidlapp * This library is distributed in the hope that it will be useful,
35*062c5bc4SJason Schmidlapp * but WITHOUT ANY WARRANTY; without even the implied warranty of
36*062c5bc4SJason Schmidlapp * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
37*062c5bc4SJason Schmidlapp * Lesser General Public License for more details.
38*062c5bc4SJason Schmidlapp *
39*062c5bc4SJason Schmidlapp * You should have received a copy of the GNU Lesser General Public
40*062c5bc4SJason Schmidlapp * License along with this library in the file COPYING.LIB;
41*062c5bc4SJason Schmidlapp * if not, write to the Free Software Foundation, Inc.,
42*062c5bc4SJason Schmidlapp * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
43*062c5bc4SJason Schmidlapp */
44*062c5bc4SJason Schmidlapp
45*062c5bc4SJason Schmidlapp #include "pthread.h"
46*062c5bc4SJason Schmidlapp #include "implement.h"
47*062c5bc4SJason Schmidlapp
48*062c5bc4SJason Schmidlapp
49*062c5bc4SJason Schmidlapp /*
50*062c5bc4SJason Schmidlapp * The functions pte_pop_cleanup and pte_push_cleanup
51*062c5bc4SJason Schmidlapp * are implemented here for applications written in C with no
52*062c5bc4SJason Schmidlapp * C++ destructor support.
53*062c5bc4SJason Schmidlapp */
54*062c5bc4SJason Schmidlapp
55*062c5bc4SJason Schmidlapp pte_cleanup_t *
pte_pop_cleanup(int execute)56*062c5bc4SJason Schmidlapp pte_pop_cleanup (int execute)
57*062c5bc4SJason Schmidlapp /*
58*062c5bc4SJason Schmidlapp * ------------------------------------------------------
59*062c5bc4SJason Schmidlapp * DOCPUBLIC
60*062c5bc4SJason Schmidlapp * This function pops the most recently pushed cleanup
61*062c5bc4SJason Schmidlapp * handler. If execute is nonzero, then the cleanup handler
62*062c5bc4SJason Schmidlapp * is executed if non-null.
63*062c5bc4SJason Schmidlapp *
64*062c5bc4SJason Schmidlapp * PARAMETERS
65*062c5bc4SJason Schmidlapp * execute
66*062c5bc4SJason Schmidlapp * if nonzero, execute the cleanup handler
67*062c5bc4SJason Schmidlapp *
68*062c5bc4SJason Schmidlapp *
69*062c5bc4SJason Schmidlapp * DESCRIPTION
70*062c5bc4SJason Schmidlapp * This function pops the most recently pushed cleanup
71*062c5bc4SJason Schmidlapp * handler. If execute is nonzero, then the cleanup handler
72*062c5bc4SJason Schmidlapp * is executed if non-null.
73*062c5bc4SJason Schmidlapp * NOTE: specify 'execute' as nonzero to avoid duplication
74*062c5bc4SJason Schmidlapp * of common cleanup code.
75*062c5bc4SJason Schmidlapp *
76*062c5bc4SJason Schmidlapp * RESULTS
77*062c5bc4SJason Schmidlapp * N/A
78*062c5bc4SJason Schmidlapp *
79*062c5bc4SJason Schmidlapp * ------------------------------------------------------
80*062c5bc4SJason Schmidlapp */
81*062c5bc4SJason Schmidlapp {
82*062c5bc4SJason Schmidlapp pte_cleanup_t *cleanup;
83*062c5bc4SJason Schmidlapp
84*062c5bc4SJason Schmidlapp cleanup = (pte_cleanup_t *) pthread_getspecific (pte_cleanupKey);
85*062c5bc4SJason Schmidlapp
86*062c5bc4SJason Schmidlapp if (cleanup != NULL)
87*062c5bc4SJason Schmidlapp {
88*062c5bc4SJason Schmidlapp if (execute && (cleanup->routine != NULL))
89*062c5bc4SJason Schmidlapp {
90*062c5bc4SJason Schmidlapp
91*062c5bc4SJason Schmidlapp (*cleanup->routine) (cleanup->arg);
92*062c5bc4SJason Schmidlapp
93*062c5bc4SJason Schmidlapp }
94*062c5bc4SJason Schmidlapp
95*062c5bc4SJason Schmidlapp pthread_setspecific (pte_cleanupKey, (void *) cleanup->prev);
96*062c5bc4SJason Schmidlapp
97*062c5bc4SJason Schmidlapp }
98*062c5bc4SJason Schmidlapp
99*062c5bc4SJason Schmidlapp return (cleanup);
100*062c5bc4SJason Schmidlapp
101*062c5bc4SJason Schmidlapp } /* pte_pop_cleanup */
102*062c5bc4SJason Schmidlapp
103*062c5bc4SJason Schmidlapp
104*062c5bc4SJason Schmidlapp void
pte_push_cleanup(pte_cleanup_t * cleanup,pte_cleanup_callback_t routine,void * arg)105*062c5bc4SJason Schmidlapp pte_push_cleanup (pte_cleanup_t * cleanup,
106*062c5bc4SJason Schmidlapp pte_cleanup_callback_t routine, void *arg)
107*062c5bc4SJason Schmidlapp /*
108*062c5bc4SJason Schmidlapp * ------------------------------------------------------
109*062c5bc4SJason Schmidlapp * DOCPUBLIC
110*062c5bc4SJason Schmidlapp * This function pushes a new cleanup handler onto the thread's stack
111*062c5bc4SJason Schmidlapp * of cleanup handlers. Each cleanup handler pushed onto the stack is
112*062c5bc4SJason Schmidlapp * popped and invoked with the argument 'arg' when
113*062c5bc4SJason Schmidlapp * a) the thread exits by calling 'pthread_exit',
114*062c5bc4SJason Schmidlapp * b) when the thread acts on a cancellation request,
115*062c5bc4SJason Schmidlapp * c) or when the thread calls pthread_cleanup_pop with a nonzero
116*062c5bc4SJason Schmidlapp * 'execute' argument
117*062c5bc4SJason Schmidlapp *
118*062c5bc4SJason Schmidlapp * PARAMETERS
119*062c5bc4SJason Schmidlapp * cleanup
120*062c5bc4SJason Schmidlapp * a pointer to an instance of pthread_cleanup_t,
121*062c5bc4SJason Schmidlapp *
122*062c5bc4SJason Schmidlapp * routine
123*062c5bc4SJason Schmidlapp * pointer to a cleanup handler,
124*062c5bc4SJason Schmidlapp *
125*062c5bc4SJason Schmidlapp * arg
126*062c5bc4SJason Schmidlapp * parameter to be passed to the cleanup handler
127*062c5bc4SJason Schmidlapp *
128*062c5bc4SJason Schmidlapp *
129*062c5bc4SJason Schmidlapp * DESCRIPTION
130*062c5bc4SJason Schmidlapp * This function pushes a new cleanup handler onto the thread's stack
131*062c5bc4SJason Schmidlapp * of cleanup handlers. Each cleanup handler pushed onto the stack is
132*062c5bc4SJason Schmidlapp * popped and invoked with the argument 'arg' when
133*062c5bc4SJason Schmidlapp * a) the thread exits by calling 'pthread_exit',
134*062c5bc4SJason Schmidlapp * b) when the thread acts on a cancellation request,
135*062c5bc4SJason Schmidlapp * c) or when the thrad calls pthread_cleanup_pop with a nonzero
136*062c5bc4SJason Schmidlapp * 'execute' argument
137*062c5bc4SJason Schmidlapp * NOTE: pthread_push_cleanup, pte_pop_cleanup must be paired
138*062c5bc4SJason Schmidlapp * in the same lexical scope.
139*062c5bc4SJason Schmidlapp *
140*062c5bc4SJason Schmidlapp * RESULTS
141*062c5bc4SJason Schmidlapp * pthread_cleanup_t *
142*062c5bc4SJason Schmidlapp * pointer to the previous cleanup
143*062c5bc4SJason Schmidlapp *
144*062c5bc4SJason Schmidlapp * ------------------------------------------------------
145*062c5bc4SJason Schmidlapp */
146*062c5bc4SJason Schmidlapp {
147*062c5bc4SJason Schmidlapp cleanup->routine = routine;
148*062c5bc4SJason Schmidlapp cleanup->arg = arg;
149*062c5bc4SJason Schmidlapp
150*062c5bc4SJason Schmidlapp cleanup->prev = (pte_cleanup_t *) pthread_getspecific (pte_cleanupKey);
151*062c5bc4SJason Schmidlapp
152*062c5bc4SJason Schmidlapp pthread_setspecific (pte_cleanupKey, (void *) cleanup);
153*062c5bc4SJason Schmidlapp
154*062c5bc4SJason Schmidlapp } /* pte_push_cleanup */
155