Corrected comment syntax
[dyninst.git] / dyninstAPI_RT / src / RTaix.c
1 /*
2  * Copyright (c) 1996-2004 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 /************************************************************************
43  * RTaix.c: mutatee-side library function specific to AIX
44 ************************************************************************/
45
46 #include "dyninstAPI_RT/h/dyninstAPI_RT.h"
47 #include "RTthread.h"
48 #include <dlfcn.h> /* dlopen constants */
49 #include <stdio.h>
50 #include <pthread.h>
51 #include <unistd.h>
52 #include <signal.h>
53
54 /************************************************************************
55  * void DYNINSTos_init(void)
56  *
57  * os initialization function
58 ************************************************************************/
59
60 void DYNINSTstaticHeap_1048576_textHeap_libSpace(void);
61
62 void DYNINSTbreakPoint()
63 {
64     /* We set a global flag here so that we can tell
65        if we're ever in a call to this when we get a 
66        SIGBUS */
67    /*
68    int thread_index = DYNINSTthreadIndex();
69    */
70     DYNINST_break_point_event = 1;
71     while (DYNINST_break_point_event)  {
72         kill(getpid(), DYNINST_BREAKPOINT_SIGNUM);
73     }
74     /* Mutator resets to 0... */
75 }
76
77
78 void DYNINSTsafeBreakPoint()
79 {
80     DYNINST_break_point_event = 2; /* Not the same as above */
81     while (DYNINST_break_point_event)
82         kill(getpid(), SIGSTOP);
83 }
84
85 void DYNINSTos_init(int calledByFork, int calledByAttach)
86 {
87    /* Text heap initialization. Call this to force the library to
88       be included by the linker */
89 #ifdef USES_LIB_TEXT_HEAP
90    /* Dummy call to get the library space actually included
91       (not pruned by an optimizing linker) */
92    DYNINSTstaticHeap_1048576_textHeap_libSpace();
93 #endif
94 }
95
96 #define NOT_SETUP_ERR 0x2468ace0
97
98 int DYNINSTloadLibrary(char *libname)
99 {
100    void *res;
101    char *err_str;
102    gLoadLibraryErrorString[0]='\0';
103    
104    if (NULL == (res = dlopen(libname, RTLD_NOW | RTLD_GLOBAL))) {
105       /* An error has occurred */
106       //perror( "DYNINSTloadLibrary -- dlopen" );
107     
108       if (NULL != (err_str = dlerror()))
109          strncpy(gLoadLibraryErrorString, err_str, ERROR_STRING_LENGTH);
110       else 
111          sprintf(gLoadLibraryErrorString,"unknown error with dlopen");
112       
113       /*fprintf(stderr, "%s[%d]: %s\n", __FILE__, __LINE__,
114                 gLoadLibraryErrorString);*/
115       return 0;  
116    } else
117       return 1;
118 }
119
120 void DYNINST_ThreadPInfo(void* tls, void** stkbase, dyntid_t* tid, 
121                          long *pc, int* lwp, void** rs) 
122 {
123    /* Use the __pthrdsinfo struct defined in /usr/include/pthread.h */
124    struct __pthrdsinfo *ptr = (struct __pthrdsinfo *) tls;
125    /* Want: 
126       Stack base
127       TID
128       initial PC (entry to provided "start" function)
129       LWP
130       RS (thread context)
131    */
132    *stkbase = (void *) ptr->__pi_stackaddr;
133    *tid = ptr->__pi_ptid; /* pthread_t as opposed to tid_t */
134    *pc = ptr->__pi_func;
135    *lwp = ptr->__pi_tid;
136    *rs = (void *) (&ptr->__pi_context);
137 }
138
139 int DYNINSTthreadInfo(BPatch_newThreadEventRecord *ev)
140 {
141    struct __pthrdsinfo pthread_desc;
142    int pthread_desc_size = sizeof(struct __pthrdsinfo);
143    int registers[1024];
144    int regsize = 1024*sizeof(int);
145
146    dyntid_t tidp;
147    int lwpid;
148    long startpc;
149    void *stkbase, *rs_p;
150
151    int result;
152
153    pthread_t pthread_id;
154    pthread_id = (pthread_t) dyn_pthread_self();
155
156    result = dyn_pthread_getthrds_np(&pthread_id, PTHRDSINFO_QUERY_ALL,
157                                     &pthread_desc, pthread_desc_size,
158                                     registers, &regsize);
159    if (result)
160    {
161       if (result != NOT_SETUP_ERR)
162          perror("RTthread-aix:DYNINST_ThreadInfo");
163       else
164          fprintf(stderr, "[%s:%u] - TInfo not yet setup\n", __FILE__, __LINE__);
165       return 0;
166    }
167
168    DYNINST_ThreadPInfo((void *)&pthread_desc, &stkbase, &tidp, &startpc, 
169                        &lwpid, &rs_p);
170
171    ev->stack_addr = stkbase;
172    ev->start_pc = (void *) startpc;
173
174    /*
175    fprintf(stderr, "DYNINST_ThreadInfo, stkbase=%x, tid=%d, " 
176            "startpc=%x, lwp=%d, resumestate=%x\n",
177            (unsigned) *stkbase, *tidp, *startpc, *lwpid, (unsigned)*rs_p);
178    */
179           
180    return 1;
181 }
182
183 int dyn_pid_self()
184 {
185    return getpid();
186 }
187
188 int dyn_lwp_self()
189 {
190    return thread_self();
191 }
192
193 typedef struct {
194    void *func;
195    unsigned toc;
196    void *dummy;
197 } call_record_t;
198 typedef dyntid_t (*DYNINST_pself_t)(void);
199 typedef int (*DYNINST_pgetthrds_np_t)(pthread_t *, int, struct __pthrdsinfo *, 
200                                       int, void *, int *);
201
202 call_record_t DYNINST_pthread_self_record;
203 DYNINST_pself_t DYNINST_pthread_self = 
204     (DYNINST_pself_t) &DYNINST_pthread_self_record;
205 dyntid_t dyn_pthread_self()
206 {
207    if (!DYNINST_pthread_self_record.func)
208    {
209       return (void *) DYNINST_SINGLETHREADED;
210    }
211    return (*DYNINST_pthread_self)();
212 }
213
214 call_record_t DYNINST_pthread_getthrds_np_record;
215 DYNINST_pgetthrds_np_t DYNINST_pthread_getthrds_np =
216    (DYNINST_pgetthrds_np_t) &DYNINST_pthread_getthrds_np_record;
217 int dyn_pthread_getthrds_np(pthread_t *thread, int mode, 
218                             struct __pthrdsinfo *buf, int bufsize,
219                             void *regbuf, int *regbufsize)
220 {
221    if (!DYNINST_pthread_getthrds_np_record.func)
222    {
223       return NOT_SETUP_ERR;
224    }
225    return (*DYNINST_pthread_getthrds_np)(thread, mode, buf, bufsize, 
226                                          regbuf, regbufsize);
227 }
228
229 /* 
230    We reserve index 0 for the initial thread. This value varies by
231    platform but is always constant for that platform. Wrap that
232    platform-ness here. 
233 */
234 int DYNINST_am_initial_thread(dyntid_t tid) {
235     return (tid == (dyntid_t) 1);
236 }