makecontext(3) [posix man page]

MAKECONTEXT(P)						     POSIX Programmer's Manual						    MAKECONTEXT(P)

NAME

       makecontext, swapcontext - manipulate user contexts

SYNOPSIS

       #include <ucontext.h>

       void makecontext(ucontext_t *ucp, void (*func)(void),
	      int argc, ...);
       int swapcontext(ucontext_t *restrict oucp,
	      const ucontext_t *restrict ucp);

DESCRIPTION

       The  makecontext() function shall modify the context specified by ucp, which has been initialized using getcontext().  When this context is
       resumed using swapcontext() or setcontext(), program execution shall continue by calling func, passing it the arguments that follow argc in
       the makecontext() call.

       Before  a  call	is  made  to makecontext(), the application shall ensure that the context being modified has a stack allocated for it. The
       application shall ensure that the value of argc matches the number of arguments of type int passed to  func;  otherwise,  the  behavior	is
       undefined.

       The  uc_link  member  is  used to determine the context that shall be resumed when the context being modified by makecontext() returns. The
       application shall ensure that the uc_link member is initialized prior to the call to makecontext().

       The swapcontext() function shall save the current context in the context structure pointed to by oucp and shall set the context to the con-
       text structure pointed to by ucp.

RETURN VALUE

       Upon successful completion, swapcontext() shall return 0. Otherwise, -1 shall be returned and errno set to indicate the error.

ERRORS

       The swapcontext() function shall fail if:

       ENOMEM The ucp argument does not have enough stack left to complete the operation.

       The following sections are informative.

EXAMPLES

       The following example illustrates the use of makecontext():

	      #include <stdio.h>
	      #include <ucontext.h>

	      static ucontext_t ctx[3];

	      static void
	      f1 (void)
	      {
		  puts("start f1");
		  swapcontext(&ctx[1], &ctx[2]);
		  puts("finish f1");
	      }

	      static void
	      f2 (void)
	      {
		  puts("start f2");
		  swapcontext(&ctx[2], &ctx[1]);
		  puts("finish f2");
	      }

	      int
	      main (void)
	      {
		  char st1[8192];
		  char st2[8192];

		  getcontext(&ctx[1]);
		  ctx[1].uc_stack.ss_sp = st1;
		  ctx[1].uc_stack.ss_size = sizeof st1;
		  ctx[1].uc_link = &ctx[0];
		  makecontext(&ctx[1], f1, 0);

		  getcontext(&ctx[2]);
		  ctx[2].uc_stack.ss_sp = st2;
		  ctx[2].uc_stack.ss_size = sizeof st2;
		  ctx[2].uc_link = &ctx[1];
		  makecontext(&ctx[2], f2, 0);

		  swapcontext(&ctx[0], &ctx[2]);
		  return 0;
	      }

APPLICATION USAGE

       None.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       exit() , getcontext() , sigaction() , sigprocmask() , the Base Definitions volume of IEEE Std 1003.1-2001, <ucontext.h>

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol-
       ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
       Electrical  and	Electronics  Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE
       and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can  be  obtained
       online at http://www.opengroup.org/unix/online.html .

IEEE
/The Open Group						       2003							    MAKECONTEXT(P)

Check Out this Related Man Page

MAKECONTEXT(3)						     Linux Programmer's Manual						    MAKECONTEXT(3)

NAME

       makecontext, swapcontext - manipulate user context

SYNOPSIS

       #include <ucontext.h>

       void makecontext(ucontext_t *ucp, void *func(), int argc, ...);
       int swapcontext (ucontext_t *oucp, ucontext_t *ucp);

DESCRIPTION

       In a SysV-like environment, one has the type ucontext_t defined in <ucontext.h> and the four functions getcontext(), setcontext(), makecon-
       text() and swapcontext() that allow user-level context switching between multiple threads of control within a process.

       For the type and the first two functions, see getcontext(2).

       The makecontext() function modifies the context pointed to by ucp (which was obtained from a call to getcontext()).  Before  calling  make-
       context(),  one	should	allocate  a  new  stack for this context, assigning to ucp->uc_stack, and define a successor context, assigning to
       ucp->uc_link.  When this context is later activated (using setcontext() or swapcontext()) then first the function func is called, with  the
       arguments  specified  following argc (where argc must contain the number of these arguments), and when this function returns, the successor
       context is activated. When the successor context pointer is NULL, the thread exits.

       The swapcontext() function saves the current context in the structure pointed to by oucp, and then activates the context pointed to by ucp.

RETURN VALUE

       When successful, makecontext() returns 0 and swapcontext() does not return. (But we may return later, in case oucp is activated,  in  which
       case it looks like swapcontext() returns 0.)  On error, both return -1 and set errno appropriately.

ERRORS

       ENOMEM Insufficient stack space left.

NOTES

       The interpretation of ucp->uc_stack is just as in sigaltstack(2), namely, this struct contains start and length of a memory area to be used
       as stack, regardless of the direction of growth of the stack. So, it is not necessary for the user program to worry about this direction.

CONFORMING TO

       SUSv2, POSIX 1003.1-2001.

SEE ALSO

       getcontext(2), sigaction(2), sigaltstack(2), sigprocmask(2), sigsetjmp(3)

Linux 2.4							    2001-11-15							    MAKECONTEXT(3)

Linux and UNIX Man Pages

makecontext(3) [posix man page]

Check Out this Related Man Page