linux-user/qemu.h

   1 #ifndef QEMU_H
   2 #define QEMU_H
   3
   4 #include "thunk.h"
   5
   6 #include <signal.h>
   7 #include <string.h>
   8 #include "syscall_defs.h"
   9
  10 #include "cpu.h"
  11 #include "syscall.h"
  12 #include "target_signal.h"
  13 #include "gdbstub.h"
  14
  15 /* This struct is used to hold certain information about the image.
  16  * Basically, it replicates in user space what would be certain
  17  * task_struct fields in the kernel
  18  */
  19 struct image_info {
  20         target_ulong    load_addr;
  21         target_ulong    start_code;
  22         target_ulong    end_code;
  23         target_ulong    start_data;
  24         target_ulong    end_data;
  25         target_ulong    start_brk;
  26         target_ulong    brk;
  27         target_ulong    start_mmap;
  28         target_ulong    mmap;
  29         target_ulong    rss;
  30         target_ulong    start_stack;
  31         target_ulong    entry;
  32         target_ulong    code_offset;
  33         target_ulong    data_offset;
  34         char            **host_argv;
  35         int             personality;
  36 };
  37
  38 #ifdef TARGET_I386
  39 /* Information about the current linux thread */
  40 struct vm86_saved_state {
  41     uint32_t eax; /* return code */
  42     uint32_t ebx;
  43     uint32_t ecx;
  44     uint32_t edx;
  45     uint32_t esi;
  46     uint32_t edi;
  47     uint32_t ebp;
  48     uint32_t esp;
  49     uint32_t eflags;
  50     uint32_t eip;
  51     uint16_t cs, ss, ds, es, fs, gs;
  52 };
  53 #endif
  54
  55 #ifdef TARGET_ARM
  56 /* FPU emulator */
  57 #include "nwfpe/fpa11.h"
  58 #endif
  59
  60 /* NOTE: we force a big alignment so that the stack stored after is
  61    aligned too */
  62 typedef struct TaskState {
  63     struct TaskState *next;
  64 #ifdef TARGET_ARM
  65     /* FPA state */
  66     FPA11 fpa;
  67     int swi_errno;
  68 #endif
  69 #if defined(TARGET_I386) && !defined(TARGET_X86_64)
  70     target_ulong target_v86;
  71     struct vm86_saved_state vm86_saved_regs;
  72     struct target_vm86plus_struct vm86plus;
  73     uint32_t v86flags;
  74     uint32_t v86mask;
  75 #endif
  76 #ifdef TARGET_M68K
  77     int sim_syscalls;
  78 #endif
  79 #if defined(TARGET_ARM) || defined(TARGET_M68K)
  80     /* Extra fields for semihosted binaries.  */
  81     uint32_t stack_base;
  82     uint32_t heap_base;
  83     uint32_t heap_limit;
  84 #endif
  85     int used; /* non zero if used */
  86     struct image_info *info;
  87     uint8_t stack[0];
  88 } __attribute__((aligned(16))) TaskState;
  89
  90 extern TaskState *first_task_state;
  91 extern const char *qemu_uname_release;
  92
  93 /* ??? See if we can avoid exposing so much of the loader internals.  */
  94 /*
  95  * MAX_ARG_PAGES defines the number of pages allocated for arguments
  96  * and envelope for the new program. 32 should suffice, this gives
  97  * a maximum env+arg of 128kB w/4KB pages!
  98  */
  99 #define MAX_ARG_PAGES 32
 100
 101 /*
 102  * This structure is used to hold the arguments that are
 103  * used when loading binaries.
 104  */
 105 struct linux_binprm {
 106         char buf[128];
 107         void *page[MAX_ARG_PAGES];
 108         target_ulong p;
 109         int fd;
 110         int e_uid, e_gid;
 111         int argc, envc;
 112         char **argv;
 113         char **envp;
 114         char * filename;        /* Name of binary */
 115 };
 116
 117 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
 118 target_ulong loader_build_argptr(int envc, int argc, target_ulong sp,
 119                                  target_ulong stringp, int push_ptr);
 120 int loader_exec(const char * filename, char ** argv, char ** envp,
 121              struct target_pt_regs * regs, struct image_info *infop);
 122
 123 int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
 124                     struct image_info * info);
 125 int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
 126                     struct image_info * info);
 127
 128 void memcpy_to_target(target_ulong dest, const void *src,
 129                       unsigned long len);
 130 void target_set_brk(target_ulong new_brk);
 131 target_long do_brk(target_ulong new_brk);
 132 void syscall_init(void);
 133 target_long do_syscall(void *cpu_env, int num, target_long arg1,
 134                        target_long arg2, target_long arg3, target_long arg4,
 135                        target_long arg5, target_long arg6);
 136 void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
 137 extern CPUState *global_env;
 138 void cpu_loop(CPUState *env);
 139 void init_paths(const char *prefix);
 140 const char *path(const char *pathname);
 141
 142 extern int loglevel;
 143 extern FILE *logfile;
 144
 145 /* signal.c */
 146 void process_pending_signals(void *cpu_env);
 147 void signal_init(void);
 148 int queue_signal(int sig, target_siginfo_t *info);
 149 void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
 150 void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
 151 long do_sigreturn(CPUState *env);
 152 long do_rt_sigreturn(CPUState *env);
 153 int do_sigaltstack(const struct target_sigaltstack *uss,
 154                    struct target_sigaltstack *uoss,
 155                    target_ulong sp);
 156
 157 #ifdef TARGET_I386
 158 /* vm86.c */
 159 void save_v86_state(CPUX86State *env);
 160 void handle_vm86_trap(CPUX86State *env, int trapno);
 161 void handle_vm86_fault(CPUX86State *env);
 162 int do_vm86(CPUX86State *env, long subfunction, target_ulong v86_addr);
 163 #elif defined(TARGET_SPARC64)
 164 void sparc64_set_context(CPUSPARCState *env);
 165 void sparc64_get_context(CPUSPARCState *env);
 166 #endif
 167
 168 /* mmap.c */
 169 int target_mprotect(target_ulong start, target_ulong len, int prot);
 170 target_long target_mmap(target_ulong start, target_ulong len, int prot,
 171                  int flags, int fd, target_ulong offset);
 172 int target_munmap(target_ulong start, target_ulong len);
 173 target_long target_mremap(target_ulong old_addr, target_ulong old_size,
 174                    target_ulong new_size, unsigned long flags,
 175                    target_ulong new_addr);
 176 int target_msync(target_ulong start, target_ulong len, int flags);
 177
 178 /* user access */
 179
 180 #define VERIFY_READ 0
 181 #define VERIFY_WRITE 1
 182
 183 #define access_ok(type,addr,size) (1)
 184
 185 /* NOTE get_user and put_user use host addresses.  */
 186 #define __put_user(x,ptr)\
 187 ({\
 188     int size = sizeof(*ptr);\
 189     switch(size) {\
 190     case 1:\
 191         *(uint8_t *)(ptr) = (typeof(*ptr))(x);\
 192         break;\
 193     case 2:\
 194         *(uint16_t *)(ptr) = tswap16((typeof(*ptr))(x));\
 195         break;\
 196     case 4:\
 197         *(uint32_t *)(ptr) = tswap32((typeof(*ptr))(x));\
 198         break;\
 199     case 8:\
 200         *(uint64_t *)(ptr) = tswap64((typeof(*ptr))(x));\
 201         break;\
 202     default:\
 203         abort();\
 204     }\
 205     0;\
 206 })
 207
 208 #define __get_user(x, ptr) \
 209 ({\
 210     int size = sizeof(*ptr);\
 211     switch(size) {\
 212     case 1:\
 213         x = (typeof(*ptr))*(uint8_t *)(ptr);\
 214         break;\
 215     case 2:\
 216         x = (typeof(*ptr))tswap16(*(uint16_t *)(ptr));\
 217         break;\
 218     case 4:\
 219         x = (typeof(*ptr))tswap32(*(uint32_t *)(ptr));\
 220         break;\
 221     case 8:\
 222         x = (typeof(*ptr))tswap64(*(uint64_t *)(ptr));\
 223         break;\
 224     default:\
 225         abort();\
 226     }\
 227     0;\
 228 })
 229
 230 #define put_user(x,ptr)\
 231 ({\
 232     int __ret;\
 233     if (access_ok(VERIFY_WRITE, ptr, sizeof(*ptr)))\
 234         __ret = __put_user(x, ptr);\
 235     else\
 236         __ret = -EFAULT;\
 237     __ret;\
 238 })
 239
 240 #define get_user(x,ptr)\
 241 ({\
 242     int __ret;\
 243     if (access_ok(VERIFY_READ, ptr, sizeof(*ptr)))\
 244         __ret = __get_user(x, ptr);\
 245     else\
 246         __ret = -EFAULT;\
 247     __ret;\
 248 })
 249
 250 /* Functions for accessing guest memory.  The tget and tput functions
 251    read/write single values, byteswapping as neccessary.  The lock_user
 252    gets a pointer to a contiguous area of guest memory, but does not perform
 253    and byteswapping.  lock_user may return either a pointer to the guest
 254    memory, or a temporary buffer.  */
 255
 256 /* Lock an area of guest memory into the host.  If copy is true then the
 257    host area will have the same contents as the guest.  */
 258 static inline void *lock_user(target_ulong guest_addr, long len, int copy)
 259 {
 260 #ifdef DEBUG_REMAP
 261     void *addr;
 262     addr = malloc(len);
 263     if (copy)
 264         memcpy(addr, g2h(guest_addr), len);
 265     else
 266         memset(addr, 0, len);
 267     return addr;
 268 #else
 269     return g2h(guest_addr);
 270 #endif
 271 }
 272
 273 /* Unlock an area of guest memory.  The first LEN bytes must be flushed back
 274    to guest memory.  */
 275 static inline void unlock_user(void *host_addr, target_ulong guest_addr,
 276                                 long len)
 277 {
 278 #ifdef DEBUG_REMAP
 279     if (host_addr == g2h(guest_addr))
 280         return;
 281     if (len > 0)
 282         memcpy(g2h(guest_addr), host_addr, len);
 283     free(host_addr);
 284 #endif
 285 }
 286
 287 /* Return the length of a string in target memory.  */
 288 static inline int target_strlen(target_ulong ptr)
 289 {
 290   return strlen(g2h(ptr));
 291 }
 292
 293 /* Like lock_user but for null terminated strings.  */
 294 static inline void *lock_user_string(target_ulong guest_addr)
 295 {
 296     long len;
 297     len = target_strlen(guest_addr) + 1;
 298     return lock_user(guest_addr, len, 1);
 299 }
 300
 301 /* Helper macros for locking/ulocking a target struct.  */
 302 #define lock_user_struct(host_ptr, guest_addr, copy) \
 303     host_ptr = lock_user(guest_addr, sizeof(*host_ptr), copy)
 304 #define unlock_user_struct(host_ptr, guest_addr, copy) \
 305     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
 306
 307 #define tget8(addr) ldub(addr)
 308 #define tput8(addr, val) stb(addr, val)
 309 #define tget16(addr) lduw(addr)
 310 #define tput16(addr, val) stw(addr, val)
 311 #define tget32(addr) ldl(addr)
 312 #define tput32(addr, val) stl(addr, val)
 313 #define tget64(addr) ldq(addr)
 314 #define tput64(addr, val) stq(addr, val)
 315 #if TARGET_LONG_BITS == 64
 316 #define tgetl(addr) ldq(addr)
 317 #define tputl(addr, val) stq(addr, val)
 318 #else
 319 #define tgetl(addr) ldl(addr)
 320 #define tputl(addr, val) stl(addr, val)
 321 #endif
 322
 323 #endif /* QEMU_H */