osfmk/ipc/mach_debug.c

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   ipc/mach_debug.c
  60  *      Author: Rich Draves
  61  *      Date:   1989
  62  *
  63  *      Exported IPC debug calls.
  64  */
  65 #include <mach_ipc_debug.h>
  66
  67 #include <mach/vm_param.h>
  68 #include <mach/kern_return.h>
  69 #include <mach/machine/vm_types.h>
  70 #include <mach/mach_host_server.h>
  71 #include <mach/mach_port_server.h>
  72 #include <mach_debug/ipc_info.h>
  73 #include <mach_debug/hash_info.h>
  74
  75 #if MACH_IPC_DEBUG
  76 #include <kern/host.h>
  77 #include <kern/misc_protos.h>
  78 #include <vm/vm_map.h>
  79 #include <vm/vm_kern.h>
  80 #include <ipc/port.h>
  81 #include <ipc/ipc_types.h>
  82 #include <ipc/ipc_space.h>
  83 #include <ipc/ipc_port.h>
  84 #include <ipc/ipc_hash.h>
  85 #include <ipc/ipc_table.h>
  86 #include <ipc/ipc_right.h>
  87
  88 #include <security/mac_mach_internal.h>
  89 #include <device/device_types.h>
  90 #endif
  91
  92 /*
  93  *      Routine:        mach_port_get_srights [kernel call]
  94  *      Purpose:
  95  *              Retrieve the number of extant send rights
  96  *              that a receive right has.
  97  *      Conditions:
  98  *              Nothing locked.
  99  *      Returns:
 100  *              KERN_SUCCESS            Retrieved number of send rights.
 101  *              KERN_INVALID_TASK       The space is null.
 102  *              KERN_INVALID_TASK       The space is dead.
 103  *              KERN_INVALID_NAME       The name doesn't denote a right.
 104  *              KERN_INVALID_RIGHT      Name doesn't denote receive rights.
 105  */
 106
 107 #if !MACH_IPC_DEBUG
 108 kern_return_t
 109 mach_port_get_srights(
 110         __unused ipc_space_t            space,
 111         __unused mach_port_name_t       name,
 112         __unused mach_port_rights_t     *srightsp)
 113 {
 114         return KERN_FAILURE;
 115 }
 116 #else
 117 kern_return_t
 118 mach_port_get_srights(
 119         ipc_space_t             space,
 120         mach_port_name_t        name,
 121         mach_port_rights_t      *srightsp)
 122 {
 123         ipc_port_t port;
 124         kern_return_t kr;
 125         mach_port_rights_t srights;
 126
 127         if (space == IS_NULL) {
 128                 return KERN_INVALID_TASK;
 129         }
 130
 131         kr = ipc_port_translate_receive(space, name, &port);
 132         if (kr != KERN_SUCCESS) {
 133                 return kr;
 134         }
 135         /* port is locked and active */
 136
 137         srights = port->ip_srights;
 138         ip_unlock(port);
 139
 140         *srightsp = srights;
 141         return KERN_SUCCESS;
 142 }
 143 #endif /* MACH_IPC_DEBUG */
 144
 145
 146 /*
 147  *      Routine:        mach_port_space_info
 148  *      Purpose:
 149  *              Returns information about an IPC space.
 150  *      Conditions:
 151  *              Nothing locked.  Obeys CountInOut protocol.
 152  *      Returns:
 153  *              KERN_SUCCESS            Returned information.
 154  *              KERN_INVALID_TASK       The space is null.
 155  *              KERN_INVALID_TASK       The space is dead.
 156  *              KERN_RESOURCE_SHORTAGE  Couldn't allocate memory.
 157  */
 158
 159 #if !MACH_IPC_DEBUG
 160 kern_return_t
 161 mach_port_space_info(
 162         __unused ipc_space_t                    space,
 163         __unused ipc_info_space_t               *infop,
 164         __unused ipc_info_name_array_t  *tablep,
 165         __unused mach_msg_type_number_t         *tableCntp,
 166         __unused ipc_info_tree_name_array_t *treep,
 167         __unused mach_msg_type_number_t         *treeCntp)
 168 {
 169         return KERN_FAILURE;
 170 }
 171 #else
 172 kern_return_t
 173 mach_port_space_info(
 174         ipc_space_t                     space,
 175         ipc_info_space_t                *infop,
 176         ipc_info_name_array_t           *tablep,
 177         mach_msg_type_number_t          *tableCntp,
 178         __unused ipc_info_tree_name_array_t     *treep,
 179         __unused mach_msg_type_number_t         *treeCntp)
 180 {
 181         ipc_info_name_t *table_info;
 182         vm_offset_t table_addr;
 183         vm_size_t table_size, table_size_needed;
 184         ipc_entry_t table;
 185         ipc_entry_num_t tsize;
 186         mach_port_index_t index;
 187         kern_return_t kr;
 188         vm_map_copy_t copy;
 189
 190
 191         if (space == IS_NULL) {
 192                 return KERN_INVALID_TASK;
 193         }
 194
 195 #if !(DEVELOPMENT || DEBUG) && CONFIG_MACF
 196         const boolean_t dbg_ok = (mac_task_check_expose_task(kernel_task) == 0);
 197 #else
 198         const boolean_t dbg_ok = TRUE;
 199 #endif
 200
 201         /* start with in-line memory */
 202
 203         table_size = 0;
 204
 205         for (;;) {
 206                 is_read_lock(space);
 207                 if (!is_active(space)) {
 208                         is_read_unlock(space);
 209                         if (table_size != 0) {
 210                                 kmem_free(ipc_kernel_map,
 211                                     table_addr, table_size);
 212                         }
 213                         return KERN_INVALID_TASK;
 214                 }
 215
 216                 table_size_needed =
 217                     vm_map_round_page((space->is_table_size
 218                     * sizeof(ipc_info_name_t)),
 219                     VM_MAP_PAGE_MASK(ipc_kernel_map));
 220
 221                 if (table_size_needed == table_size) {
 222                         break;
 223                 }
 224
 225                 is_read_unlock(space);
 226
 227                 if (table_size != table_size_needed) {
 228                         if (table_size != 0) {
 229                                 kmem_free(ipc_kernel_map, table_addr, table_size);
 230                         }
 231                         kr = kmem_alloc(ipc_kernel_map, &table_addr, table_size_needed, VM_KERN_MEMORY_IPC);
 232                         if (kr != KERN_SUCCESS) {
 233                                 return KERN_RESOURCE_SHORTAGE;
 234                         }
 235                         table_size = table_size_needed;
 236                 }
 237         }
 238         /* space is read-locked and active; we have enough wired memory */
 239
 240         /* get the overall space info */
 241         infop->iis_genno_mask = MACH_PORT_NGEN(MACH_PORT_DEAD);
 242         infop->iis_table_size = space->is_table_size;
 243         infop->iis_table_next = space->is_table_next->its_size;
 244
 245         /* walk the table for this space */
 246         table = space->is_table;
 247         tsize = space->is_table_size;
 248         table_info = (ipc_info_name_array_t)table_addr;
 249         for (index = 0; index < tsize; index++) {
 250                 ipc_info_name_t *iin = &table_info[index];
 251                 ipc_entry_t entry = &table[index];
 252                 ipc_entry_bits_t bits;
 253
 254                 bits = entry->ie_bits;
 255                 iin->iin_name = MACH_PORT_MAKE(index, IE_BITS_GEN(bits));
 256                 iin->iin_collision = 0;
 257                 iin->iin_type = IE_BITS_TYPE(bits);
 258                 if ((entry->ie_bits & MACH_PORT_TYPE_PORT_RIGHTS) != MACH_PORT_TYPE_NONE &&
 259                     entry->ie_request != IE_REQ_NONE) {
 260                         ipc_port_t port = ip_object_to_port(entry->ie_object);
 261
 262                         assert(IP_VALID(port));
 263                         ip_lock(port);
 264                         iin->iin_type |= ipc_port_request_type(port, iin->iin_name, entry->ie_request);
 265                         ip_unlock(port);
 266                 }
 267
 268                 iin->iin_urefs = IE_BITS_UREFS(bits);
 269                 iin->iin_object = (dbg_ok) ? (natural_t)VM_KERNEL_ADDRPERM((uintptr_t)entry->ie_object) : 0;
 270                 iin->iin_next = entry->ie_next;
 271                 iin->iin_hash = entry->ie_index;
 272         }
 273
 274         is_read_unlock(space);
 275
 276         /* prepare the table out-of-line data for return */
 277         if (table_size > 0) {
 278                 vm_size_t used_table_size;
 279
 280                 used_table_size = infop->iis_table_size * sizeof(ipc_info_name_t);
 281                 if (table_size > used_table_size) {
 282                         bzero((char *)&table_info[infop->iis_table_size],
 283                             table_size - used_table_size);
 284                 }
 285
 286                 kr = vm_map_unwire(
 287                         ipc_kernel_map,
 288                         vm_map_trunc_page(table_addr,
 289                         VM_MAP_PAGE_MASK(ipc_kernel_map)),
 290                         vm_map_round_page(table_addr + table_size,
 291                         VM_MAP_PAGE_MASK(ipc_kernel_map)),
 292                         FALSE);
 293                 assert(kr == KERN_SUCCESS);
 294                 kr = vm_map_copyin(ipc_kernel_map, (vm_map_address_t)table_addr,
 295                     (vm_map_size_t)used_table_size, TRUE, &copy);
 296                 assert(kr == KERN_SUCCESS);
 297                 *tablep = (ipc_info_name_t *)copy;
 298                 *tableCntp = infop->iis_table_size;
 299         } else {
 300                 *tablep = (ipc_info_name_t *)0;
 301                 *tableCntp = 0;
 302         }
 303
 304         /* splay tree is obsolete, no work to do... */
 305         *treep = (ipc_info_tree_name_t *)0;
 306         *treeCntp = 0;
 307         return KERN_SUCCESS;
 308 }
 309 #endif /* MACH_IPC_DEBUG */
 310
 311 /*
 312  *      Routine:        mach_port_space_basic_info
 313  *      Purpose:
 314  *              Returns basic information about an IPC space.
 315  *      Conditions:
 316  *              Nothing locked.
 317  *      Returns:
 318  *              KERN_SUCCESS            Returned information.
 319  *              KERN_FAILURE            The call is not supported.
 320  *              KERN_INVALID_TASK       The space is dead.
 321  */
 322
 323 #if !MACH_IPC_DEBUG
 324 kern_return_t
 325 mach_port_space_basic_info(
 326         __unused ipc_space_t                    space,
 327         __unused ipc_info_space_basic_t         *infop)
 328 {
 329         return KERN_FAILURE;
 330 }
 331 #else
 332 kern_return_t
 333 mach_port_space_basic_info(
 334         ipc_space_t                     space,
 335         ipc_info_space_basic_t          *infop)
 336 {
 337         if (space == IS_NULL) {
 338                 return KERN_INVALID_TASK;
 339         }
 340
 341
 342         is_read_lock(space);
 343         if (!is_active(space)) {
 344                 is_read_unlock(space);
 345                 return KERN_INVALID_TASK;
 346         }
 347
 348         /* get the basic space info */
 349         infop->iisb_genno_mask = MACH_PORT_NGEN(MACH_PORT_DEAD);
 350         infop->iisb_table_size = space->is_table_size;
 351         infop->iisb_table_next = space->is_table_next->its_size;
 352         infop->iisb_table_inuse = space->is_table_size - space->is_table_free - 1;
 353         infop->iisb_reserved[0] = 0;
 354         infop->iisb_reserved[1] = 0;
 355
 356         is_read_unlock(space);
 357
 358         return KERN_SUCCESS;
 359 }
 360 #endif /* MACH_IPC_DEBUG */
 361
 362 /*
 363  *      Routine:        mach_port_dnrequest_info
 364  *      Purpose:
 365  *              Returns information about the dead-name requests
 366  *              registered with the named receive right.
 367  *      Conditions:
 368  *              Nothing locked.
 369  *      Returns:
 370  *              KERN_SUCCESS            Retrieved information.
 371  *              KERN_INVALID_TASK       The space is null.
 372  *              KERN_INVALID_TASK       The space is dead.
 373  *              KERN_INVALID_NAME       The name doesn't denote a right.
 374  *              KERN_INVALID_RIGHT      Name doesn't denote receive rights.
 375  */
 376
 377 #if !MACH_IPC_DEBUG
 378 kern_return_t
 379 mach_port_dnrequest_info(
 380         __unused ipc_space_t            space,
 381         __unused mach_port_name_t       name,
 382         __unused unsigned int   *totalp,
 383         __unused unsigned int   *usedp)
 384 {
 385         return KERN_FAILURE;
 386 }
 387 #else
 388 kern_return_t
 389 mach_port_dnrequest_info(
 390         ipc_space_t                     space,
 391         mach_port_name_t                name,
 392         unsigned int                    *totalp,
 393         unsigned int                    *usedp)
 394 {
 395         unsigned int total, used;
 396         ipc_port_t port;
 397         kern_return_t kr;
 398
 399         if (space == IS_NULL) {
 400                 return KERN_INVALID_TASK;
 401         }
 402
 403         kr = ipc_port_translate_receive(space, name, &port);
 404         if (kr != KERN_SUCCESS) {
 405                 return kr;
 406         }
 407         /* port is locked and active */
 408
 409         if (port->ip_requests == IPR_NULL) {
 410                 total = 0;
 411                 used = 0;
 412         } else {
 413                 ipc_port_request_t requests = port->ip_requests;
 414                 ipc_port_request_index_t index;
 415
 416                 total = requests->ipr_size->its_size;
 417
 418                 for (index = 1, used = 0;
 419                     index < total; index++) {
 420                         ipc_port_request_t ipr = &requests[index];
 421
 422                         if (ipr->ipr_name != MACH_PORT_NULL) {
 423                                 used++;
 424                         }
 425                 }
 426         }
 427         ip_unlock(port);
 428
 429         *totalp = total;
 430         *usedp = used;
 431         return KERN_SUCCESS;
 432 }
 433 #endif /* MACH_IPC_DEBUG */
 434
 435 /*
 436  *      Routine:        mach_port_kobject [kernel call]
 437  *      Purpose:
 438  *              Retrieve the type and address of the kernel object
 439  *              represented by a send or receive right. Returns
 440  *              the kernel address in a mach_vm_address_t to
 441  *              mask potential differences in kernel address space
 442  *              size.
 443  *      Conditions:
 444  *              Nothing locked.
 445  *      Returns:
 446  *              KERN_SUCCESS            Retrieved kernel object info.
 447  *              KERN_INVALID_TASK       The space is null.
 448  *              KERN_INVALID_TASK       The space is dead.
 449  *              KERN_INVALID_NAME       The name doesn't denote a right.
 450  *              KERN_INVALID_RIGHT      Name doesn't denote
 451  *                                      send or receive rights.
 452  */
 453
 454 #if !MACH_IPC_DEBUG
 455 kern_return_t
 456 mach_port_kobject_description(
 457         __unused ipc_space_t            space,
 458         __unused mach_port_name_t       name,
 459         __unused natural_t              *typep,
 460         __unused mach_vm_address_t      *addrp,
 461         __unused kobject_description_t  desc)
 462 {
 463         return KERN_FAILURE;
 464 }
 465 #else
 466 kern_return_t
 467 mach_port_kobject_description(
 468         ipc_space_t                     space,
 469         mach_port_name_t                name,
 470         natural_t                       *typep,
 471         mach_vm_address_t               *addrp,
 472         kobject_description_t           desc)
 473 {
 474         ipc_entry_t entry;
 475         ipc_port_t port;
 476         kern_return_t kr;
 477         mach_vm_address_t kaddr;
 478
 479         if (space == IS_NULL) {
 480                 return KERN_INVALID_TASK;
 481         }
 482
 483         kr = ipc_right_lookup_read(space, name, &entry);
 484         if (kr != KERN_SUCCESS) {
 485                 return kr;
 486         }
 487         /* space is read-locked and active */
 488
 489         if ((entry->ie_bits & MACH_PORT_TYPE_SEND_RECEIVE) == 0) {
 490                 is_read_unlock(space);
 491                 return KERN_INVALID_RIGHT;
 492         }
 493
 494         port = ip_object_to_port(entry->ie_object);
 495         assert(port != IP_NULL);
 496
 497         ip_lock(port);
 498         is_read_unlock(space);
 499
 500         if (!ip_active(port)) {
 501                 ip_unlock(port);
 502                 return KERN_INVALID_RIGHT;
 503         }
 504
 505         *typep = (unsigned int) ip_kotype(port);
 506         kaddr = (mach_vm_address_t)ip_get_kobject(port);
 507         *addrp = 0;
 508 #if (DEVELOPMENT || DEBUG)
 509         if (kaddr && ip_is_kobject(port)) {
 510                 *addrp = VM_KERNEL_UNSLIDE_OR_PERM(kaddr);
 511         }
 512 #endif
 513
 514         io_object_t obj = NULL;
 515         natural_t   kotype = ip_kotype(port);
 516         if (desc) {
 517                 *desc = '\0';
 518                 switch (kotype) {
 519                 case IKOT_IOKIT_OBJECT:
 520                 case IKOT_IOKIT_CONNECT:
 521                 case IKOT_IOKIT_IDENT:
 522                 case IKOT_UEXT_OBJECT:
 523                         obj = (io_object_t) kaddr;
 524                         iokit_add_reference(obj, IKOT_IOKIT_OBJECT);
 525                         break;
 526
 527                 default:
 528                         break;
 529                 }
 530         }
 531
 532         ip_unlock(port);
 533
 534         if (obj) {
 535                 iokit_port_object_description(obj, desc);
 536                 iokit_remove_reference(obj);
 537         }
 538
 539         return KERN_SUCCESS;
 540 }
 541 #endif /* MACH_IPC_DEBUG */
 542
 543 kern_return_t
 544 mach_port_kobject(
 545         ipc_space_t                     space,
 546         mach_port_name_t                name,
 547         natural_t                       *typep,
 548         mach_vm_address_t               *addrp)
 549 {
 550         return mach_port_kobject_description(space, name, typep, addrp, NULL);
 551 }
 552
 553 /*
 554  *      Routine:        mach_port_kernel_object [Legacy kernel call]
 555  *      Purpose:
 556  *              Retrieve the type and address of the kernel object
 557  *              represented by a send or receive right. Hard-coded
 558  *              to return only the low-order 32-bits of the kernel
 559  *              object.
 560  *      Conditions:
 561  *              Nothing locked.
 562  *      Returns:
 563  *              KERN_SUCCESS            Retrieved kernel object info.
 564  *              KERN_INVALID_TASK       The space is null.
 565  *              KERN_INVALID_TASK       The space is dead.
 566  *              KERN_INVALID_NAME       The name doesn't denote a right.
 567  *              KERN_INVALID_RIGHT      Name doesn't denote
 568  *                                      send or receive rights.
 569  */
 570
 571 #if !MACH_IPC_DEBUG
 572 kern_return_t
 573 mach_port_kernel_object(
 574         __unused ipc_space_t            space,
 575         __unused mach_port_name_t       name,
 576         __unused unsigned int           *typep,
 577         __unused unsigned int           *addrp)
 578 {
 579         return KERN_FAILURE;
 580 }
 581 #else
 582 kern_return_t
 583 mach_port_kernel_object(
 584         ipc_space_t                     space,
 585         mach_port_name_t                name,
 586         unsigned int                    *typep,
 587         unsigned int                    *addrp)
 588 {
 589         mach_vm_address_t addr = 0;
 590         kern_return_t kr;
 591
 592         kr = mach_port_kobject(space, name, typep, &addr);
 593         *addrp = (unsigned int) addr;
 594         return kr;
 595 }
 596 #endif /* MACH_IPC_DEBUG */
 597
 598 #if (DEVELOPMENT || DEBUG)
 599 kern_return_t
 600 mach_port_special_reply_port_reset_link(
 601         ipc_space_t             space,
 602         mach_port_name_t        name,
 603         boolean_t               *srp_lost_link)
 604 {
 605         ipc_port_t port;
 606         kern_return_t kr;
 607         thread_t thread = current_thread();
 608
 609         if (space != current_space()) {
 610                 return KERN_INVALID_TASK;
 611         }
 612
 613         if (!MACH_PORT_VALID(name)) {
 614                 return KERN_INVALID_NAME;
 615         }
 616
 617         if (!IP_VALID(thread->ith_special_reply_port)) {
 618                 return KERN_INVALID_VALUE;
 619         }
 620
 621         kr = ipc_port_translate_receive(space, name, &port);
 622         if (kr != KERN_SUCCESS) {
 623                 return kr;
 624         }
 625
 626         if (thread->ith_special_reply_port != port) {
 627                 ip_unlock(port);
 628                 return KERN_INVALID_ARGUMENT;
 629         }
 630
 631         imq_lock(&port->ip_messages);
 632         *srp_lost_link = (port->ip_srp_lost_link == 1)? TRUE : FALSE;
 633         port->ip_srp_lost_link = 0;
 634         imq_unlock(&port->ip_messages);
 635
 636         ip_unlock(port);
 637         return KERN_SUCCESS;
 638 }
 639 #else
 640 kern_return_t
 641 mach_port_special_reply_port_reset_link(
 642         __unused ipc_space_t            space,
 643         __unused mach_port_name_t       name,
 644         __unused boolean_t              *srp_lost_link)
 645 {
 646         return KERN_NOT_SUPPORTED;
 647 }
 648 #endif