server/mach.c

   1 /*
   2  * Server-side debugger support using Mach primitives
   3  *
   4  * Copyright (C) 1999, 2006 Alexandre Julliard
   5  * Copyright (C) 2006 Ken Thomases for CodeWeavers
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <errno.h>
  27 #include <stdio.h>
  28 #include <signal.h>
  29 #include <stdarg.h>
  30 #include <sys/types.h>
  31 #include <unistd.h>
  32 #ifdef HAVE_SYS_SYSCALL_H
  33 #include <sys/syscall.h>
  34 #endif
  35
  36 #include "ntstatus.h"
  37 #define WIN32_NO_STATUS
  38 #include "winternl.h"
  39
  40 #include "file.h"
  41 #include "process.h"
  42 #include "thread.h"
  43 #include "request.h"
  44 #include "wine/library.h"
  45
  46 #ifdef USE_MACH
  47
  48 #include <mach/mach.h>
  49 #include <mach/mach_error.h>
  50 #include <mach/thread_act.h>
  51 #include <mach/mach_vm.h>
  52 #include <servers/bootstrap.h>
  53
  54 static mach_port_t server_mach_port;
  55
  56 void sigchld_callback(void)
  57 {
  58     assert(0);  /* should never be called on MacOS */
  59 }
  60
  61 static void mach_set_error(kern_return_t mach_error)
  62 {
  63     switch (mach_error)
  64     {
  65         case KERN_SUCCESS:              break;
  66         case KERN_INVALID_ARGUMENT:     set_error(STATUS_INVALID_PARAMETER); break;
  67         case KERN_NO_SPACE:             set_error(STATUS_NO_MEMORY); break;
  68         case KERN_PROTECTION_FAILURE:   set_error(STATUS_ACCESS_DENIED); break;
  69         case KERN_INVALID_ADDRESS:      set_error(STATUS_ACCESS_VIOLATION); break;
  70         default:                        set_error(STATUS_UNSUCCESSFUL); break;
  71     }
  72 }
  73
  74 static mach_port_t get_process_port( struct process *process )
  75 {
  76     return process->trace_data;
  77 }
  78
  79 /* initialize the process control mechanism */
  80 void init_tracing_mechanism(void)
  81 {
  82     mach_port_t bp;
  83
  84     if (task_get_bootstrap_port(mach_task_self(), &bp) != KERN_SUCCESS)
  85         fatal_error("Can't find bootstrap port\n");
  86     if (mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &server_mach_port) != KERN_SUCCESS)
  87         fatal_error("Can't allocate port\n");
  88     if  (mach_port_insert_right( mach_task_self(),
  89                                  server_mach_port,
  90                                  server_mach_port,
  91                                  MACH_MSG_TYPE_MAKE_SEND ) != KERN_SUCCESS)
  92             fatal_error("Error inserting rights\n");
  93     if (bootstrap_register(bp, (char*)wine_get_server_dir(), server_mach_port) != KERN_SUCCESS)
  94         fatal_error("Can't check in server_mach_port\n");
  95     mach_port_deallocate(mach_task_self(), bp);
  96 }
  97
  98 /* initialize the per-process tracing mechanism */
  99 void init_process_tracing( struct process *process )
 100 {
 101     int pid, ret;
 102     struct
 103     {
 104         mach_msg_header_t           header;
 105         mach_msg_body_t             body;
 106         mach_msg_port_descriptor_t  task_port;
 107         mach_msg_trailer_t          trailer; /* only present on receive */
 108     } msg;
 109
 110     for (;;)
 111     {
 112         ret = mach_msg( &msg.header, MACH_RCV_MSG|MACH_RCV_TIMEOUT, 0, sizeof(msg),
 113                         server_mach_port, 0, 0 );
 114         if (ret)
 115         {
 116             if (ret != MACH_RCV_TIMED_OUT && debug_level)
 117                 fprintf( stderr, "warning: mach port receive failed with %x\n", ret );
 118             return;
 119         }
 120
 121         /* if anything in the message is invalid, ignore it */
 122         if (msg.header.msgh_size != offsetof(typeof(msg), trailer)) continue;
 123         if (msg.body.msgh_descriptor_count != 1) continue;
 124         if (msg.task_port.type != MACH_MSG_PORT_DESCRIPTOR) continue;
 125         if (msg.task_port.disposition != MACH_MSG_TYPE_PORT_SEND) continue;
 126         if (msg.task_port.name == MACH_PORT_NULL) continue;
 127         if (msg.task_port.name == MACH_PORT_DEAD) continue;
 128
 129         if (!pid_for_task( msg.task_port.name, &pid ))
 130         {
 131             struct thread *thread = get_thread_from_pid( pid );
 132
 133             if (thread && !thread->process->trace_data)
 134                 thread->process->trace_data = msg.task_port.name;
 135             else
 136                 mach_port_deallocate( mach_task_self(), msg.task_port.name );
 137         }
 138     }
 139 }
 140
 141 /* terminate the per-process tracing mechanism */
 142 void finish_process_tracing( struct process *process )
 143 {
 144     if (process->trace_data)
 145     {
 146         mach_port_deallocate( mach_task_self(), process->trace_data );
 147         process->trace_data = 0;
 148     }
 149 }
 150
 151 /* retrieve the thread x86 registers */
 152 void get_thread_context( struct thread *thread, context_t *context, unsigned int flags )
 153 {
 154 #if defined(__i386__) || defined(__x86_64__)
 155     x86_debug_state_t state;
 156     mach_msg_type_number_t count = sizeof(state) / sizeof(int);
 157     mach_msg_type_name_t type;
 158     mach_port_t port, process_port = get_process_port( thread->process );
 159
 160     /* all other regs are handled on the client side */
 161     assert( flags == SERVER_CTX_DEBUG_REGISTERS );
 162
 163     if (thread->unix_pid == -1 || !process_port ||
 164         mach_port_extract_right( process_port, thread->unix_tid,
 165                                  MACH_MSG_TYPE_COPY_SEND, &port, &type ))
 166     {
 167         set_error( STATUS_ACCESS_DENIED );
 168         return;
 169     }
 170
 171     if (!thread_get_state( port, x86_DEBUG_STATE, (thread_state_t)&state, &count ))
 172     {
 173 #ifdef __x86_64__
 174         assert( state.dsh.flavor == x86_DEBUG_STATE32 ||
 175                 state.dsh.flavor == x86_DEBUG_STATE64 );
 176 #else
 177         assert( state.dsh.flavor == x86_DEBUG_STATE32 );
 178 #endif
 179
 180 #ifdef __x86_64__
 181         if (state.dsh.flavor == x86_DEBUG_STATE64)
 182         {
 183             context->debug.x86_64_regs.dr0 = state.uds.ds64.__dr0;
 184             context->debug.x86_64_regs.dr1 = state.uds.ds64.__dr1;
 185             context->debug.x86_64_regs.dr2 = state.uds.ds64.__dr2;
 186             context->debug.x86_64_regs.dr3 = state.uds.ds64.__dr3;
 187             context->debug.x86_64_regs.dr6 = state.uds.ds64.__dr6;
 188             context->debug.x86_64_regs.dr7 = state.uds.ds64.__dr7;
 189         }
 190         else
 191 #endif
 192         {
 193 /* work around silly renaming of struct members in OS X 10.5 */
 194 #if __DARWIN_UNIX03 && defined(_STRUCT_X86_DEBUG_STATE32)
 195             context->debug.i386_regs.dr0 = state.uds.ds32.__dr0;
 196             context->debug.i386_regs.dr1 = state.uds.ds32.__dr1;
 197             context->debug.i386_regs.dr2 = state.uds.ds32.__dr2;
 198             context->debug.i386_regs.dr3 = state.uds.ds32.__dr3;
 199             context->debug.i386_regs.dr6 = state.uds.ds32.__dr6;
 200             context->debug.i386_regs.dr7 = state.uds.ds32.__dr7;
 201 #else
 202             context->debug.i386_regs.dr0 = state.uds.ds32.dr0;
 203             context->debug.i386_regs.dr1 = state.uds.ds32.dr1;
 204             context->debug.i386_regs.dr2 = state.uds.ds32.dr2;
 205             context->debug.i386_regs.dr3 = state.uds.ds32.dr3;
 206             context->debug.i386_regs.dr6 = state.uds.ds32.dr6;
 207             context->debug.i386_regs.dr7 = state.uds.ds32.dr7;
 208 #endif
 209         }
 210         context->flags |= SERVER_CTX_DEBUG_REGISTERS;
 211     }
 212     mach_port_deallocate( mach_task_self(), port );
 213 #endif
 214 }
 215
 216 /* set the thread x86 registers */
 217 void set_thread_context( struct thread *thread, const context_t *context, unsigned int flags )
 218 {
 219 #if defined(__i386__) || defined(__x86_64__)
 220     x86_debug_state_t state;
 221     mach_msg_type_number_t count = sizeof(state) / sizeof(int);
 222     mach_msg_type_name_t type;
 223     mach_port_t port, process_port = get_process_port( thread->process );
 224     unsigned int dr7;
 225
 226     /* all other regs are handled on the client side */
 227     assert( flags == SERVER_CTX_DEBUG_REGISTERS );
 228
 229     if (thread->unix_pid == -1 || !process_port ||
 230         mach_port_extract_right( process_port, thread->unix_tid,
 231                                  MACH_MSG_TYPE_COPY_SEND, &port, &type ))
 232     {
 233         set_error( STATUS_ACCESS_DENIED );
 234         return;
 235     }
 236
 237
 238 #ifdef __x86_64__
 239     if (thread->process->cpu == CPU_x86_64)
 240     {
 241         /* Mac OS doesn't allow setting the global breakpoint flags */
 242         dr7 = (context->debug.x86_64_regs.dr7 & ~0xaa) | ((context->debug.x86_64_regs.dr7 & 0xaa) >> 1);
 243
 244         state.dsh.flavor = x86_DEBUG_STATE64;
 245         state.dsh.count = sizeof(state.uds.ds64) / sizeof(int);
 246         state.uds.ds64.__dr0 = context->debug.x86_64_regs.dr0;
 247         state.uds.ds64.__dr1 = context->debug.x86_64_regs.dr1;
 248         state.uds.ds64.__dr2 = context->debug.x86_64_regs.dr2;
 249         state.uds.ds64.__dr3 = context->debug.x86_64_regs.dr3;
 250         state.uds.ds64.__dr4 = 0;
 251         state.uds.ds64.__dr5 = 0;
 252         state.uds.ds64.__dr6 = context->debug.x86_64_regs.dr6;
 253         state.uds.ds64.__dr7 = dr7;
 254     }
 255     else
 256 #endif
 257     {
 258         dr7 = (context->debug.i386_regs.dr7 & ~0xaa) | ((context->debug.i386_regs.dr7 & 0xaa) >> 1);
 259
 260         state.dsh.flavor = x86_DEBUG_STATE32;
 261         state.dsh.count = sizeof(state.uds.ds32) / sizeof(int);
 262 #if __DARWIN_UNIX03 && defined(_STRUCT_X86_DEBUG_STATE32)
 263         state.uds.ds32.__dr0 = context->debug.i386_regs.dr0;
 264         state.uds.ds32.__dr1 = context->debug.i386_regs.dr1;
 265         state.uds.ds32.__dr2 = context->debug.i386_regs.dr2;
 266         state.uds.ds32.__dr3 = context->debug.i386_regs.dr3;
 267         state.uds.ds32.__dr4 = 0;
 268         state.uds.ds32.__dr5 = 0;
 269         state.uds.ds32.__dr6 = context->debug.i386_regs.dr6;
 270         state.uds.ds32.__dr7 = dr7;
 271 #else
 272         state.uds.ds32.dr0 = context->debug.i386_regs.dr0;
 273         state.uds.ds32.dr1 = context->debug.i386_regs.dr1;
 274         state.uds.ds32.dr2 = context->debug.i386_regs.dr2;
 275         state.uds.ds32.dr3 = context->debug.i386_regs.dr3;
 276         state.uds.ds32.dr4 = 0;
 277         state.uds.ds32.dr5 = 0;
 278         state.uds.ds32.dr6 = context->debug.i386_regs.dr6;
 279         state.uds.ds32.dr7 = dr7;
 280 #endif
 281     }
 282     if (!thread_set_state( port, x86_DEBUG_STATE, (thread_state_t)&state, count ))
 283     {
 284         if (thread->context)  /* update the cached values */
 285         {
 286 #ifdef __x86_64__
 287             if (thread->process->cpu == CPU_x86_64)
 288                 thread->context->debug.x86_64_regs = context->debug.x86_64_regs;
 289             else
 290 #endif
 291                 thread->context->debug.i386_regs = context->debug.i386_regs;
 292         }
 293     }
 294     mach_port_deallocate( mach_task_self(), port );
 295 #endif
 296 }
 297
 298 int send_thread_signal( struct thread *thread, int sig )
 299 {
 300     int ret = -1;
 301     mach_port_t process_port = get_process_port( thread->process );
 302
 303     if (thread->unix_pid != -1 && process_port)
 304     {
 305         mach_msg_type_name_t type;
 306         mach_port_t port;
 307
 308         if (!mach_port_extract_right( process_port, thread->unix_tid,
 309                                       MACH_MSG_TYPE_COPY_SEND, &port, &type ))
 310         {
 311             ret = syscall( SYS___pthread_kill, port, sig );
 312             mach_port_deallocate( mach_task_self(), port );
 313         }
 314         else errno = ESRCH;
 315
 316         if (ret == -1 && errno == ESRCH) /* thread got killed */
 317         {
 318             thread->unix_pid = -1;
 319             thread->unix_tid = -1;
 320         }
 321     }
 322     if (debug_level && ret != -1)
 323         fprintf( stderr, "%04x: *sent signal* signal=%d\n", thread->id, sig );
 324     return (ret != -1);
 325 }
 326
 327 /* read data from a process memory space */
 328 int read_process_memory( struct process *process, client_ptr_t ptr, data_size_t size, char *dest )
 329 {
 330     kern_return_t ret;
 331     mach_msg_type_number_t bytes_read;
 332     mach_vm_offset_t offset;
 333     vm_offset_t data;
 334     mach_vm_address_t aligned_address;
 335     mach_vm_size_t aligned_size;
 336     unsigned int page_size = get_page_size();
 337     mach_port_t process_port = get_process_port( process );
 338
 339     if (!process_port)
 340     {
 341         set_error( STATUS_ACCESS_DENIED );
 342         return 0;
 343     }
 344     if ((mach_vm_address_t)ptr != ptr)
 345     {
 346         set_error( STATUS_ACCESS_DENIED );
 347         return 0;
 348     }
 349
 350     if ((ret = task_suspend( process_port )) != KERN_SUCCESS)
 351     {
 352         mach_set_error( ret );
 353         return 0;
 354     }
 355
 356     offset = ptr % page_size;
 357     aligned_address = (mach_vm_address_t)(ptr - offset);
 358     aligned_size = (size + offset + page_size - 1) / page_size * page_size;
 359
 360     ret = mach_vm_read( process_port, aligned_address, aligned_size, &data, &bytes_read );
 361     if (ret != KERN_SUCCESS) mach_set_error( ret );
 362     else
 363     {
 364         memcpy( dest, (char *)data + offset, size );
 365         mach_vm_deallocate( mach_task_self(), data, bytes_read );
 366     }
 367     task_resume( process_port );
 368     return (ret == KERN_SUCCESS);
 369 }
 370
 371 /* write data to a process memory space */
 372 int write_process_memory( struct process *process, client_ptr_t ptr, data_size_t size, const char *src )
 373 {
 374     kern_return_t ret;
 375     mach_vm_address_t aligned_address, region_address;
 376     mach_vm_size_t aligned_size, region_size;
 377     mach_msg_type_number_t info_size, bytes_read;
 378     mach_vm_offset_t offset;
 379     vm_offset_t task_mem = 0;
 380     struct vm_region_basic_info_64 info;
 381     mach_port_t dummy;
 382     unsigned int page_size = get_page_size();
 383     mach_port_t process_port = get_process_port( process );
 384
 385     if (!process_port)
 386     {
 387         set_error( STATUS_ACCESS_DENIED );
 388         return 0;
 389     }
 390     if ((mach_vm_address_t)ptr != ptr)
 391     {
 392         set_error( STATUS_ACCESS_DENIED );
 393         return 0;
 394     }
 395
 396     offset = ptr % page_size;
 397     aligned_address = (mach_vm_address_t)(ptr - offset);
 398     aligned_size = (size + offset + page_size - 1) / page_size * page_size;
 399
 400     if ((ret = task_suspend( process_port )) != KERN_SUCCESS)
 401     {
 402         mach_set_error( ret );
 403         return 0;
 404     }
 405
 406     ret = mach_vm_read( process_port, aligned_address, aligned_size, &task_mem, &bytes_read );
 407     if (ret != KERN_SUCCESS)
 408     {
 409         mach_set_error( ret );
 410         goto failed;
 411     }
 412     region_address = aligned_address;
 413     info_size = sizeof(info);
 414     ret = mach_vm_region( process_port, &region_address, &region_size, VM_REGION_BASIC_INFO_64,
 415                      (vm_region_info_t)&info, &info_size, &dummy );
 416     if (ret != KERN_SUCCESS)
 417     {
 418         mach_set_error( ret );
 419         goto failed;
 420     }
 421     if (region_address > aligned_address ||
 422         region_address + region_size < aligned_address + aligned_size)
 423     {
 424         /* FIXME: should support multiple regions */
 425         set_error( ERROR_ACCESS_DENIED );
 426         goto failed;
 427     }
 428     ret = mach_vm_protect( process_port, aligned_address, aligned_size, 0, VM_PROT_READ | VM_PROT_WRITE );
 429     if (ret != KERN_SUCCESS)
 430     {
 431         mach_set_error( ret );
 432         goto failed;
 433     }
 434
 435     /* FIXME: there's an optimization that can be made: check first and last */
 436     /* pages for writability; read first and last pages; write interior */
 437     /* pages to task without ever reading&modifying them; if that succeeds, */
 438     /* modify first and last pages and write them. */
 439
 440     memcpy( (char*)task_mem + offset, src, size );
 441
 442     ret = mach_vm_write( process_port, aligned_address, task_mem, bytes_read );
 443     if (ret != KERN_SUCCESS) mach_set_error( ret );
 444     else
 445     {
 446         mach_vm_deallocate( mach_task_self(), task_mem, bytes_read );
 447         /* restore protection */
 448         mach_vm_protect( process_port, aligned_address, aligned_size, 0, info.protection );
 449         task_resume( process_port );
 450         return 1;
 451     }
 452
 453 failed:
 454     if (task_mem) mach_vm_deallocate( mach_task_self(), task_mem, bytes_read );
 455     task_resume( process_port );
 456     return 0;
 457 }
 458
 459 /* retrieve an LDT selector entry */
 460 void get_selector_entry( struct thread *thread, int entry, unsigned int *base,
 461                          unsigned int *limit, unsigned char *flags )
 462 {
 463     const unsigned int total_size = (2 * sizeof(int) + 1) * 8192;
 464     struct process *process = thread->process;
 465     unsigned int page_size = get_page_size();
 466     vm_offset_t data;
 467     kern_return_t ret;
 468     mach_msg_type_number_t bytes_read;
 469     mach_port_t process_port = get_process_port( thread->process );
 470
 471     if (!process->ldt_copy || !process_port)
 472     {
 473         set_error( STATUS_ACCESS_DENIED );
 474         return;
 475     }
 476     if (entry >= 8192)
 477     {
 478         set_error( STATUS_INVALID_PARAMETER );  /* FIXME */
 479         return;
 480     }
 481
 482     if ((ret = task_suspend( process_port )) == KERN_SUCCESS)
 483     {
 484         mach_vm_offset_t offset = process->ldt_copy % page_size;
 485         mach_vm_address_t aligned_address = (mach_vm_address_t)(process->ldt_copy - offset);
 486         mach_vm_size_t aligned_size = (total_size + offset + page_size - 1) / page_size * page_size;
 487
 488         ret = mach_vm_read( process_port, aligned_address, aligned_size, &data, &bytes_read );
 489         if (ret != KERN_SUCCESS) mach_set_error( ret );
 490         else
 491         {
 492             const int *ldt = (const int *)((char *)data + offset);
 493             memcpy( base, ldt + entry, sizeof(int) );
 494             memcpy( limit, ldt + entry + 8192, sizeof(int) );
 495             memcpy( flags, (char *)(ldt + 2 * 8192) + entry, 1 );
 496             mach_vm_deallocate( mach_task_self(), data, bytes_read );
 497         }
 498         task_resume( process_port );
 499     }
 500     else mach_set_error( ret );
 501 }
 502
 503 #endif  /* USE_MACH */