x86_64/gen/makecontext.c

   1 /*
   2  * Copyright (c) 2007, 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * Copyright (c) 2001 Daniel M. Eischen <deischen@freebsd.org>
  26  * All rights reserved.
  27  *
  28  * Redistribution and use in source and binary forms, with or without
  29  * modification, are permitted provided that the following conditions
  30  * are met:
  31  * 1. Redistributions of source code must retain the above copyright
  32  *    notice, this list of conditions and the following disclaimer.
  33  * 2. Neither the name of the author nor the names of its contributors
  34  *    may be used to endorse or promote products derived from this software
  35  *    without specific prior written permission.
  36  *
  37  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  38  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  39  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  40  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  41  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  42  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  43  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  45  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  46  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47  * SUCH DAMAGE.
  48  */
  49
  50 #if defined(__x86_64__)
  51
  52 #define _XOPEN_SOURCE
  53 #include <sys/cdefs.h>
  54
  55 #include <sys/param.h>
  56 #include <sys/signal.h>
  57 #include <sys/ucontext.h>
  58
  59 #include <errno.h>
  60 #include <stdarg.h>
  61 #include <stdlib.h>
  62 #include <ucontext.h>
  63 #include <unistd.h>
  64
  65 /* Prototypes */
  66 extern void _ctx_start(ucontext_t *, int argc, ...);
  67
  68 void
  69 _ctx_done (ucontext_t *ucp)
  70 {
  71         if (ucp->uc_link == NULL)
  72                 exit(0);
  73         else {
  74                 /*
  75                  * Since this context has finished, don't allow it
  76                  * to be restarted without being reinitialized (via
  77                  * setcontext or swapcontext).
  78                  */
  79                 ucp->uc_mcsize = 0;
  80
  81                 /* Set context to next one in link */
  82                 /* XXX - what to do for error, abort? */
  83                 setcontext((const ucontext_t *)ucp->uc_link);
  84                 LIBC_ABORT("setcontext failed");        /* should never get here */
  85         }
  86 }
  87
  88 void
  89 makecontext(ucontext_t *ucp, void (*start)(), int argc, ...)
  90 {
  91         va_list         ap;
  92         char            *stack_top;
  93         intptr_t        *argp;
  94         int             i;
  95
  96         if (ucp == NULL)
  97                 return;
  98         else if ((ucp->uc_stack.ss_sp == NULL) ||
  99             (ucp->uc_stack.ss_size < MINSIGSTKSZ)) {
 100                 /*
 101                  * This should really return -1 with errno set to ENOMEM
 102                  * or something, but the spec says that makecontext is
 103                  * a void function.   At least make sure that the context
 104                  * isn't valid so it can't be used without an error.
 105                  */
 106                 ucp->uc_mcsize = 0;
 107         }
 108         /* XXX - Do we want to sanity check argc? */
 109         else if ((argc < 0) || (argc > NCARGS)) {
 110                 ucp->uc_mcsize = 0;
 111         }
 112         /* Make sure the context is valid. */
 113         else {
 114                 /*
 115                  * Arrange the stack as follows:
 116                  *
 117                  *      _ctx_start()    - context start wrapper
 118                  *      start()         - user start routine
 119                  *      arg1            - first argument, aligned(16)
 120                  *      ...
 121                  *      argn
 122                  *      ucp             - this context, %rbp points here
 123                  *
 124                  * When the context is started, control will return to
 125                  * the context start wrapper which will pop the user
 126                  * start routine from the top of the stack.  After that,
 127                  * the top of the stack will be setup with all arguments
 128                  * necessary for calling the start routine.  When the
 129                  * start routine returns, the context wrapper then sets
 130                  * the stack pointer to %rbp which was setup to point to
 131                  * the base of the stack (and where ucp is stored).  It
 132                  * will then call _ctx_done() to swap in the next context
 133                  * (uc_link != 0) or exit the program (uc_link == 0).
 134                  */
 135                 mcontext_t mc;
 136
 137                 stack_top = (char *)(ucp->uc_stack.ss_sp +
 138                     ucp->uc_stack.ss_size - sizeof(intptr_t));
 139
 140
 141                 /* Give 6 stack slots to _ctx_start */
 142                 int minargc = 6;
 143                 if (argc > minargc)
 144                         minargc = argc;
 145
 146                 /*
 147                  * Adjust top of stack to allow for 3 pointers (return
 148                  * address, _ctx_start, and ucp) and argc arguments.
 149                  * We allow the arguments to be pointers also.  The first
 150                  * argument to the user function must be properly aligned.
 151                  */
 152
 153                 stack_top = stack_top - (sizeof(intptr_t) * (1 + minargc));
 154                 stack_top = (char *)((intptr_t)stack_top & ~15);
 155                 stack_top = stack_top - (2 * sizeof(intptr_t));
 156                 argp = (intptr_t *)stack_top;
 157
 158                 /*
 159                  * Setup the top of the stack with the user start routine
 160                  * followed by all of its aguments and the pointer to the
 161                  * ucontext.  We need to leave a spare spot at the top of
 162                  * the stack because setcontext will move rip to the top
 163                  * of the stack before returning.
 164                  */
 165                 *argp = (intptr_t)_ctx_start;  /* overwritten with same value */
 166                 argp++;
 167                 *argp = (intptr_t)start;
 168                 argp++;
 169
 170                 /* Add all the arguments: */
 171                 va_start(ap, argc);
 172                 for (i = 0; i < argc; i++) {
 173                         *argp = va_arg(ap, intptr_t);
 174                         argp++;
 175                 }
 176                 va_end(ap);
 177
 178                 /* Always provide space for ctx_start to pop the parameter registers */
 179                 for (;argc < minargc; argc++) {
 180                         *argp++ = 0;
 181                 }
 182
 183                 /* Keep stack aligned */
 184                 if (argc & 1) {
 185                         *argp++ = 0;
 186                 }
 187
 188                 /* The ucontext is placed at the bottom of the stack. */
 189                 *argp = (intptr_t)ucp;
 190
 191                 /*
 192                  * Set the machine context to point to the top of the
 193                  * stack and the program counter to the context start
 194                  * wrapper.  Note that setcontext() pushes the return
 195                  * address onto the top of the stack, so allow for this
 196                  * by adjusting the stack downward 1 slot.  Also set
 197                  * %r12 to point to the base of the stack where ucp
 198                  * is stored.
 199                  */
 200                 mc = ucp->uc_mcontext;
 201                 /* Use callee-save and match _ctx_start implementation */
 202                 mc->__ss.__r12 = (intptr_t)argp;
 203                 mc->__ss.__rbp = 0;
 204                 mc->__ss.__rsp = (intptr_t)stack_top + sizeof(caddr_t);
 205                 mc->__ss.__rip = (intptr_t)_ctx_start;
 206         }
 207 }
 208
 209 #endif /* __x86_64__ */