sys/compat/linux/linux_emul.h

   1 /*-
   2  * Copyright (c) 2006 Roman Divacky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer
  10  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission
  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  * $FreeBSD$
  29  */
  30
  31 #ifndef _LINUX_EMUL_H_
  32 #define _LINUX_EMUL_H_
  33
  34 #define EMUL_SHARED_HASXSTAT    0x01
  35
  36 struct linux_emuldata_shared {
  37         int     refs;
  38         int     flags;
  39         int     xstat;
  40         pid_t   group_pid;
  41
  42         LIST_HEAD(, linux_emuldata) threads; /* head of list of linux threads */
  43 };
  44
  45 /*
  46  * modeled after similar structure in NetBSD
  47  * this will be extended as we need more functionality
  48  */
  49 struct linux_emuldata {
  50         pid_t   pid;
  51
  52         int    *child_set_tid;  /* in clone(): Child's TID to set on clone */
  53         int    *child_clear_tid;/* in clone(): Child's TID to clear on exit */
  54
  55         struct linux_emuldata_shared *shared;
  56
  57         int     pdeath_signal;          /* parent death signal */
  58         int     flags;                  /* different emuldata flags */
  59
  60         struct  linux_robust_list_head  *robust_futexes;
  61
  62         LIST_ENTRY(linux_emuldata) threads;     /* list of linux threads */
  63 };
  64
  65 struct linux_emuldata   *em_find(struct proc *, int locked);
  66
  67 /*
  68  * DTrace probes for locks should be fired after locking and before releasing
  69  * to prevent races (to provide data/function stability in dtrace, see the
  70  * output of "dtrace -v ..." and the corresponding dtrace docs).
  71  */
  72 #define EMUL_LOCK(l)            do { \
  73                                     mtx_lock(l); \
  74                                     LIN_SDT_PROBE1(locks, emul_lock, \
  75                                         locked, l); \
  76                                 } while (0)
  77 #define EMUL_UNLOCK(l)          do { \
  78                                     LIN_SDT_PROBE1(locks, emul_lock, \
  79                                         unlock, l); \
  80                                     mtx_unlock(l); \
  81                                 } while (0)
  82
  83 #define EMUL_SHARED_RLOCK(l)    do { \
  84                                     sx_slock(l); \
  85                                     LIN_SDT_PROBE1(locks, emul_shared_rlock, \
  86                                         locked, l); \
  87                                 } while (0)
  88 #define EMUL_SHARED_RUNLOCK(l)  do { \
  89                                     LIN_SDT_PROBE1(locks, emul_shared_rlock, \
  90                                         unlock, l); \
  91                                     sx_sunlock(l); \
  92                                 } while (0)
  93 #define EMUL_SHARED_WLOCK(l)    do { \
  94                                     sx_xlock(l); \
  95                                     LIN_SDT_PROBE1(locks, emul_shared_wlock, \
  96                                         locked, l); \
  97                                 } while (0)
  98 #define EMUL_SHARED_WUNLOCK(l)  do { \
  99                                     LIN_SDT_PROBE1(locks, emul_shared_wlock, \
 100                                         unlock, l); \
 101                                     sx_xunlock(l); \
 102                                 } while (0)
 103
 104 /* for em_find use */
 105 #define EMUL_DOLOCK             1
 106 #define EMUL_DONTLOCK           0
 107
 108 /* emuldata flags */
 109 #define LINUX_XDEPR_REQUEUEOP   0x00000001      /* uses deprecated
 110                                                    futex REQUEUE op*/
 111
 112 int     linux_proc_init(struct thread *, pid_t, int);
 113 void    linux_proc_exit(void *, struct proc *);
 114 void    linux_schedtail(struct thread *);
 115 void    linux_proc_exec(void *, struct proc *, struct image_params *);
 116 void    linux_kill_threads(struct thread *, int);
 117
 118 extern struct sx        emul_shared_lock;
 119 extern struct mtx       emul_lock;
 120
 121 #endif  /* !_LINUX_EMUL_H_ */