sys/compat/linux/linux_fork.c

   1 /*-
   2  * Copyright (c) 2004 Tim J. Robbins
   3  * Copyright (c) 2002 Doug Rabson
   4  * Copyright (c) 2000 Marcel Moolenaar
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer
  12  *    in this position and unchanged.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include "opt_compat.h"
  33 #include "opt_kdtrace.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/imgact.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/proc.h>
  41 #include <sys/sched.h>
  42 #include <sys/sdt.h>
  43 #include <sys/sx.h>
  44 #include <sys/unistd.h>
  45 #include <sys/wait.h>
  46
  47 #ifdef COMPAT_LINUX32
  48 #include <machine/../linux32/linux.h>
  49 #include <machine/../linux32/linux32_proto.h>
  50 #else
  51 #include <machine/../linux/linux.h>
  52 #include <machine/../linux/linux_proto.h>
  53 #endif
  54 #include <compat/linux/linux_dtrace.h>
  55 #include <compat/linux/linux_signal.h>
  56 #include <compat/linux/linux_emul.h>
  57 #include <compat/linux/linux_misc.h>
  58
  59 /* DTrace init */
  60 LIN_SDT_PROVIDER_DECLARE(LINUX_DTRACE);
  61
  62 /* Linuxulator-global DTrace probes */
  63 LIN_SDT_PROBE_DECLARE(locks, emul_lock, locked);
  64 LIN_SDT_PROBE_DECLARE(locks, emul_lock, unlock);
  65
  66
  67 int
  68 linux_fork(struct thread *td, struct linux_fork_args *args)
  69 {
  70         int error;
  71         struct proc *p2;
  72         struct thread *td2;
  73
  74 #ifdef DEBUG
  75         if (ldebug(fork))
  76                 printf(ARGS(fork, ""));
  77 #endif
  78
  79         if ((error = fork1(td, RFFDG | RFPROC | RFSTOPPED, 0, &p2, NULL, 0))
  80             != 0)
  81                 return (error);
  82
  83         td->td_retval[0] = p2->p_pid;
  84         td->td_retval[1] = 0;
  85
  86         error = linux_proc_init(td, td->td_retval[0], 0);
  87         if (error)
  88                 return (error);
  89
  90         td2 = FIRST_THREAD_IN_PROC(p2);
  91
  92         /*
  93          * Make this runnable after we are finished with it.
  94          */
  95         thread_lock(td2);
  96         TD_SET_CAN_RUN(td2);
  97         sched_add(td2, SRQ_BORING);
  98         thread_unlock(td2);
  99
 100         return (0);
 101 }
 102
 103 int
 104 linux_vfork(struct thread *td, struct linux_vfork_args *args)
 105 {
 106         int error;
 107         struct proc *p2;
 108         struct thread *td2;
 109
 110 #ifdef DEBUG
 111         if (ldebug(vfork))
 112                 printf(ARGS(vfork, ""));
 113 #endif
 114
 115         if ((error = fork1(td, RFFDG | RFPROC | RFMEM | RFPPWAIT | RFSTOPPED,
 116             0, &p2, NULL, 0)) != 0)
 117                 return (error);
 118
 119         td->td_retval[0] = p2->p_pid;
 120
 121         error = linux_proc_init(td, td->td_retval[0], 0);
 122         if (error)
 123                 return (error);
 124
 125         td2 = FIRST_THREAD_IN_PROC(p2);
 126
 127         /*
 128          * Make this runnable after we are finished with it.
 129          */
 130         thread_lock(td2);
 131         TD_SET_CAN_RUN(td2);
 132         sched_add(td2, SRQ_BORING);
 133         thread_unlock(td2);
 134
 135         return (0);
 136 }
 137
 138 int
 139 linux_clone(struct thread *td, struct linux_clone_args *args)
 140 {
 141         int error, ff = RFPROC | RFSTOPPED;
 142         struct proc *p2;
 143         struct thread *td2;
 144         int exit_signal;
 145         struct linux_emuldata *em;
 146
 147 #ifdef DEBUG
 148         if (ldebug(clone)) {
 149                 printf(ARGS(clone, "flags %x, stack %p, parent tid: %p, "
 150                     "child tid: %p"), (unsigned)args->flags,
 151                     args->stack, args->parent_tidptr, args->child_tidptr);
 152         }
 153 #endif
 154
 155         exit_signal = args->flags & 0x000000ff;
 156         if (LINUX_SIG_VALID(exit_signal)) {
 157                 if (exit_signal <= LINUX_SIGTBLSZ)
 158                         exit_signal =
 159                             linux_to_bsd_signal[_SIG_IDX(exit_signal)];
 160         } else if (exit_signal != 0)
 161                 return (EINVAL);
 162
 163         if (args->flags & LINUX_CLONE_VM)
 164                 ff |= RFMEM;
 165         if (args->flags & LINUX_CLONE_SIGHAND)
 166                 ff |= RFSIGSHARE;
 167         /*
 168          * XXX: In Linux, sharing of fs info (chroot/cwd/umask)
 169          * and open files is independant.  In FreeBSD, its in one
 170          * structure but in reality it does not cause any problems
 171          * because both of these flags are usually set together.
 172          */
 173         if (!(args->flags & (LINUX_CLONE_FILES | LINUX_CLONE_FS)))
 174                 ff |= RFFDG;
 175
 176         /*
 177          * Attempt to detect when linux_clone(2) is used for creating
 178          * kernel threads. Unfortunately despite the existence of the
 179          * CLONE_THREAD flag, version of linuxthreads package used in
 180          * most popular distros as of beginning of 2005 doesn't make
 181          * any use of it. Therefore, this detection relies on
 182          * empirical observation that linuxthreads sets certain
 183          * combination of flags, so that we can make more or less
 184          * precise detection and notify the FreeBSD kernel that several
 185          * processes are in fact part of the same threading group, so
 186          * that special treatment is necessary for signal delivery
 187          * between those processes and fd locking.
 188          */
 189         if ((args->flags & 0xffffff00) == LINUX_THREADING_FLAGS)
 190                 ff |= RFTHREAD;
 191
 192         if (args->flags & LINUX_CLONE_PARENT_SETTID)
 193                 if (args->parent_tidptr == NULL)
 194                         return (EINVAL);
 195
 196         if (args->flags & LINUX_CLONE_VFORK)
 197                 ff |= RFPPWAIT;
 198
 199         error = fork1(td, ff, 0, &p2, NULL, 0);
 200         if (error)
 201                 return (error);
 202
 203         if (args->flags & (LINUX_CLONE_PARENT | LINUX_CLONE_THREAD)) {
 204                 sx_xlock(&proctree_lock);
 205                 PROC_LOCK(p2);
 206                 proc_reparent(p2, td->td_proc->p_pptr);
 207                 PROC_UNLOCK(p2);
 208                 sx_xunlock(&proctree_lock);
 209         }
 210
 211         /* create the emuldata */
 212         error = linux_proc_init(td, p2->p_pid, args->flags);
 213         /* reference it - no need to check this */
 214         em = em_find(p2, EMUL_DOLOCK);
 215         KASSERT(em != NULL, ("clone: emuldata not found."));
 216         /* and adjust it */
 217
 218         if (args->flags & LINUX_CLONE_THREAD) {
 219 #ifdef notyet
 220                 PROC_LOCK(p2);
 221                 p2->p_pgrp = td->td_proc->p_pgrp;
 222                 PROC_UNLOCK(p2);
 223 #endif
 224                 exit_signal = 0;
 225         }
 226
 227         if (args->flags & LINUX_CLONE_CHILD_SETTID)
 228                 em->child_set_tid = args->child_tidptr;
 229         else
 230                 em->child_set_tid = NULL;
 231
 232         if (args->flags & LINUX_CLONE_CHILD_CLEARTID)
 233                 em->child_clear_tid = args->child_tidptr;
 234         else
 235                 em->child_clear_tid = NULL;
 236
 237         EMUL_UNLOCK(&emul_lock);
 238
 239         if (args->flags & LINUX_CLONE_PARENT_SETTID) {
 240                 error = copyout(&p2->p_pid, args->parent_tidptr,
 241                     sizeof(p2->p_pid));
 242                 if (error)
 243                         printf(LMSG("copyout failed!"));
 244         }
 245
 246         PROC_LOCK(p2);
 247         p2->p_sigparent = exit_signal;
 248         PROC_UNLOCK(p2);
 249         td2 = FIRST_THREAD_IN_PROC(p2);
 250         /*
 251          * In a case of stack = NULL, we are supposed to COW calling process
 252          * stack. This is what normal fork() does, so we just keep tf_rsp arg
 253          * intact.
 254          */
 255         if (args->stack)
 256                 linux_set_upcall_kse(td2, PTROUT(args->stack));
 257
 258         if (args->flags & LINUX_CLONE_SETTLS)
 259                 linux_set_cloned_tls(td2, args->tls);
 260
 261 #ifdef DEBUG
 262         if (ldebug(clone))
 263                 printf(LMSG("clone: successful rfork to %d, "
 264                     "stack %p sig = %d"), (int)p2->p_pid, args->stack,
 265                     exit_signal);
 266 #endif
 267         /*
 268          * Make this runnable after we are finished with it.
 269          */
 270         thread_lock(td2);
 271         TD_SET_CAN_RUN(td2);
 272         sched_add(td2, SRQ_BORING);
 273         thread_unlock(td2);
 274
 275         td->td_retval[0] = p2->p_pid;
 276         td->td_retval[1] = 0;
 277
 278         return (0);
 279 }
 280
 281 int
 282 linux_exit(struct thread *td, struct linux_exit_args *args)
 283 {
 284
 285 #ifdef DEBUG
 286         if (ldebug(exit))
 287                 printf(ARGS(exit, "%d"), args->rval);
 288 #endif
 289
 290         exit1(td, W_EXITCODE(args->rval, 0));
 291                 /* NOTREACHED */
 292 }