File: ipath_debug.c

package info (click to toggle)
infinipath-psm 3.3+20.604758e7-6
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 2,452 kB
  • sloc: ansic: 34,270; makefile: 358; asm: 47; sh: 18
file content (256 lines) | stat: -rw-r--r-- 8,449 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/*
 * Copyright (c) 2013. Intel Corporation. All rights reserved.
 * Copyright (c) 2006-2012. QLogic Corporation. All rights reserved.
 * Copyright (c) 2003-2006, PathScale, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <sys/types.h>
#include <stdint.h>
#include <stdlib.h>
#include <stddef.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <stdio.h>
#include <signal.h>
#include <execinfo.h>
#include <fcntl.h>
#include <ucontext.h>
#include "ipath_user.h"

unsigned infinipath_debug = 1;
char* __ipath_mylabel = NULL;
FILE *__ipath_dbgout;
static void init_ipath_mylabel(void) __attribute__ ((constructor));
static void init_ipath_backtrace(void) __attribute__ ((constructor));
static void init_ipath_dbgfile(void) __attribute__ ((constructor));
static void fini_ipath_backtrace(void) __attribute__ ((destructor));

static void init_ipath_mylabel(void)
{
    char lbl[1024];
    char hostname[80];
    char *e;
    /* By default, try to come up with a decent default label, it will be
     * overriden later.  Try getting rank, if that's not available revert to
     * pid. */
    gethostname(hostname, 80);
    lbl[0] = '\0';
    hostname[sizeof hostname - 1] = '\0';
    if ((((e = getenv("PSC_MPI_RANK")) && *e)) ||
	(((e = getenv("MPI_RANKID")) && *e)) ||
	(((e = getenv("MPIRUN_RANK")) && *e)))
    {
	char *ep;
	unsigned long val;
	val = strtoul(e, &ep, 10);
	if (ep != e) /* valid conversion */
	    snprintf(lbl, 1024, "%s.%lu", hostname, val);
    }
    if (lbl[0] == '\0')
	snprintf(lbl, 1024, "%s.%u", hostname, getpid());
    __ipath_mylabel = strdup(lbl);
}

static void
ipath_sighdlr(int sig, siginfo_t *p1, void *ucv)
{
    // we make these static to try and avoid issues caused
    // by stack overflow that might have gotten us here.
    static void *backaddr[128]; // avoid stack usage
    static char buf[150], hname[64], fname[128];
    static int i, j, fd, id;
    static int write_result __unused__;
    extern char *__progname;

    // If this is a SIGINT do not display backtrace. Just invoke exit handlers
    if ((sig == SIGINT) || (sig == SIGTERM))
      exit(1);
    
    id = snprintf(buf, sizeof buf,
        "\n%.60s:%u terminated with signal %d", __progname, getpid(), sig);
    if(ucv) {
        static ucontext_t *uc;
        uc = (ucontext_t*)ucv;
        id += snprintf(buf+id, sizeof buf-id, " at PC=%lx SP=%lx",
#if defined(__x86_64__)
            (unsigned long)uc->uc_mcontext.gregs[REG_RIP],
            (unsigned long)uc->uc_mcontext.gregs[REG_RSP]);
#elif defined(__i386__)
            (unsigned long)uc->uc_mcontext.gregs[REG_EIP],
            (unsigned long)uc->uc_mcontext.gregs[REG_ESP]);
#else
            0ul, 0ul);
#warning No stack pointer or instruction pointer for this arch
#endif
    }
    id += snprintf(buf+id, sizeof buf-id, ".  Backtrace:\n");
    write_result = write(2, buf, id);

    i = backtrace(backaddr, sizeof(backaddr)/sizeof(backaddr[0]));
    if(i>2) // skip ourselves and backtrace
        j=2,i-=j;
    else
        j=0;
    backtrace_symbols_fd(backaddr+j,  i, 2);
    (void)fsync(2);

    // try to write it to a file as well, in case the rest doesn't make it out.
    // Do it second, in case we get a second failure (more likely).
    // We might eventually want to print some more of the registers to the
    // btr file, to aid debugging, but not for now.
    // Truncate the program name if overly long, so we always get pid and (at least part of)
    // hostname.
    (void)gethostname(hname, sizeof hname);
    hname[sizeof(hname) - 1] = '\0';
    snprintf(fname, sizeof fname, "%s.80s-%u,%.32s.btr", __progname, getpid(), hname);
    if((fd=open(fname, O_CREAT|O_WRONLY, 0644))>=0) {
        write_result = write(fd, buf, id);
        backtrace_symbols_fd(backaddr+j,  i, fd);
        (void)fsync(fd);
        (void)close(fd);
    }
    exit(1); // not _exit(), want atexit handlers to get run
}

static struct sigaction sigsegv_act;
static struct sigaction sigbus_act;
static struct sigaction sigill_act;
static struct sigaction sigabrt_act;
static struct sigaction sigint_act;
static struct sigaction sigterm_act;

// we do this as a constructor so any user program that sets signal
// handlers for these will override our settings, but we still
// get backtraces if they don't
static void init_ipath_backtrace(void)
{
    // we need to track memory corruption
    static struct sigaction act; // easier than memset
    act.sa_sigaction = ipath_sighdlr;
    act.sa_flags = SA_SIGINFO;

    if(!getenv("IPATH_NO_BACKTRACE"))  {// permanent, although probably
        // undocumented way to disable backtraces.
        (void)sigaction(SIGSEGV, &act, &sigsegv_act);
        (void)sigaction(SIGBUS,  &act, &sigbus_act);
        (void)sigaction(SIGILL,  &act, &sigill_act);
        (void)sigaction(SIGABRT, &act, &sigabrt_act);
        (void)sigaction(SIGINT,  &act, &sigint_act);
        (void)sigaction(SIGTERM, &act, &sigterm_act);
    }
}

static void fini_ipath_backtrace(void)
{
    if(!getenv("IPATH_NO_BACKTRACE"))  {
        (void)sigaction(SIGSEGV, &sigsegv_act, NULL);
        (void)sigaction(SIGBUS,  &sigbus_act, NULL);
        (void)sigaction(SIGILL,  &sigill_act, NULL);
        (void)sigaction(SIGABRT, &sigabrt_act, NULL);
        (void)sigaction(SIGINT,  &sigint_act, NULL);
        (void)sigaction(SIGTERM, &sigterm_act, NULL);
    }
}

// if IPATH_DEBUG_FILENAME is set in the environment, then all the
// debug prints (not info and error) will go to that file.
// %h is expanded to the hostname, and %p to the pid, if present.
static void init_ipath_dbgfile(void)
{
	char *fname = getenv("IPATH_DEBUG_FILENAME");
	char *exph, *expp, tbuf[1024];
	FILE *newf;

	if(!fname) {
		__ipath_dbgout = stdout;
		return;
	}
	exph = strstr(fname, "%h"); // hostname
	expp = strstr(fname, "%p"); // pid
	if(exph || expp) {
		int baselen;
		char hname[256], pid[12];
		if(exph) {
			*hname = hname[sizeof(hname)-1] = 0;
			gethostname(hname, sizeof(hname)-1);
			if(!*hname)
				strcpy(hname, "[unknown]");
		}
		if(expp)
			snprintf(pid, sizeof pid, "%d", getpid());
		if(exph && expp) {
			if(exph < expp) {
				baselen = exph - fname;
				snprintf(tbuf, sizeof tbuf, "%.*s%s%.*s%s%s",
					baselen, fname, hname, 
					(int)(expp - (exph+2)), exph+2, pid, expp+2);
			}
			else {
				baselen = expp - fname;
				snprintf(tbuf, sizeof tbuf, "%.*s%s%.*s%s%s",
					baselen, fname, pid, 
					(int)(exph - (expp+2)), expp+2, hname, exph+2);
			}
		}
		else if(exph) {
			baselen = exph - fname;
			snprintf(tbuf, sizeof tbuf, "%.*s%s%s",
				baselen, fname, hname, exph+2);
		}
		else {
			baselen = expp - fname;
			snprintf(tbuf, sizeof tbuf, "%.*s%s%s",
				baselen, fname, pid, expp+2);
		}
		fname = tbuf;
	}
	newf = fopen(fname, "a");
	if(!newf) {
		_IPATH_ERROR("Unable to open \"%s\" for debug output, using stdout: %s\n",
			fname, strerror(errno));
		__ipath_dbgout = stdout;
	}
	else {
		__ipath_dbgout = newf;
		setlinebuf(__ipath_dbgout);
	}
}

void ipath_set_mylabel(char* label)
{
    __ipath_mylabel = label;
}

char *ipath_get_mylabel()
{
    return __ipath_mylabel;
}