vm_region.man

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10

    1 .\" 
    2 .\" Mach Operating System
    3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
    4 .\" All Rights Reserved.
    5 .\" 
    6 .\" Permission to use, copy, modify and distribute this software and its
    7 .\" documentation is hereby granted, provided that both the copyright
    8 .\" notice and this permission notice appear in all copies of the
    9 .\" software, derivative works or modified versions, and any portions
   10 .\" thereof, and that both notices appear in supporting documentation.
   11 .\" 
   12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
   13 .\" CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
   14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
   15 .\" 
   16 .\" Carnegie Mellon requests users of this software to return to
   17 .\" 
   18 .\"  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
   19 .\"  School of Computer Science
   20 .\"  Carnegie Mellon University
   21 .\"  Pittsburgh PA 15213-3890
   22 .\" 
   23 .\" any improvements or extensions that they make and grant Carnegie Mellon
   24 .\" the rights to redistribute these changes.
   25 .\" 
   26 .\" 
   27 .\" HISTORY
   28 .\" $Log:       vm_region.man,v $
   29 .\" Revision 2.5  93/03/18  15:17:01  mrt
   30 .\"     corrected types
   31 .\"     [93/03/12  16:55:37  lli]
   32 .\" 
   33 .\" Revision 2.4  91/05/14  17:16:21  mrt
   34 .\"     Correcting copyright
   35 .\" 
   36 .\" Revision 2.3  91/02/14  14:16:35  mrt
   37 .\"     Changed to new Mach copyright
   38 .\"     [91/02/12  18:17:38  mrt]
   39 .\" 
   40 .\" Revision 2.2  90/08/07  18:48:05  rpd
   41 .\"     Created.
   42 .\" 
   43 .TH vm_region 2 11/20/87
   44 .CM 4
   45 .SH NAME
   46 .nf
   47 vm_region  \-  returns information about regions of a task's address space
   48 .SH SYNOPSIS
   49 .nf
   50 .ft B
   51 #include <mach.h>
   52 
   53 .nf
   54 .ft B
   55 kern_return_t  vm_region(target_task, address, size, protection,
   56                          max_protection, inheritance, shared,
   57                          object_name, offset)
   58         mach_port_t             target_task;
   59         vm_address_t            *address;               /* in/out */
   60         vm_size_t               *size;                  /* out */
   61         vm_prot_t               *protection;            /* out */
   62         vm_prot_t               *max_protection;        /* out */
   63         vm_inherit_t            *inheritance;           /* out */
   64         boolean_t               *shared;                /* out */
   65         mach_port_t             *object_name;           /* out */
   66         vm_offset_t             *offset;                /* out */
   67 
   68 
   69 .fi
   70 .ft P
   71 .SH ARGUMENTS
   72 .TP 15
   73 .B
   74 target_task
   75 The task for which an address space description is requested.
   76 .TP 15
   77 .B
   78 address
   79 The address at which to start looking for a region.
   80 .TP 15
   81 .B
   82 size
   83 The size (in bytes) of the located region.
   84 .TP 15
   85 .B
   86 protection
   87 The current protection of the region.
   88 .TP 15
   89 .B
   90 max_protection
   91 The maximum allowable protection for this region.
   92 .TP 15
   93 .B
   94 inheritance
   95 The inheritance attribute for this region.
   96 .TP 15
   97 .B
   98 shared
   99 Is this region shared or not.
  100 .TP 15
  101 .B
  102 object_name
  103 The port identifying the memory object associated with this
  104 region.  (See 
  105 .B pager_init
  106 .) 
  107 .TP 15
  108 .B
  109 offset
  110 The offset into the pager object that this region begins at.
  111 
  112 .SH DESCRIPTION
  113 
  114 .B vm_region
  115 returns a description of the specified region of the target
  116 task's virtual address space.  
  117 .B vm_region
  118 begins at 
  119 .B address
  120 and looks
  121 forward thru memory until it comes to an allocated region.  (If address is
  122 within a region, then that region is used.)  Various bits of information
  123 about the region are returned.  If 
  124 .B address
  125 was 
  126 .B not
  127 within a region,
  128 then 
  129 .B address
  130 is set to the start of the first region which follows the
  131 incoming value.  In this way an entire address space can be scanned.
  132 
  133 .SH DIAGNOSTICS
  134 .TP 25
  135 KERN_SUCCESS
  136 Region located and information returned.
  137 .TP 25
  138 KERN_NO_SPACE
  139 There is no region at or above 
  140 .B address
  141 in the specified task.
  142 
  143 .SH SEE ALSO
  144 .B vm_allocate, vm_deallocate, vm_protect, vm_inherit
  145 
  146 
  147 
  148 
  149

Cache object: 017c32d6c0aa14a5ca578f9eab4a7248

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.

FreeBSD/Linux Kernel Cross Reference sys/man/vm_region.man

FreeBSD/Linux Kernel Cross Reference
sys/man/vm_region.man