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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
|
/* exp_trap.c - Expect's trap command
Written by: Don Libes, NIST, 9/1/93
Design and implementation of this program was paid for by U.S. tax
dollars. Therefore it is public domain. However, the author and NIST
would appreciate credit if this program or parts of it are used.
*/
#include "expect_cf.h"
#include <stdio.h>
#include <signal.h>
#include <sys/types.h>
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#if defined(SIGCLD) && !defined(SIGCHLD)
#define SIGCHLD SIGCLD
#endif
#include "tcl.h"
#include "exp_rename.h"
#include "exp_prog.h"
#include "exp_command.h"
#include "exp_log.h"
#ifdef TCL_DEBUGGER
#include "tcldbg.h"
#endif
#define NO_SIG 0
static struct trap {
char *action; /* Tcl command to execute upon sig */
/* Each is handled by the eval_trap_action */
int mark; /* TRUE if signal has occurred */
Tcl_Interp *interp; /* interp to use or 0 if we should use the */
/* interpreter active at the time the sig */
/* is processed */
int code; /* return our new code instead of code */
/* available when signal is processed */
CONST char *name; /* name of signal */
int reserved; /* if unavailable for trapping */
} traps[NSIG];
int sigchld_count = 0; /* # of sigchlds caught but not yet processed */
static int eval_trap_action();
static int got_sig; /* this records the last signal received */
/* it is only a hint and can be wiped out */
/* by multiple signals, but it will always */
/* be left with a valid signal that is */
/* pending */
static Tcl_AsyncHandler async_handler;
static CONST char *
signal_to_string(sig)
int sig;
{
if (sig <= 0 || sig > NSIG) return("SIGNAL OUT OF RANGE");
return(traps[sig].name);
}
/* current sig being processed by user sig handler */
static int current_sig = NO_SIG;
int exp_nostack_dump = FALSE; /* TRUE if user has requested unrolling of */
/* stack with no trace */
/*ARGSUSED*/
static int
tophalf(clientData,interp,code)
ClientData clientData;
Tcl_Interp *interp;
int code;
{
struct trap *trap; /* last trap processed */
int rc;
int i;
Tcl_Interp *sig_interp;
expDiagLog("sighandler: handling signal(%d)\r\n",got_sig);
if (got_sig <= 0 || got_sig >= NSIG) {
expErrorLog("caught impossible signal %d\r\n",got_sig);
abort();
}
/* start to work on this sig. got_sig can now be overwritten */
/* and it won't cause a problem */
current_sig = got_sig;
trap = &traps[current_sig];
trap->mark = FALSE;
/* decrement below looks dangerous */
/* Don't we need to temporarily block bottomhalf? */
if (current_sig == SIGCHLD) {
sigchld_count--;
expDiagLog("sigchld_count-- == %d\n",sigchld_count);
}
if (!trap->action) {
/* In this one case, we let ourselves be called when no */
/* signaler predefined, since we are calling explicitly */
/* from another part of the program, and it is just simpler */
if (current_sig == 0) return code;
expErrorLog("caught unexpected signal: %s (%d)\r\n",
signal_to_string(current_sig),current_sig);
abort();
}
if (trap->interp) {
/* if trap requested original interp, use it */
sig_interp = trap->interp;
} else if (interp) {
/* else if another interp is available, use it */
sig_interp = interp;
} else {
/* fall back to exp_interp */
sig_interp = exp_interp;
}
rc = eval_trap_action(sig_interp,current_sig,trap,code);
current_sig = NO_SIG;
/*
* scan for more signals to process
*/
/* first check for additional SIGCHLDs */
if (sigchld_count) {
got_sig = SIGCHLD;
traps[SIGCHLD].mark = TRUE;
Tcl_AsyncMark(async_handler);
} else {
got_sig = -1;
for (i=1;i<NSIG;i++) {
if (traps[i].mark) {
got_sig = i;
Tcl_AsyncMark(async_handler);
break;
}
}
}
return rc;
}
#ifdef REARM_SIG
int sigchld_sleep;
static int rearm_sigchld = FALSE; /* TRUE if sigchld needs to be */
/* rearmed (i.e., because it has */
/* just gone off) */
static int rearming_sigchld = FALSE;
#endif
/* called upon receipt of a user-declared signal */
static void
bottomhalf(sig)
int sig;
{
#ifdef REARM_SIG
/*
* tiny window of death if same signal should arrive here
* before we've reinstalled it
*/
/* In SV, sigchld must be rearmed after wait to avoid recursion */
if (sig != SIGCHLD) {
signal(sig,bottomhalf);
} else {
/* request rearm */
rearm_sigchld = TRUE;
if (rearming_sigchld) sigchld_sleep = TRUE;
}
#endif
traps[sig].mark = TRUE;
got_sig = sig; /* just a hint - can be wiped out by another */
Tcl_AsyncMark(async_handler);
/* if we are called while this particular async is being processed */
/* original async_proc will turn off "mark" so that when async_proc */
/* is recalled, it will see that nothing was left to do */
/* In case of SIGCHLD though, we must recall it as many times as
* we have received it.
*/
if (sig == SIGCHLD) {
sigchld_count++;
}
#if 0
/* if we are doing an i_read, restart it */
#ifdef HAVE_SIGLONGJMP
if (env_valid && (sig != 0)) siglongjmp(env,2);
#else
if (env_valid && (sig != 0)) longjmp(env,2);
#endif /* HAVE_SIGLONGJMP */
#endif /* 0 */
}
/*ARGSUSED*/
void
exp_rearm_sigchld(interp)
Tcl_Interp *interp;
{
#ifdef REARM_SIG
if (rearm_sigchld) {
rearm_sigchld = FALSE;
rearming_sigchld = TRUE;
signal(SIGCHLD,bottomhalf);
}
rearming_sigchld = FALSE;
/* if the rearming immediately caused another SIGCHLD, slow down */
/* It's probably one of Tcl's intermediary pipeline processes that */
/* Tcl hasn't caught up with yet. */
if (sigchld_sleep) {
exp_dsleep(interp,0.2);
sigchld_sleep = FALSE;
}
#endif
}
void
exp_init_trap()
{
int i;
for (i=1;i<NSIG;i++) {
traps[i].name = Tcl_SignalId(i);
traps[i].action = 0;
traps[i].reserved = FALSE;
}
/*
* fix up any special cases
*/
#if defined(SIGCLD)
/* Tcl names it SIGCLD, not good for portable scripts */
traps[SIGCLD].name = "SIGCHLD";
#endif
#if defined(SIGALRM)
traps[SIGALRM].reserved = TRUE;
#endif
#if defined(SIGKILL)
traps[SIGKILL].reserved = TRUE;
#endif
#if defined(SIGSTOP)
traps[SIGSTOP].reserved = TRUE;
#endif
#if defined(SIGSEGV)
traps[SIGSEGV].reserved = TRUE;
#endif
#if defined(SIGBUS)
traps[SIGBUS].reserved = TRUE;
#endif
#if defined(SIGILL)
traps[SIGILL].reserved = TRUE;
#endif
#if defined(SIGFPE)
traps[SIGFPE].reserved = TRUE;
#endif
async_handler = Tcl_AsyncCreate(tophalf,(ClientData)0);
}
/* given signal index or name as string, */
/* returns signal index or -1 if bad arg */
int
exp_string_to_signal(interp,s)
Tcl_Interp *interp;
char *s;
{
int sig;
CONST char *name;
/* try interpreting as an integer */
if (1 == sscanf(s,"%d",&sig)) {
if (sig > 0 && sig < NSIG) return sig;
} else {
/* try interpreting as a string */
for (sig=1;sig<NSIG;sig++) {
name = traps[sig].name;
if (streq(s,name) || streq(s,name+3)) return(sig);
}
}
exp_error(interp,"invalid signal %s",s);
return -1;
}
/*ARGSUSED*/
int
Exp_TrapObjCmd(clientData, interp, objc, objv)
ClientData clientData;
Tcl_Interp *interp;
int objc;
Tcl_Obj *CONST objv[];
{
char *action = 0;
int n; /* number of signals in list */
Tcl_Obj **list; /* list of signals */
char *arg;
int len; /* length of action */
int i;
int show_name = FALSE; /* if user asked for current sig by name */
int show_number = FALSE;/* if user asked for current sig by number */
int show_max = FALSE; /* if user asked for NSIG-1 */
int rc = TCL_OK;
int new_code = FALSE; /* if action result should overwrite orig */
Tcl_Interp *new_interp = interp;/* interp in which to evaluate */
/* action when signal occurs */
objc--; objv++;
while (objc) {
arg = Tcl_GetString(*objv);
if (streq(arg,"-code")) {
objc--; objv++;
new_code = TRUE;
} else if (streq(arg,"-interp")) {
objc--; objv++;
new_interp = 0;
} else if (streq(arg,"-name")) {
objc--; objv++;
show_name = TRUE;
} else if (streq(arg,"-number")) {
objc--; objv++;
show_number = TRUE;
} else if (streq(arg,"-max")) {
objc--; objv++;
show_max = TRUE;
} else break;
}
if (show_name || show_number || show_max) {
if (objc > 0) goto usage_error;
if (show_max) {
Tcl_SetObjResult(interp,Tcl_NewIntObj(NSIG-1));
}
if (current_sig == NO_SIG) {
Tcl_SetResult(interp,"no signal in progress",TCL_STATIC);
return TCL_ERROR;
}
if (show_name) {
/* skip over "SIG" */
/* TIP 27: Casting away the CONST should be ok because of TCL_STATIC
*/
Tcl_SetResult(interp,(char*)signal_to_string(current_sig) + 3,TCL_STATIC);
} else {
Tcl_SetObjResult(interp,Tcl_NewIntObj(current_sig));
}
return TCL_OK;
}
if (objc == 0 || objc > 2) goto usage_error;
if (objc == 1) {
int sig = exp_string_to_signal(interp,arg);
if (sig == -1) return TCL_ERROR;
if (traps[sig].action) {
Tcl_SetResult(interp,traps[sig].action,TCL_STATIC);
} else {
Tcl_SetResult(interp,"SIG_DFL",TCL_STATIC);
}
return TCL_OK;
}
action = arg;
/* objv[1] is the list of signals - crack it open */
if (TCL_OK != Tcl_ListObjGetElements(interp,objv[1],&n,&list)) {
return TCL_ERROR;
}
for (i=0;i<n;i++) {
char *s;
int sig;
s = Tcl_GetString(list[i]);
sig = exp_string_to_signal(interp,s);
if (sig == -1) {
rc = TCL_ERROR;
break;
}
if (traps[sig].reserved) {
exp_error(interp,"cannot trap %s",signal_to_string(sig));
rc = TCL_ERROR;
break;
}
expDiagLog("trap: setting up signal %d (\"%s\")\r\n",sig,s);
if (traps[sig].action) ckfree(traps[sig].action);
if (streq(action,"SIG_DFL")) {
/* should've been free'd by now if nec. */
traps[sig].action = 0;
signal(sig,SIG_DFL);
#ifdef REARM_SIG
if (sig == SIGCHLD)
rearm_sigchld = FALSE;
#endif /*REARM_SIG*/
} else {
len = 1 + strlen(action);
traps[sig].action = ckalloc(len);
memcpy(traps[sig].action,action,len);
traps[sig].interp = new_interp;
traps[sig].code = new_code;
if (streq(action,"SIG_IGN")) {
signal(sig,SIG_IGN);
} else signal(sig,bottomhalf);
}
}
/* It is no longer necessary to free the split list since it */
/* is still owned by Tcl, yes? */
/* ckfree((char *)list); */
return(rc);
usage_error:
exp_error(interp,"usage: trap [command or SIG_DFL or SIG_IGN] {list of signals}");
return TCL_ERROR;
}
/* called by tophalf() to process the given signal */
static int
eval_trap_action(interp,sig,trap,oldcode)
Tcl_Interp *interp;
int sig;
struct trap *trap;
int oldcode;
{
int code_flag;
int newcode;
Tcl_Obj *eip; /* errorInfo */
Tcl_Obj *ecp; /* errorCode */
Tcl_Obj *irp; /* interp's result */
expDiagLogU("async event handler: Tcl_Eval(");
expDiagLogU(trap->action);
expDiagLogU(")\r\n");
/* save to prevent user from redefining trap->code while trap */
/* is executing */
code_flag = trap->code;
if (!code_flag) {
/*
* save return values
*/
eip = Tcl_GetVar2Ex(interp,"errorInfo","",TCL_GLOBAL_ONLY);
if (eip) eip = Tcl_DuplicateObj(eip);
ecp = Tcl_GetVar2Ex(interp,"errorCode","",TCL_GLOBAL_ONLY);
if (ecp) ecp = Tcl_DuplicateObj(ecp);
irp = Tcl_GetObjResult(interp);
if (irp) irp = Tcl_DuplicateObj(irp);
}
newcode = Tcl_GlobalEval(interp,trap->action);
/*
* if new code is to be ignored (usual case - see "else" below)
* allow only OK/RETURN from trap, otherwise complain
*/
if (code_flag) {
expDiagLog("return value = %d for trap %s, action ",newcode,signal_to_string(sig));
expDiagLogU(trap->action);
expDiagLogU("\r\n");
if (0 != strcmp(Tcl_GetStringResult(interp),"")) {
/*
* Check errorinfo and see if it contains -nostack.
* This shouldn't be necessary, but John changed the
* top level interp so that it distorts arbitrary
* return values into TCL_ERROR, so by the time we
* get back, we'll have lost the value of errorInfo
*/
eip = Tcl_GetVar2Ex(interp,"errorInfo","",TCL_GLOBAL_ONLY);
if (eip) {
exp_nostack_dump = (0 == strncmp("-nostack",Tcl_GetString(eip),8));
}
}
} else if (newcode != TCL_OK && newcode != TCL_RETURN) {
if (newcode != TCL_ERROR) {
exp_error(interp,"return value = %d for trap %s, action %s\r\n",newcode,signal_to_string(sig),trap->action);
}
Tcl_BackgroundError(interp);
}
if (!code_flag) {
/*
* restore values
*/
Tcl_ResetResult(interp); /* turns off Tcl's internal */
/* flags: ERR_IN_PROGRESS, ERROR_CODE_SET */
/* This also wipes clean errorInfo/Code/result which is why */
/* all the calls to Tcl_Dup earlier */
if (eip) {
/* odd that Tcl doesn't have a call that does all this at once */
int len;
char *s = Tcl_GetStringFromObj(eip,&len);
Tcl_AddObjErrorInfo(interp,s,len);
Tcl_DecrRefCount(eip);
/* we never incr'd it, but the code allows this */
} else {
Tcl_UnsetVar(interp,"errorInfo",0);
}
/* restore errorCode. Note that Tcl_AddErrorInfo (above) */
/* resets it to NONE. If the previous value is NONE, it's */
/* important to avoid calling Tcl_SetErrorCode since this */
/* with cause Tcl to set its internal ERROR_CODE_SET flag. */
if (ecp) {
if (!streq("NONE",Tcl_GetString(ecp)))
Tcl_SetErrorCode(interp,ecp);
/* we're just passing on the errorcode obj */
/* presumably, Tcl will incr ref count */
} else {
Tcl_UnsetVar(interp,"errorCode",0);
}
newcode = oldcode;
/* note that since newcode gets overwritten here by old code */
/* it is possible to return in the middle of a trap by using */
/* "return" (or "continue" for that matter)! */
}
return newcode;
}
static struct exp_cmd_data
cmd_data[] = {
{"trap", Exp_TrapObjCmd, 0, (ClientData)EXP_SPAWN_ID_BAD, 0},
{0}};
void
exp_init_trap_cmds(interp)
Tcl_Interp *interp;
{
exp_create_commands(interp,cmd_data);
}
|