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