coroutine-ucontext.c 5.06 KB
Newer Older
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
/*
 * ucontext coroutine initialization code
 *
 * Copyright (C) 2006  Anthony Liguori <anthony@codemonkey.ws>
 * Copyright (C) 2011  Kevin Wolf <kwolf@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.0 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */

/* XXX Is there a nicer way to disable glibc's stack check for longjmp? */
#ifdef _FORTIFY_SOURCE
#undef _FORTIFY_SOURCE
#endif
#include <stdlib.h>
#include <setjmp.h>
#include <stdint.h>
#include <ucontext.h>
#include "qemu-common.h"
30
#include "block/coroutine_int.h"
31

32 33 34 35
#ifdef CONFIG_VALGRIND_H
#include <valgrind/valgrind.h>
#endif

36 37 38
typedef struct {
    Coroutine base;
    void *stack;
39
    sigjmp_buf env;
40 41 42 43 44

#ifdef CONFIG_VALGRIND_H
    unsigned int valgrind_stack_id;
#endif

45 46 47 48 49
} CoroutineUContext;

/**
 * Per-thread coroutine bookkeeping
 */
50 51
static __thread CoroutineUContext leader;
static __thread Coroutine *current;
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

/*
 * va_args to makecontext() must be type 'int', so passing
 * the pointer we need may require several int args. This
 * union is a quick hack to let us do that
 */
union cc_arg {
    void *p;
    int i[2];
};

static void coroutine_trampoline(int i0, int i1)
{
    union cc_arg arg;
    CoroutineUContext *self;
    Coroutine *co;

    arg.i[0] = i0;
    arg.i[1] = i1;
    self = arg.p;
    co = &self->base;

    /* Initialize longjmp environment and switch back the caller */
75 76
    if (!sigsetjmp(self->env, 0)) {
        siglongjmp(*(sigjmp_buf *)co->entry_arg, 1);
77 78 79 80 81 82 83 84
    }

    while (true) {
        co->entry(co->entry_arg);
        qemu_coroutine_switch(co, co->caller, COROUTINE_TERMINATE);
    }
}

85
Coroutine *qemu_coroutine_new(void)
86 87 88 89
{
    const size_t stack_size = 1 << 20;
    CoroutineUContext *co;
    ucontext_t old_uc, uc;
90
    sigjmp_buf old_env;
malc's avatar
malc committed
91
    union cc_arg arg = {0};
92

93 94 95 96 97 98
    /* The ucontext functions preserve signal masks which incurs a
     * system call overhead.  sigsetjmp(buf, 0)/siglongjmp() does not
     * preserve signal masks but only works on the current stack.
     * Since we need a way to create and switch to a new stack, use
     * the ucontext functions for that but sigsetjmp()/siglongjmp() for
     * everything else.
99 100 101 102 103 104
     */

    if (getcontext(&uc) == -1) {
        abort();
    }

105 106
    co = g_malloc0(sizeof(*co));
    co->stack = g_malloc(stack_size);
107 108 109 110 111 112 113
    co->base.entry_arg = &old_env; /* stash away our jmp_buf */

    uc.uc_link = &old_uc;
    uc.uc_stack.ss_sp = co->stack;
    uc.uc_stack.ss_size = stack_size;
    uc.uc_stack.ss_flags = 0;

114 115 116 117 118
#ifdef CONFIG_VALGRIND_H
    co->valgrind_stack_id =
        VALGRIND_STACK_REGISTER(co->stack, co->stack + stack_size);
#endif

119 120 121 122 123
    arg.p = co;

    makecontext(&uc, (void (*)(void))coroutine_trampoline,
                2, arg.i[0], arg.i[1]);

124 125
    /* swapcontext() in, siglongjmp() back out */
    if (!sigsetjmp(old_env, 0)) {
126 127 128 129 130
        swapcontext(&old_uc, &uc);
    }
    return &co->base;
}

131
#ifdef CONFIG_VALGRIND_H
132
#ifdef CONFIG_PRAGMA_DIAGNOSTIC_AVAILABLE
133
/* Work around an unused variable in the valgrind.h macro... */
134
#pragma GCC diagnostic push
135
#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
136
#endif
137 138 139 140
static inline void valgrind_stack_deregister(CoroutineUContext *co)
{
    VALGRIND_STACK_DEREGISTER(co->valgrind_stack_id);
}
141
#ifdef CONFIG_PRAGMA_DIAGNOSTIC_AVAILABLE
142
#pragma GCC diagnostic pop
143
#endif
144
#endif
145

146 147 148 149
void qemu_coroutine_delete(Coroutine *co_)
{
    CoroutineUContext *co = DO_UPCAST(CoroutineUContext, base, co_);

150 151 152 153
#ifdef CONFIG_VALGRIND_H
    valgrind_stack_deregister(co);
#endif

154 155
    g_free(co->stack);
    g_free(co);
156 157
}

158 159 160 161 162 163 164 165 166 167 168
/* This function is marked noinline to prevent GCC from inlining it
 * into coroutine_trampoline(). If we allow it to do that then it
 * hoists the code to get the address of the TLS variable "current"
 * out of the while() loop. This is an invalid transformation because
 * the sigsetjmp() call may be called when running thread A but
 * return in thread B, and so we might be in a different thread
 * context each time round the loop.
 */
CoroutineAction __attribute__((noinline))
qemu_coroutine_switch(Coroutine *from_, Coroutine *to_,
                      CoroutineAction action)
169 170 171 172 173
{
    CoroutineUContext *from = DO_UPCAST(CoroutineUContext, base, from_);
    CoroutineUContext *to = DO_UPCAST(CoroutineUContext, base, to_);
    int ret;

174
    current = to_;
175

176
    ret = sigsetjmp(from->env, 0);
177
    if (ret == 0) {
178
        siglongjmp(to->env, action);
179 180 181 182 183 184
    }
    return ret;
}

Coroutine *qemu_coroutine_self(void)
{
185 186 187 188
    if (!current) {
        current = &leader.base;
    }
    return current;
189 190 191 192
}

bool qemu_in_coroutine(void)
{
193
    return current && current->caller;
194
}