Debian Codegraph @

extra/gperftools/gperftools-2.15/src/base/linuxthreads.h

raw
1 // -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*-
2 /* Copyright (c) 2005-2007, Google Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 * * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * ---
32 * Author: Markus Gutschke
33 */
34
35 #ifndef _LINUXTHREADS_H
36 #define _LINUXTHREADS_H
37
38 #include <stdarg.h>
39 #include <sys/types.h>
40
41 typedef int (*ListAllProcessThreadsCallBack)(void *parameter,
42 int num_threads,
43 pid_t *thread_pids,
44 va_list ap);
45
46 /* This function gets the list of all linux threads of the current process
47 * passes them to the 'callback' along with the 'parameter' pointer; at the
48 * call back call time all the threads are paused via
49 * PTRACE_ATTACH.
50 * The callback is executed from a separate thread which shares only the
51 * address space, the filesystem, and the filehandles with the caller. Most
52 * notably, it does not share the same pid and ppid; and if it terminates,
53 * the rest of the application is still there. 'callback' is supposed to do
54 * or arrange for TCMalloc_ResumeAllProcessThreads. This happens automatically, if
55 * the thread raises a synchronous signal (e.g. SIGSEGV); asynchronous
56 * signals are blocked. If the 'callback' decides to unblock them, it must
57 * ensure that they cannot terminate the application, or that
58 * TCMalloc_ResumeAllProcessThreads will get called.
59 * It is an error for the 'callback' to make any library calls that could
60 * acquire locks. Most notably, this means that most system calls have to
61 * avoid going through libc. Also, this means that it is not legal to call
62 * exit() or abort().
63 * We return -1 on error and the return value of 'callback' on success.
64 */
65 int TCMalloc_ListAllProcessThreads(void *parameter,
66 ListAllProcessThreadsCallBack callback, ...);
67
68 /* This function resumes the list of all linux threads that
69 * TCMalloc_ListAllProcessThreads pauses before giving to its
70 * callback. The function returns non-zero if at least one thread was
71 * suspended and has now been resumed.
72 */
73 int TCMalloc_ResumeAllProcessThreads(int num_threads, pid_t *thread_pids);
74
75 #endif /* _LINUXTHREADS_H */