osfmk/vm/vm_page.h

   1 /*
   2  * Copyright (c) 2000-2006 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,1989,1988 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:   vm/vm_page.h
  60  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  61  *      Date:   1985
  62  *
  63  *      Resident memory system definitions.
  64  */
  65
  66 #ifndef _VM_VM_PAGE_H_
  67 #define _VM_VM_PAGE_H_
  68
  69 #include <debug.h>
  70
  71 #include <mach/boolean.h>
  72 #include <mach/vm_prot.h>
  73 #include <mach/vm_param.h>
  74 #include <vm/vm_object.h>
  75 #include <kern/queue.h>
  76 #include <kern/lock.h>
  77
  78 #include <kern/macro_help.h>
  79 #include <libkern/OSAtomic.h>
  80
  81
  82 /*
  83  * VM_PAGE_MIN_SPECULATIVE_AGE_Q through VM_PAGE_MAX_SPECULATIVE_AGE_Q
  84  * represents a set of aging bins that are 'protected'...
  85  *
  86  * VM_PAGE_SPECULATIVE_AGED_Q is a list of the speculative pages that have
  87  * not yet been 'claimed' but have been aged out of the protective bins
  88  * this occurs in vm_page_speculate when it advances to the next bin
  89  * and discovers that it is still occupied... at that point, all of the
  90  * pages in that bin are moved to the VM_PAGE_SPECULATIVE_AGED_Q.  the pages
  91  * in that bin are all guaranteed to have reached at least the maximum age
  92  * we allow for a protected page... they can be older if there is no
  93  * memory pressure to pull them from the bin, or there are no new speculative pages
  94  * being generated to push them out.
  95  * this list is the one that vm_pageout_scan will prefer when looking
  96  * for pages to move to the underweight free list
  97  *
  98  * VM_PAGE_MAX_SPECULATIVE_AGE_Q * VM_PAGE_SPECULATIVE_Q_AGE_MS
  99  * defines the amount of time a speculative page is normally
 100  * allowed to live in the 'protected' state (i.e. not available
 101  * to be stolen if vm_pageout_scan is running and looking for
 102  * pages)...  however, if the total number of speculative pages
 103  * in the protected state exceeds our limit (defined in vm_pageout.c)
 104  * and there are none available in VM_PAGE_SPECULATIVE_AGED_Q, then
 105  * vm_pageout_scan is allowed to steal pages from the protected
 106  * bucket even if they are underage.
 107  *
 108  * vm_pageout_scan is also allowed to pull pages from a protected
 109  * bin if the bin has reached the "age of consent" we've set
 110  */
 111 #define VM_PAGE_MAX_SPECULATIVE_AGE_Q   10
 112 #define VM_PAGE_MIN_SPECULATIVE_AGE_Q   1
 113 #define VM_PAGE_SPECULATIVE_AGED_Q      0
 114
 115 #define VM_PAGE_SPECULATIVE_Q_AGE_MS    500
 116
 117
 118 struct vm_speculative_age_q {
 119         /*
 120          * memory queue for speculative pages via clustered pageins
 121          */
 122         queue_head_t    age_q;
 123         mach_timespec_t age_ts;
 124 };
 125
 126
 127 extern
 128 struct vm_speculative_age_q     vm_page_queue_speculative[];
 129
 130 extern int                      speculative_steal_index;
 131 extern int                      speculative_age_index;
 132
 133
 134 /*
 135  *      Management of resident (logical) pages.
 136  *
 137  *      A small structure is kept for each resident
 138  *      page, indexed by page number.  Each structure
 139  *      is an element of several lists:
 140  *
 141  *              A hash table bucket used to quickly
 142  *              perform object/offset lookups
 143  *
 144  *              A list of all pages for a given object,
 145  *              so they can be quickly deactivated at
 146  *              time of deallocation.
 147  *
 148  *              An ordered list of pages due for pageout.
 149  *
 150  *      In addition, the structure contains the object
 151  *      and offset to which this page belongs (for pageout),
 152  *      and sundry status bits.
 153  *
 154  *      Fields in this structure are locked either by the lock on the
 155  *      object that the page belongs to (O) or by the lock on the page
 156  *      queues (P).  [Some fields require that both locks be held to
 157  *      change that field; holding either lock is sufficient to read.]
 158  */
 159
 160 struct vm_page {
 161         queue_chain_t   pageq;          /* queue info for FIFO */
 162                                         /* queue or free list (P) */
 163
 164         queue_chain_t   listq;          /* all pages in same object (O) */
 165         struct vm_page  *next;          /* VP bucket link (O) */
 166
 167         vm_object_t     object;         /* which object am I in (O&P) */
 168         vm_object_offset_t offset;      /* offset into that object (O,P) */
 169
 170         /*
 171          * The following word of flags is protected
 172          * by the "page queues" lock.
 173          *
 174          * we use the 'wire_count' field to store the local
 175          * queue id if local queues are enabled...
 176          * see the comments at 'VM_PAGE_QUEUES_REMOVE' as to
 177          * why this is safe to do
 178          */
 179 #define local_id wire_count
 180         unsigned int    wire_count:16,  /* how many wired down maps use me? (O&P) */
 181         /* boolean_t */ inactive:1,     /* page is in inactive list (P) */
 182                         active:1,       /* page is in active list (P) */
 183                         pageout_queue:1,/* page is on queue for pageout (P) */
 184                         speculative:1,  /* page is on speculative list (P) */
 185                         laundry:1,      /* page is being cleaned now (P)*/
 186                         free:1,         /* page is on free list (P) */
 187                         reference:1,    /* page has been used (P) */
 188                         gobbled:1,      /* page used internally (P) */
 189                         private:1,      /* Page should not be returned to
 190                                          *  the free list (P) */
 191                         throttled:1,    /* pager is not responding (P) */
 192                         local:1,
 193                         __unused_pageq_bits:5;  /* 5 bits available here */
 194
 195         ppnum_t         phys_page;      /* Physical address of page, passed
 196                                          *  to pmap_enter (read-only) */
 197
 198         /*
 199          * The following word of flags is protected
 200          * by the "VM object" lock.
 201          */
 202         unsigned int
 203         /* boolean_t */ busy:1,         /* page is in transit (O) */
 204                         wanted:1,       /* someone is waiting for page (O) */
 205                         tabled:1,       /* page is in VP table (O) */
 206                         fictitious:1,   /* Physical page doesn't exist (O) */
 207         /*
 208          * IMPORTANT: the "pmapped" bit can be turned on while holding the
 209          * VM object "shared" lock.  See vm_fault_enter().
 210          * This is OK as long as it's the only bit in this bit field that
 211          * can be updated without holding the VM object "exclusive" lock.
 212          */
 213                         pmapped:1,      /* page has been entered at some
 214                                          * point into a pmap (O **shared**) */
 215                         wpmapped:1,     /* page has been entered at some
 216                                          * point into a pmap for write (O) */
 217                         pageout:1,      /* page wired & busy for pageout (O) */
 218                         absent:1,       /* Data has been requested, but is
 219                                          *  not yet available (O) */
 220                         error:1,        /* Data manager was unable to provide
 221                                          *  data due to error (O) */
 222                         dirty:1,        /* Page must be cleaned (O) */
 223                         cleaning:1,     /* Page clean has begun (O) */
 224                         precious:1,     /* Page is precious; data must be
 225                                          *  returned even if clean (O) */
 226                         clustered:1,    /* page is not the faulted page (O) */
 227                         overwriting:1,  /* Request to unlock has been made
 228                                          * without having data. (O)
 229                                          * [See vm_fault_page_overwrite] */
 230                         restart:1,      /* Page was pushed higher in shadow
 231                                            chain by copy_call-related pagers;
 232                                            start again at top of chain */
 233                         unusual:1,      /* Page is absent, error, restart or
 234                                            page locked */
 235                         encrypted:1,    /* encrypted for secure swap (O) */
 236                         encrypted_cleaning:1,   /* encrypting page */
 237                         list_req_pending:1, /* pagein/pageout alt mechanism */
 238                                             /* allows creation of list      */
 239                                             /* requests on pages that are   */
 240                                             /* actively being paged.        */
 241                         dump_cleaning:1,   /* set by the pageout daemon when */
 242                                            /* a page being cleaned is       */
 243                                            /* encountered and targeted as   */
 244                                            /* a pageout candidate           */
 245                         cs_validated:1,    /* code-signing: page was checked */
 246                         cs_tainted:1,      /* code-signing: page is tainted */
 247                         no_cache:1,        /* page is not to be cached and */
 248                                            /* should be reused ahead of    */
 249                                            /* other pages                  */
 250                         zero_fill:1,
 251                         reusable:1,
 252                         __unused_object_bits:7;  /* 7 bits available here */
 253
 254 #if __LP64__
 255         unsigned int __unused_padding;  /* Pad structure explicitly
 256                                         * to 8-byte multiple for LP64 */
 257 #endif
 258 };
 259
 260 #define DEBUG_ENCRYPTED_SWAP    1
 261 #if DEBUG_ENCRYPTED_SWAP
 262 #define ASSERT_PAGE_DECRYPTED(page)                                     \
 263         MACRO_BEGIN                                                     \
 264         if ((page)->encrypted) {                                        \
 265                 panic("VM page %p should not be encrypted here\n",      \
 266                       (page));                                          \
 267         }                                                               \
 268         MACRO_END
 269 #else   /* DEBUG_ENCRYPTED_SWAP */
 270 #define ASSERT_PAGE_DECRYPTED(page) assert(!(page)->encrypted)
 271 #endif  /* DEBUG_ENCRYPTED_SWAP */
 272
 273 typedef struct vm_page  *vm_page_t;
 274
 275
 276 typedef struct vm_locks_array {
 277         char    pad  __attribute__ ((aligned (64)));
 278         lck_mtx_t       vm_page_queue_lock2 __attribute__ ((aligned (64)));
 279         lck_mtx_t       vm_page_queue_free_lock2 __attribute__ ((aligned (64)));
 280         char    pad2  __attribute__ ((aligned (64)));
 281 } vm_locks_array_t;
 282
 283
 284 #define VM_PAGE_WIRED(m)        ((!(m)->local && (m)->wire_count))
 285 #define VM_PAGE_NULL            ((vm_page_t) 0)
 286 #define NEXT_PAGE(m)            ((vm_page_t) (m)->pageq.next)
 287 #define NEXT_PAGE_PTR(m)        ((vm_page_t *) &(m)->pageq.next)
 288
 289 /*
 290  * XXX  The unusual bit should not be necessary.  Most of the bit
 291  * XXX  fields above really want to be masks.
 292  */
 293
 294 /*
 295  *      For debugging, this macro can be defined to perform
 296  *      some useful check on a page structure.
 297  */
 298
 299 #define VM_PAGE_CHECK(mem)                      \
 300         MACRO_BEGIN                             \
 301         VM_PAGE_QUEUES_ASSERT(mem, 1);          \
 302         MACRO_END
 303
 304 /*     Page coloring:
 305  *
 306  *     The free page list is actually n lists, one per color,
 307  *     where the number of colors is a function of the machine's
 308  *     cache geometry set at system initialization.  To disable
 309  *     coloring, set vm_colors to 1 and vm_color_mask to 0.
 310  *     The boot-arg "colors" may be used to override vm_colors.
 311  *     Note that there is little harm in having more colors than needed.
 312  */
 313
 314 #define MAX_COLORS      128
 315 #define DEFAULT_COLORS  32
 316
 317 extern
 318 unsigned int    vm_colors;              /* must be in range 1..MAX_COLORS */
 319 extern
 320 unsigned int    vm_color_mask;          /* must be (vm_colors-1) */
 321 extern
 322 unsigned int    vm_cache_geometry_colors; /* optimal #colors based on cache geometry */
 323
 324 /*
 325  * Wired memory is a very limited resource and we can't let users exhaust it
 326  * and deadlock the entire system.  We enforce the following limits:
 327  *
 328  * vm_user_wire_limit (default: all memory minus vm_global_no_user_wire_amount)
 329  *      how much memory can be user-wired in one user task
 330  *
 331  * vm_global_user_wire_limit (default: same as vm_user_wire_limit)
 332  *      how much memory can be user-wired in all user tasks
 333  *
 334  * vm_global_no_user_wire_amount (default: VM_NOT_USER_WIREABLE)
 335  *      how much memory must remain user-unwired at any time
 336  */
 337 #define VM_NOT_USER_WIREABLE (64*1024*1024)     /* 64MB */
 338 extern
 339 vm_map_size_t   vm_user_wire_limit;
 340 extern
 341 vm_map_size_t   vm_global_user_wire_limit;
 342 extern
 343 vm_map_size_t   vm_global_no_user_wire_amount;
 344
 345 /*
 346  *      Each pageable resident page falls into one of three lists:
 347  *
 348  *      free
 349  *              Available for allocation now.  The free list is
 350  *              actually an array of lists, one per color.
 351  *      inactive
 352  *              Not referenced in any map, but still has an
 353  *              object/offset-page mapping, and may be dirty.
 354  *              This is the list of pages that should be
 355  *              paged out next.  There are actually two
 356  *              inactive lists, one for pages brought in from
 357  *              disk or other backing store, and another
 358  *              for "zero-filled" pages.  See vm_pageout_scan()
 359  *              for the distinction and usage.
 360  *      active
 361  *              A list of pages which have been placed in
 362  *              at least one physical map.  This list is
 363  *              ordered, in LRU-like fashion.
 364  */
 365
 366
 367 #define VPL_LOCK_SPIN 1
 368
 369 struct vpl {
 370         unsigned int    vpl_count;
 371         queue_head_t    vpl_queue;
 372 #ifdef  VPL_LOCK_SPIN
 373         lck_spin_t      vpl_lock;
 374 #else
 375         lck_mtx_t       vpl_lock;
 376         lck_mtx_ext_t   vpl_lock_ext;
 377 #endif
 378 };
 379
 380 struct  vplq {
 381         union {
 382                 char   cache_line_pad[128];
 383                 struct vpl vpl;
 384         } vpl_un;
 385 };
 386 extern
 387 unsigned int    vm_page_local_q_count;
 388 extern
 389 struct vplq     *vm_page_local_q;
 390 extern
 391 unsigned int    vm_page_local_q_soft_limit;
 392 extern
 393 unsigned int    vm_page_local_q_hard_limit;
 394 extern
 395 vm_locks_array_t vm_page_locks;
 396
 397 extern
 398 queue_head_t    vm_page_queue_free[MAX_COLORS]; /* memory free queue */
 399 extern
 400 queue_head_t    vm_lopage_queue_free;           /* low memory free queue */
 401 extern
 402 vm_page_t       vm_page_queue_fictitious;       /* fictitious free queue */
 403 extern
 404 queue_head_t    vm_page_queue_active;   /* active memory queue */
 405 extern
 406 queue_head_t    vm_page_queue_inactive; /* inactive memory queue for normal pages */
 407 extern
 408 queue_head_t    vm_page_queue_zf;       /* inactive memory queue for zero fill */
 409 extern
 410 queue_head_t    vm_page_queue_throttled;        /* memory queue for throttled pageout pages */
 411
 412 extern
 413 vm_offset_t     first_phys_addr;        /* physical address for first_page */
 414 extern
 415 vm_offset_t     last_phys_addr;         /* physical address for last_page */
 416
 417 extern
 418 unsigned int    vm_page_free_count;     /* How many pages are free? (sum of all colors) */
 419 extern
 420 unsigned int    vm_page_fictitious_count;/* How many fictitious pages are free? */
 421 extern
 422 unsigned int    vm_page_active_count;   /* How many pages are active? */
 423 extern
 424 unsigned int    vm_page_inactive_count; /* How many pages are inactive? */
 425 extern
 426 unsigned int    vm_page_throttled_count;/* How many inactives are throttled */
 427 extern
 428 unsigned int    vm_page_speculative_count;      /* How many speculative pages are unclaimed? */
 429 extern
 430 unsigned int    vm_page_wire_count;     /* How many pages are wired? */
 431 extern
 432 unsigned int    vm_page_free_target;    /* How many do we want free? */
 433 extern
 434 unsigned int    vm_page_free_min;       /* When to wakeup pageout */
 435 extern
 436 unsigned int    vm_page_throttle_limit; /* When to throttle new page creation */
 437 extern
 438 uint32_t        vm_page_creation_throttle;      /* When to throttle new page creation */
 439 extern
 440 unsigned int    vm_page_inactive_target;/* How many do we want inactive? */
 441 extern
 442 unsigned int    vm_page_inactive_min;   /* When do wakeup pageout */
 443 extern
 444 unsigned int    vm_page_free_reserved;  /* How many pages reserved to do pageout */
 445 extern
 446 unsigned int    vm_page_throttle_count; /* Count of page allocations throttled */
 447 extern
 448 unsigned int    vm_page_gobble_count;
 449
 450 #if DEVELOPMENT || DEBUG
 451 extern
 452 unsigned int    vm_page_speculative_used;
 453 #endif
 454
 455 extern
 456 unsigned int    vm_page_purgeable_count;/* How many pages are purgeable now ? */
 457 extern
 458 unsigned int    vm_page_purgeable_wired_count;/* How many purgeable pages are wired now ? */
 459 extern
 460 uint64_t        vm_page_purged_count;   /* How many pages got purged so far ? */
 461
 462 extern unsigned int     vm_page_free_wanted;
 463                                 /* how many threads are waiting for memory */
 464
 465 extern unsigned int     vm_page_free_wanted_privileged;
 466                                 /* how many VM privileged threads are waiting for memory */
 467
 468 extern ppnum_t  vm_page_fictitious_addr;
 469                                 /* (fake) phys_addr of fictitious pages */
 470
 471 extern ppnum_t  vm_page_guard_addr;
 472                                 /* (fake) phys_addr of guard pages */
 473
 474
 475 extern boolean_t        vm_page_deactivate_hint;
 476
 477 // 0 = all pages avail, 1 = disable high mem, 2 = prefer himem
 478 extern int              vm_himemory_mode;
 479
 480 extern ppnum_t          vm_lopage_poolend;
 481 extern int              vm_lopage_poolsize;
 482 extern uint64_t         max_valid_dma_address;
 483
 484
 485 /*
 486  * Prototypes for functions exported by this module.
 487  */
 488 extern void             vm_page_bootstrap(
 489                                         vm_offset_t     *startp,
 490                                         vm_offset_t     *endp) __attribute__((section("__TEXT, initcode")));
 491
 492 extern void             vm_page_module_init(void) __attribute__((section("__TEXT, initcode")));
 493
 494 extern void             vm_page_init_local_q(void);
 495
 496 extern void             vm_page_create(
 497                                         ppnum_t         start,
 498                                         ppnum_t         end);
 499
 500 extern vm_page_t        vm_page_lookup(
 501                                         vm_object_t             object,
 502                                         vm_object_offset_t      offset);
 503
 504 extern vm_page_t        vm_page_grab_fictitious(void);
 505
 506 extern vm_page_t        vm_page_grab_guard(void);
 507
 508 extern void             vm_page_release_fictitious(
 509                                         vm_page_t page);
 510
 511 extern void             vm_page_more_fictitious(void);
 512
 513 extern int              vm_pool_low(void);
 514
 515 extern vm_page_t        vm_page_grab(void);
 516
 517 extern vm_page_t        vm_page_grablo(void);
 518
 519 extern void             vm_page_release(
 520                                         vm_page_t       page);
 521
 522 extern boolean_t        vm_page_wait(
 523                                         int             interruptible );
 524
 525 extern vm_page_t        vm_page_alloc(
 526                                         vm_object_t             object,
 527                                         vm_object_offset_t      offset);
 528
 529 extern vm_page_t        vm_page_alloclo(
 530                                         vm_object_t             object,
 531                                         vm_object_offset_t      offset);
 532
 533 extern vm_page_t        vm_page_alloc_guard(
 534         vm_object_t             object,
 535         vm_object_offset_t      offset);
 536
 537 extern void             vm_page_init(
 538                                         vm_page_t       page,
 539                                         ppnum_t         phys_page);
 540
 541 extern void             vm_page_free(
 542                                         vm_page_t       page);
 543
 544 extern void             vm_page_free_unlocked(
 545                                         vm_page_t       page,
 546                                         boolean_t       remove_from_hash);
 547
 548 extern void             vm_page_activate(
 549                                         vm_page_t       page);
 550
 551 extern void             vm_page_deactivate(
 552                                         vm_page_t       page);
 553
 554 extern void             vm_page_deactivate_internal(
 555                                         vm_page_t       page,
 556                                         boolean_t       clear_hw_reference);
 557
 558 extern void             vm_page_lru(
 559                                         vm_page_t       page);
 560
 561 extern void             vm_page_speculate(
 562                                         vm_page_t       page,
 563                                         boolean_t       new);
 564
 565 extern void             vm_page_speculate_ageit(
 566                                         struct vm_speculative_age_q *aq);
 567
 568 extern void             vm_page_reactivate_all_throttled(void);
 569
 570 extern void             vm_page_reactivate_local(uint32_t lid, boolean_t force, boolean_t nolocks);
 571
 572 extern void             vm_page_rename(
 573                                         vm_page_t               page,
 574                                         vm_object_t             new_object,
 575                                         vm_object_offset_t      new_offset,
 576                                         boolean_t               encrypted_ok);
 577
 578 extern void             vm_page_insert(
 579                                         vm_page_t               page,
 580                                         vm_object_t             object,
 581                                         vm_object_offset_t      offset);
 582
 583 extern void             vm_page_insert_internal(
 584                                         vm_page_t               page,
 585                                         vm_object_t             object,
 586                                         vm_object_offset_t      offset,
 587                                         boolean_t               queues_lock_held,
 588                                         boolean_t               insert_in_hash);
 589
 590 extern void             vm_page_replace(
 591                                         vm_page_t               mem,
 592                                         vm_object_t             object,
 593                                         vm_object_offset_t      offset);
 594
 595 extern void             vm_page_remove(
 596                                         vm_page_t       page,
 597                                         boolean_t       remove_from_hash);
 598
 599 extern void             vm_page_zero_fill(
 600                                         vm_page_t       page);
 601
 602 extern void             vm_page_part_zero_fill(
 603                                         vm_page_t       m,
 604                                         vm_offset_t     m_pa,
 605                                         vm_size_t       len);
 606
 607 extern void             vm_page_copy(
 608                                         vm_page_t       src_page,
 609                                         vm_page_t       dest_page);
 610
 611 extern void             vm_page_part_copy(
 612                                         vm_page_t       src_m,
 613                                         vm_offset_t     src_pa,
 614                                         vm_page_t       dst_m,
 615                                         vm_offset_t     dst_pa,
 616                                         vm_size_t       len);
 617
 618 extern void             vm_page_wire(
 619                                         vm_page_t       page);
 620
 621 extern void             vm_page_unwire(
 622                                         vm_page_t       page);
 623
 624 extern void             vm_set_page_size(void);
 625
 626 extern void             vm_page_gobble(
 627                                         vm_page_t      page);
 628
 629 extern void             vm_page_validate_cs(vm_page_t   page);
 630 extern void             vm_page_validate_cs_mapped(
 631         vm_page_t       page,
 632         const void      *kaddr);
 633
 634 extern void             vm_page_free_prepare_queues(
 635                                         vm_page_t       page);
 636
 637 extern void             vm_page_free_prepare_object(
 638                                         vm_page_t       page,
 639                                         boolean_t       remove_from_hash);
 640
 641 /*
 642  *      Functions implemented as macros. m->wanted and m->busy are
 643  *      protected by the object lock.
 644  */
 645
 646 #define PAGE_ASSERT_WAIT(m, interruptible)                      \
 647                 (((m)->wanted = TRUE),                          \
 648                  assert_wait((event_t) (m), (interruptible)))
 649
 650 #define PAGE_SLEEP(o, m, interruptible)                         \
 651                 (((m)->wanted = TRUE),                          \
 652                  thread_sleep_vm_object((o), (m), (interruptible)))
 653
 654 #define PAGE_WAKEUP_DONE(m)                                     \
 655                 MACRO_BEGIN                                     \
 656                 (m)->busy = FALSE;                              \
 657                 if ((m)->wanted) {                              \
 658                         (m)->wanted = FALSE;                    \
 659                         thread_wakeup((event_t) (m));           \
 660                 }                                               \
 661                 MACRO_END
 662
 663 #define PAGE_WAKEUP(m)                                          \
 664                 MACRO_BEGIN                                     \
 665                 if ((m)->wanted) {                              \
 666                         (m)->wanted = FALSE;                    \
 667                         thread_wakeup((event_t) (m));           \
 668                 }                                               \
 669                 MACRO_END
 670
 671 #define VM_PAGE_FREE(p)                         \
 672                 MACRO_BEGIN                     \
 673                 vm_page_free_unlocked(p, TRUE); \
 674                 MACRO_END
 675
 676 #define VM_PAGE_GRAB_FICTITIOUS(M)                                      \
 677                 MACRO_BEGIN                                             \
 678                 while ((M = vm_page_grab_fictitious()) == VM_PAGE_NULL) \
 679                         vm_page_more_fictitious();                      \
 680                 MACRO_END
 681
 682 #define VM_PAGE_WAIT()          ((void)vm_page_wait(THREAD_UNINT))
 683
 684 #define vm_page_queue_lock (vm_page_locks.vm_page_queue_lock2)
 685 #define vm_page_queue_free_lock (vm_page_locks.vm_page_queue_free_lock2)
 686
 687 #define vm_page_lock_queues()   lck_mtx_lock(&vm_page_queue_lock)
 688 #define vm_page_unlock_queues() lck_mtx_unlock(&vm_page_queue_lock)
 689
 690 #define vm_page_lockspin_queues()       lck_mtx_lock_spin(&vm_page_queue_lock)
 691 #define vm_page_trylockspin_queues()    lck_mtx_try_lock_spin(&vm_page_queue_lock)
 692 #define vm_page_lockconvert_queues()    lck_mtx_convert_spin(&vm_page_queue_lock)
 693
 694 #ifdef  VPL_LOCK_SPIN
 695 #define VPL_LOCK_INIT(vlq, vpl_grp, vpl_attr) lck_spin_init(&vlq->vpl_lock, vpl_grp, vpl_attr)
 696 #define VPL_LOCK(vpl) lck_spin_lock(vpl)
 697 #define VPL_UNLOCK(vpl) lck_spin_unlock(vpl)
 698 #else
 699 #define VPL_LOCK_INIT(vlq, vpl_grp, vpl_attr) lck_mtx_init_ext(&vlq->vpl_lock, &vlq->vpl_lock_ext, vpl_grp, vpl_attr)
 700 #define VPL_LOCK(vpl) lck_mtx_lock_spin(vpl)
 701 #define VPL_UNLOCK(vpl) lck_mtx_unlock(vpl)
 702 #endif
 703
 704 #if MACH_ASSERT
 705 extern void vm_page_queues_assert(vm_page_t mem, int val);
 706 #define VM_PAGE_QUEUES_ASSERT(mem, val) vm_page_queues_assert((mem), (val))
 707 #else
 708 #define VM_PAGE_QUEUES_ASSERT(mem, val)
 709 #endif
 710
 711
 712 /*
 713  * 'vm_fault_enter' will place newly created pages (zero-fill and COW) onto the
 714  * local queues if they exist... its the only spot in the system where we add pages
 715  * to those queues...  once on those queues, those pages can only move to one of the
 716  * global page queues or the free queues... they NEVER move from local q to local q.
 717  * the 'local' state is stable when VM_PAGE_QUEUES_REMOVE is called since we're behind
 718  * the global vm_page_queue_lock at this point...  we still need to take the local lock
 719  * in case this operation is being run on a different CPU then the local queue's identity,
 720  * but we don't have to worry about the page moving to a global queue or becoming wired
 721  * while we're grabbing the local lock since those operations would require the global
 722  * vm_page_queue_lock to be held, and we already own it.
 723  *
 724  * this is why its safe to utilze the wire_count field in the vm_page_t as the local_id...
 725  * 'wired' and local are ALWAYS mutually exclusive conditions.
 726  */
 727 #define VM_PAGE_QUEUES_REMOVE(mem)                              \
 728         MACRO_BEGIN                                             \
 729         VM_PAGE_QUEUES_ASSERT(mem, 1);                          \
 730         assert(!mem->laundry);                                  \
 731         assert(!mem->pageout_queue);                            \
 732         if (mem->local) {                                       \
 733                 struct vpl      *lq;                            \
 734                 assert(mem->object != kernel_object);           \
 735                 assert(!mem->inactive && !mem->speculative);    \
 736                 assert(!mem->active && !mem->throttled);        \
 737                 lq = &vm_page_local_q[mem->local_id].vpl_un.vpl;        \
 738                 VPL_LOCK(&lq->vpl_lock);                        \
 739                 queue_remove(&lq->vpl_queue,                    \
 740                              mem, vm_page_t, pageq);            \
 741                 mem->local = FALSE;                             \
 742                 mem->local_id = 0;                              \
 743                 lq->vpl_count--;                                \
 744                 VPL_UNLOCK(&lq->vpl_lock);                      \
 745         }                                                       \
 746         if (mem->active) {                                      \
 747                 assert(mem->object != kernel_object);           \
 748                 assert(!mem->inactive && !mem->speculative);    \
 749                 assert(!mem->throttled);                        \
 750                 queue_remove(&vm_page_queue_active,             \
 751                         mem, vm_page_t, pageq);                 \
 752                 mem->active = FALSE;                            \
 753                 if (!mem->fictitious) {                         \
 754                         vm_page_active_count--;                 \
 755                 } else {                                        \
 756                         assert(mem->phys_page ==                \
 757                                vm_page_fictitious_addr);        \
 758                 }                                               \
 759         }                                                       \
 760                                                                 \
 761         else if (mem->inactive) {                               \
 762                 assert(mem->object != kernel_object);           \
 763                 assert(!mem->active && !mem->speculative);      \
 764                 assert(!mem->throttled);                        \
 765                 if (mem->zero_fill) {                           \
 766                         queue_remove(&vm_page_queue_zf,         \
 767                         mem, vm_page_t, pageq);                 \
 768                         vm_zf_queue_count--;                    \
 769                 } else {                                        \
 770                         queue_remove(&vm_page_queue_inactive,   \
 771                         mem, vm_page_t, pageq);                 \
 772                 }                                               \
 773                 mem->inactive = FALSE;                          \
 774                 if (!mem->fictitious) {                         \
 775                         vm_page_inactive_count--;               \
 776                         vm_purgeable_q_advance_all();           \
 777                 } else {                                        \
 778                         assert(mem->phys_page ==                \
 779                                vm_page_fictitious_addr);        \
 780                 }                                               \
 781         }                                                       \
 782                                                                 \
 783         else if (mem->throttled) {                              \
 784                 assert(!mem->active && !mem->inactive);         \
 785                 assert(!mem->speculative);                      \
 786                 queue_remove(&vm_page_queue_throttled,          \
 787                              mem, vm_page_t, pageq);            \
 788                 mem->throttled = FALSE;                         \
 789                 if (!mem->fictitious)                           \
 790                         vm_page_throttled_count--;              \
 791         }                                                       \
 792                                                                 \
 793         else if (mem->speculative) {                            \
 794                 assert(!mem->active && !mem->inactive);         \
 795                 assert(!mem->throttled);                        \
 796                 assert(!mem->fictitious);                       \
 797                 remque(&mem->pageq);                            \
 798                 mem->speculative = FALSE;                       \
 799                 vm_page_speculative_count--;                    \
 800         }                                                       \
 801         mem->pageq.next = NULL;                                 \
 802         mem->pageq.prev = NULL;                                 \
 803         VM_PAGE_QUEUES_ASSERT(mem, 0);                          \
 804         MACRO_END
 805
 806
 807 #if DEVELOPMENT || DEBUG
 808 #define VM_PAGE_SPECULATIVE_USED_ADD()                          \
 809         MACRO_BEGIN                                             \
 810         OSAddAtomic(1, &vm_page_speculative_used);      \
 811         MACRO_END
 812 #else
 813 #define VM_PAGE_SPECULATIVE_USED_ADD()
 814 #endif
 815
 816
 817 #define VM_PAGE_CONSUME_CLUSTERED(mem)                          \
 818         MACRO_BEGIN                                             \
 819         if (mem->clustered) {                                   \
 820                 assert(mem->object);                            \
 821                 mem->object->pages_used++;                      \
 822                 mem->clustered = FALSE;                         \
 823                 VM_PAGE_SPECULATIVE_USED_ADD();                 \
 824         }                                                       \
 825         MACRO_END
 826
 827 #endif  /* _VM_VM_PAGE_H_ */