osfmk/ddb/db_ext_symtab.c

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50
  51 /*
  52  */
  53 #include <mach_kdb.h>
  54 #include <mach_debug.h>
  55
  56 #include <mach/vm_map.h>
  57 #include <mach/vm_param.h>
  58 #include <mach/std_types.h>
  59 #include <mach/mach_types.h>
  60 #include <mach/mach_host_server.h>  /* prototype */
  61
  62 #if MACH_KDB && MACH_DEBUG
  63 #include <vm/vm_map.h>
  64 #include <vm/vm_kern.h>
  65 #include <kern/host.h>
  66 #include <kern/task.h>
  67 #include <ddb/db_sym.h>
  68 #endif
  69
  70 /*
  71  *      Loads a symbol table for an external file into the kernel debugger.
  72  *      The symbol table data is an array of characters.  It is assumed that
  73  *      the caller and the kernel debugger agree on its format.
  74  */
  75 kern_return_t
  76 host_load_symbol_table(
  77         host_priv_t     host_priv,
  78         task_t          task,
  79         char *          name,
  80         pointer_t       symtab,
  81         mach_msg_type_number_t  symtab_count)
  82 {
  83 #if !MACH_DEBUG || !MACH_KDB
  84         return KERN_FAILURE;
  85 #else
  86         kern_return_t   result;
  87         vm_offset_t     symtab_start;
  88         vm_offset_t     symtab_end;
  89         vm_map_t        map;
  90         vm_map_copy_t   symtab_copy_object;
  91
  92         if (host_priv == HOST_PRIV_NULL)
  93             return (KERN_INVALID_ARGUMENT);
  94
  95         /*
  96          * Copy the symbol table array into the kernel.
  97          * We make a copy of the copy object, and clear
  98          * the old one, so that returning error will not
  99          * deallocate the data twice.
 100          */
 101         symtab_copy_object = (vm_map_copy_t) symtab;
 102         result = vm_map_copyout(
 103                         kernel_map,
 104                         &symtab_start,
 105                         vm_map_copy_copy(symtab_copy_object));
 106         if (result != KERN_SUCCESS)
 107             return (result);
 108
 109         symtab_end = symtab_start + symtab_count;
 110
 111         /*
 112          * Add the symbol table.
 113          * Do not keep a reference for the task map.    XXX
 114          */
 115         if (task == TASK_NULL)
 116             map = VM_MAP_NULL;
 117         else
 118             map = task->map;
 119         if (!X_db_sym_init((char *)symtab_start,
 120                         (char *)symtab_end,
 121                         name,
 122                         (char *)map))
 123         {
 124             /*
 125              * Not enough room for symbol table - failure.
 126              */
 127             (void) vm_deallocate(kernel_map,
 128                         symtab_start,
 129                         symtab_count);
 130             return (KERN_FAILURE);
 131         }
 132
 133         /*
 134          * Wire down the symbol table
 135          */
 136         (void) vm_map_wire(kernel_map,
 137                 symtab_start,
 138                 round_page(symtab_end),
 139                 VM_PROT_READ|VM_PROT_WRITE, FALSE);
 140
 141         /*
 142          * Discard the original copy object
 143          */
 144         vm_map_copy_discard(symtab_copy_object);
 145
 146         return (KERN_SUCCESS);
 147 #endif /* MACH_DEBUG && MACH_KDB */
 148 }