4c1fa60e2e32db5fdf53f87a6bd87c57ba9724c6
[kopensolaris-gnu/glibc.git] / sysdeps / mach / hurd / i386 / trampoline.c
1 /* Set thread_state for sighandler, and sigcontext to recover.  i386 version.
2    Copyright (C) 1994, 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #include <hurd/signal.h>
21 #include <hurd/userlink.h>
22 #include "thread_state.h"
23 #include <assert.h>
24 #include <errno.h>
25 #include "hurdfault.h"
26 #include "intr-msg.h"
27
28
29 struct sigcontext *
30 _hurd_setup_sighandler (struct hurd_sigstate *ss, __sighandler_t handler,
31                         int signo, struct hurd_signal_detail *detail,
32                         volatile int rpc_wait,
33                         struct machine_thread_all_state *state)
34 {
35   __label__ trampoline, rpc_wait_trampoline, firewall;
36   extern const void _hurd_intr_rpc_msg_in_trap;
37   extern const void _hurd_intr_rpc_msg_cx_sp;
38   extern const void _hurd_intr_rpc_msg_sp_restored;
39   void *volatile sigsp;
40   struct sigcontext *scp;
41   struct
42     {
43       int signo;
44       long int sigcode;
45       struct sigcontext *scp;   /* Points to ctx, below.  */
46       void *sigreturn_addr;
47       void *sigreturn_returns_here;
48       struct sigcontext *return_scp; /* Same; arg to sigreturn.  */
49       struct sigcontext ctx;
50       struct hurd_userlink link;
51     } *stackframe;
52
53   if (ss->context)
54     {
55       /* We have a previous sigcontext that sigreturn was about
56          to restore when another signal arrived.  We will just base
57          our setup on that.  */
58       if (! _hurdsig_catch_memory_fault (ss->context))
59         {
60           memcpy (&state->basic, &ss->context->sc_i386_thread_state,
61                   sizeof (state->basic));
62           memcpy (&state->fpu, &ss->context->sc_i386_float_state,
63                   sizeof (state->fpu));
64           state->set |= (1 << i386_THREAD_STATE) | (1 << i386_FLOAT_STATE);
65         }
66     }
67
68   if (! machine_get_basic_state (ss->thread, state))
69     return NULL;
70
71   /* Save the original SP in the gratuitous `esp' slot.
72      We may need to reset the SP (the `uesp' slot) to avoid clobbering an
73      interrupted RPC frame.  */
74   state->basic.esp = state->basic.uesp;
75
76   if ((ss->actions[signo].sa_flags & SA_ONSTACK) &&
77       !(ss->sigaltstack.ss_flags & (SS_DISABLE|SS_ONSTACK)))
78     {
79       sigsp = ss->sigaltstack.ss_sp + ss->sigaltstack.ss_size;
80       ss->sigaltstack.ss_flags |= SS_ONSTACK;
81       /* XXX need to set up base of new stack for
82          per-thread variables, cthreads.  */
83     }
84   /* This code has intimate knowledge of the special mach_msg system call
85      done in intr-msg.c; that code does (see intr-msg.h):
86                                         movl %esp, %ecx
87                                         leal ARGS, %esp
88         _hurd_intr_rpc_msg_cx_sp:       movl $-25, %eax
89         _hurd_intr_rpc_msg_do_trap:     lcall $7, $0
90         _hurd_intr_rpc_msg_in_trap:     movl %ecx, %esp
91         _hurd_intr_rpc_msg_sp_restored:
92      We must check for the window during which %esp points at the
93      mach_msg arguments.  The space below until %ecx is used by
94      the _hurd_intr_rpc_mach_msg frame, and must not be clobbered.  */
95   else if (state->basic.eip >= (int) &_hurd_intr_rpc_msg_cx_sp &&
96            state->basic.eip < (int) &_hurd_intr_rpc_msg_sp_restored)
97     /* The SP now points at the mach_msg args, but there is more stack
98        space used below it.  The real SP is saved in %ecx; we must push the
99        new frame below there, and restore that value as the SP on
100        sigreturn.  */
101     sigsp = (char *) (state->basic.uesp = state->basic.ecx);
102   else
103     sigsp = (char *) state->basic.uesp;
104
105   /* Push the arguments to call `trampoline' on the stack.  */
106   sigsp -= sizeof (*stackframe);
107   stackframe = sigsp;
108
109   if (_hurdsig_catch_memory_fault (stackframe))
110     {
111       /* We got a fault trying to write the stack frame.
112          We cannot set up the signal handler.
113          Returning NULL tells our caller, who will nuke us with a SIGILL.  */
114       return NULL;
115     }
116   else
117     {
118       int ok;
119
120       extern void _hurdsig_longjmp_from_handler (void *, jmp_buf, int);
121
122       /* Add a link to the thread's active-resources list.  We mark this as
123          the only user of the "resource", so the cleanup function will be
124          called by any longjmp which is unwinding past the signal frame.
125          The cleanup function (in sigunwind.c) will make sure that all the
126          appropriate cleanups done by sigreturn are taken care of.  */
127       stackframe->link.cleanup = &_hurdsig_longjmp_from_handler;
128       stackframe->link.cleanup_data = &stackframe->ctx;
129       stackframe->link.resource.next = NULL;
130       stackframe->link.resource.prevp = NULL;
131       stackframe->link.thread.next = ss->active_resources;
132       stackframe->link.thread.prevp = &ss->active_resources;
133       if (stackframe->link.thread.next)
134         stackframe->link.thread.next->thread.prevp
135           = &stackframe->link.thread.next;
136       ss->active_resources = &stackframe->link;
137
138       /* Set up the arguments for the signal handler.  */
139       stackframe->signo = signo;
140       stackframe->sigcode = detail->code;
141       stackframe->scp = stackframe->return_scp = scp = &stackframe->ctx;
142       stackframe->sigreturn_addr = &__sigreturn;
143       stackframe->sigreturn_returns_here = &&firewall; /* Crash on return.  */
144
145       /* Set up the sigcontext from the current state of the thread.  */
146
147       scp->sc_onstack = ss->sigaltstack.ss_flags & SS_ONSTACK ? 1 : 0;
148
149       /* struct sigcontext is laid out so that starting at sc_gs mimics a
150          struct i386_thread_state.  */
151       memcpy (&scp->sc_i386_thread_state,
152               &state->basic, sizeof (state->basic));
153
154       /* struct sigcontext is laid out so that starting at sc_fpkind mimics
155          a struct i386_float_state.  */
156       ok = machine_get_state (ss->thread, state, i386_FLOAT_STATE,
157                               &state->fpu, &scp->sc_i386_float_state,
158                               sizeof (state->fpu));
159
160       _hurdsig_end_catch_fault ();
161
162       if (! ok)
163         return NULL;
164     }
165
166   /* Modify the thread state to call the trampoline code on the new stack.  */
167   if (rpc_wait)
168     {
169       /* The signalee thread was blocked in a mach_msg_trap system call,
170          still waiting for a reply.  We will have it run the special
171          trampoline code which retries the message receive before running
172          the signal handler.
173
174          To do this we change the OPTION argument on its stack to enable only
175          message reception, since the request message has already been
176          sent.  */
177
178       struct mach_msg_trap_args *args = (void *) state->basic.esp;
179
180       if (_hurdsig_catch_memory_fault (args))
181         {
182           /* Faulted accessing ARGS.  Bomb.  */
183           return NULL;
184         }
185
186       assert (args->option & MACH_RCV_MSG);
187       /* Disable the message-send, since it has already completed.  The
188          calls we retry need only wait to receive the reply message.  */
189       args->option &= ~MACH_SEND_MSG;
190
191       /* Limit the time to receive the reply message, in case the server
192          claimed that `interrupt_operation' succeeded but in fact the RPC
193          is hung.  */
194       args->option |= MACH_RCV_TIMEOUT;
195       args->timeout = _hurd_interrupted_rpc_timeout;
196
197       _hurdsig_end_catch_fault ();
198
199       state->basic.eip = (int) &&rpc_wait_trampoline;
200       /* The reply-receiving trampoline code runs initially on the original
201          user stack.  We pass it the signal stack pointer in %ebx.  */
202       state->basic.uesp = state->basic.esp; /* Restore mach_msg syscall SP.  */
203       state->basic.ebx = (int) sigsp;
204       /* After doing the message receive, the trampoline code will need to
205          update the %eax value to be restored by sigreturn.  To simplify
206          the assembly code, we pass the address of its slot in SCP to the
207          trampoline code in %ecx.  */
208       state->basic.ecx = (int) &scp->sc_eax;
209     }
210   else
211     {
212       state->basic.eip = (int) &&trampoline;
213       state->basic.uesp = (int) sigsp;
214     }
215   /* We pass the handler function to the trampoline code in %edx.  */
216   state->basic.edx = (int) handler;
217
218   return scp;
219
220   /* The trampoline code follows.  This is not actually executed as part of
221      this function, it is just convenient to write it that way.  */
222
223  rpc_wait_trampoline:
224   /* This is the entry point when we have an RPC reply message to receive
225      before running the handler.  The MACH_MSG_SEND bit has already been
226      cleared in the OPTION argument on our stack.  The interrupted user
227      stack pointer has not been changed, so the system call can find its
228      arguments; the signal stack pointer is in %ebx.  For our convenience,
229      %ecx points to the sc_eax member of the sigcontext.  */
230   asm volatile
231     (/* Retry the interrupted mach_msg system call.  */
232      "movl $-25, %eax\n"        /* mach_msg_trap */
233      "lcall $7, $0\n"
234      /* When the sigcontext was saved, %eax was MACH_RCV_INTERRUPTED.  But
235         now the message receive has completed and the original caller of
236         the RPC (i.e. the code running when the signal arrived) needs to
237         see the final return value of the message receive in %eax.  So
238         store the new %eax value into the sc_eax member of the sigcontext
239         (whose address is in %ecx to make this code simpler).  */
240      "movl %eax, (%ecx)\n"
241      /* Switch to the signal stack.  */
242      "movl %ebx, %esp\n");
243
244  trampoline:
245   /* Entry point for running the handler normally.  The arguments to the
246      handler function are already on the top of the stack:
247
248        0(%esp)  SIGNO
249        4(%esp)  SIGCODE
250        8(%esp)  SCP
251      */
252   asm volatile
253     ("call *%edx\n"             /* Call the handler function.  */
254      "addl $12, %esp\n"         /* Pop its args.  */
255      /* The word at the top of stack is &__sigreturn; following are a dummy
256         word to fill the slot for the address for __sigreturn to return to,
257         and a copy of SCP for __sigreturn's argument.  "Return" to calling
258         __sigreturn (SCP); this call never returns.  */
259      "ret");
260
261  firewall:
262   asm volatile ("hlt");
263
264   /* NOTREACHED */
265   return NULL;
266 }