osfmk/vm/vm_page.h

   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,1988 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  *      File:   vm/vm_page.h
  54  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  55  *      Date:   1985
  56  *
  57  *      Resident memory system definitions.
  58  */
  59
  60 #ifndef _VM_VM_PAGE_H_
  61 #define _VM_VM_PAGE_H_
  62
  63 #include <mach/boolean.h>
  64 #include <mach/vm_prot.h>
  65 #include <mach/vm_param.h>
  66 #include <vm/vm_object.h>
  67 #include <kern/queue.h>
  68 #include <kern/lock.h>
  69
  70 #include <kern/macro_help.h>
  71
  72 /*
  73  * Each page entered on the inactive queue obtains a ticket from a
  74  * particular ticket roll.  Pages granted tickets from a particular
  75  * roll  generally flow through the queue as a group.  In this way when a
  76  * page with a ticket from a particular roll is pulled from the top of the
  77  * queue it is extremely likely that the pages near the top will have tickets
  78  * from the same or adjacent rolls.  In this way the proximity to the top
  79  * of the queue can be loosely ascertained by determining the identity of
  80  * the roll the pages ticket came from.
  81  */
  82
  83
  84 extern int      vm_page_ticket_roll;
  85 extern int      vm_page_ticket;
  86
  87
  88 #define VM_PAGE_TICKETS_IN_ROLL  512
  89 #define VM_PAGE_TICKET_ROLL_IDS  16
  90
  91 /*
  92  *      Management of resident (logical) pages.
  93  *
  94  *      A small structure is kept for each resident
  95  *      page, indexed by page number.  Each structure
  96  *      is an element of several lists:
  97  *
  98  *              A hash table bucket used to quickly
  99  *              perform object/offset lookups
 100  *
 101  *              A list of all pages for a given object,
 102  *              so they can be quickly deactivated at
 103  *              time of deallocation.
 104  *
 105  *              An ordered list of pages due for pageout.
 106  *
 107  *      In addition, the structure contains the object
 108  *      and offset to which this page belongs (for pageout),
 109  *      and sundry status bits.
 110  *
 111  *      Fields in this structure are locked either by the lock on the
 112  *      object that the page belongs to (O) or by the lock on the page
 113  *      queues (P).  [Some fields require that both locks be held to
 114  *      change that field; holding either lock is sufficient to read.]
 115  */
 116
 117 struct vm_page {
 118         queue_chain_t   pageq;          /* queue info for FIFO
 119                                          * queue or free list (P) */
 120         queue_chain_t   listq;          /* all pages in same object (O) */
 121         struct vm_page  *next;          /* VP bucket link (O) */
 122
 123         vm_object_t     object;         /* which object am I in (O&P) */
 124         vm_object_offset_t offset;      /* offset into that object (O,P) */
 125
 126         unsigned int    wire_count:16,  /* how many wired down maps use me? (O&P) */
 127                         page_ticket:4,  /* age of the page on the       */
 128                                         /* inactive queue.                  */
 129         /* boolean_t */ inactive:1,     /* page is in inactive list (P) */
 130                         active:1,       /* page is in active list (P) */
 131                         laundry:1,      /* page is being cleaned now (P)*/
 132                         free:1,         /* page is on free list (P) */
 133                         reference:1,    /* page has been used (P) */
 134                         pageout:1,      /* page wired & busy for pageout (P) */
 135                         gobbled:1,      /* page used internally (P) */
 136                         private:1,      /* Page should not be returned to
 137                                          *  the free list (O) */
 138                         zero_fill:1,
 139                         :0;
 140
 141         unsigned int
 142                         page_error:8,   /* error from I/O operations */
 143         /* boolean_t */ busy:1,         /* page is in transit (O) */
 144                         wanted:1,       /* someone is waiting for page (O) */
 145                         tabled:1,       /* page is in VP table (O) */
 146                         fictitious:1,   /* Physical page doesn't exist (O) */
 147                         no_isync:1,     /* page has not been instruction synced */
 148                         absent:1,       /* Data has been requested, but is
 149                                          *  not yet available (O) */
 150                         error:1,        /* Data manager was unable to provide
 151                                          *  data due to error (O) */
 152                         dirty:1,        /* Page must be cleaned (O) */
 153                         cleaning:1,     /* Page clean has begun (O) */
 154                         precious:1,     /* Page is precious; data must be
 155                                          *  returned even if clean (O) */
 156                         clustered:1,    /* page is not the faulted page (O) */
 157                         overwriting:1,  /* Request to unlock has been made
 158                                          * without having data. (O)
 159                                          * [See vm_fault_page_overwrite] */
 160                         restart:1,      /* Page was pushed higher in shadow
 161                                            chain by copy_call-related pagers;
 162                                            start again at top of chain */
 163                         lock_supplied:1,/* protection supplied by pager (O) */
 164         /* vm_prot_t */ page_lock:3,    /* Uses prohibited by pager (O) */
 165         /* vm_prot_t */ unlock_request:3,/* Outstanding unlock request (O) */
 166                         unusual:1,      /* Page is absent, error, restart or
 167                                            page locked */
 168                         discard_request:1,/* a memory_object_discard_request()
 169                                            * has been sent */
 170                         list_req_pending:1, /* pagein/pageout alt mechanism */
 171                                             /* allows creation of list      */
 172                                             /* requests on pages that are   */
 173                                             /* actively being paged.        */
 174                         dump_cleaning:1;   /* set by the pageout daemon when */
 175                                            /* a page being cleaned is       */
 176                                            /* encountered and targeted as   */
 177                                            /* a pageout candidate           */
 178         /* we've used up all 32 bits */
 179
 180         vm_offset_t     phys_addr;      /* Physical address of page, passed
 181                                          *  to pmap_enter (read-only) */
 182 };
 183
 184 typedef struct vm_page  *vm_page_t;
 185
 186 #define VM_PAGE_NULL            ((vm_page_t) 0)
 187 #define NEXT_PAGE(m)    ((vm_page_t) (m)->pageq.next)
 188
 189 /*
 190  * XXX  The unusual bit should not be necessary.  Most of the bit
 191  * XXX  fields above really want to be masks.
 192  */
 193
 194 /*
 195  *      For debugging, this macro can be defined to perform
 196  *      some useful check on a page structure.
 197  */
 198
 199 #define VM_PAGE_CHECK(mem)
 200
 201 /*
 202  *      Each pageable resident page falls into one of three lists:
 203  *
 204  *      free
 205  *              Available for allocation now.
 206  *      inactive
 207  *              Not referenced in any map, but still has an
 208  *              object/offset-page mapping, and may be dirty.
 209  *              This is the list of pages that should be
 210  *              paged out next.
 211  *      active
 212  *              A list of pages which have been placed in
 213  *              at least one physical map.  This list is
 214  *              ordered, in LRU-like fashion.
 215  */
 216
 217 extern
 218 vm_page_t       vm_page_queue_free;     /* memory free queue */
 219 extern
 220 vm_page_t       vm_page_queue_fictitious;       /* fictitious free queue */
 221 extern
 222 queue_head_t    vm_page_queue_active;   /* active memory queue */
 223 extern
 224 queue_head_t    vm_page_queue_inactive; /* inactive memory queue */
 225 queue_head_t    vm_page_queue_zf;       /* inactive memory queue for zero fill */
 226
 227 extern
 228 vm_offset_t     first_phys_addr;        /* physical address for first_page */
 229 extern
 230 vm_offset_t     last_phys_addr;         /* physical address for last_page */
 231
 232 extern
 233 int     vm_page_free_count;     /* How many pages are free? */
 234 extern
 235 int     vm_page_fictitious_count;/* How many fictitious pages are free? */
 236 extern
 237 int     vm_page_active_count;   /* How many pages are active? */
 238 extern
 239 int     vm_page_inactive_count; /* How many pages are inactive? */
 240 extern
 241 int     vm_page_wire_count;     /* How many pages are wired? */
 242 extern
 243 int     vm_page_free_target;    /* How many do we want free? */
 244 extern
 245 int     vm_page_free_min;       /* When to wakeup pageout */
 246 extern
 247 int     vm_page_inactive_target;/* How many do we want inactive? */
 248 extern
 249 int     vm_page_free_reserved;  /* How many pages reserved to do pageout */
 250 extern
 251 int     vm_page_laundry_count;  /* How many pages being laundered? */
 252
 253 decl_mutex_data(,vm_page_queue_lock)
 254                                 /* lock on active and inactive page queues */
 255 decl_mutex_data(,vm_page_queue_free_lock)
 256                                 /* lock on free page queue */
 257 decl_simple_lock_data(extern,vm_page_preppin_lock)      /* lock for prep/pin */
 258 decl_mutex_data(,vm_page_zero_fill_lock)
 259
 260 extern unsigned int     vm_page_free_wanted;
 261                                 /* how many threads are waiting for memory */
 262
 263 extern vm_offset_t      vm_page_fictitious_addr;
 264                                 /* (fake) phys_addr of fictitious pages */
 265
 266 /*
 267  * Prototypes for functions exported by this module.
 268  */
 269 extern void             vm_page_bootstrap(
 270                                         vm_offset_t     *startp,
 271                                         vm_offset_t     *endp);
 272
 273 extern void             vm_page_module_init(void);
 274
 275 extern void             vm_page_create(
 276                                         vm_offset_t     start,
 277                                         vm_offset_t     end);
 278
 279 extern vm_page_t        vm_page_lookup(
 280                                         vm_object_t             object,
 281                                         vm_object_offset_t      offset);
 282
 283 extern vm_page_t        vm_page_grab_fictitious(void);
 284
 285 extern void             vm_page_release_fictitious(
 286                                         vm_page_t page);
 287
 288 extern boolean_t        vm_page_convert(
 289                                         vm_page_t       page);
 290
 291 extern void             vm_page_more_fictitious(void);
 292
 293 extern int              vm_pool_low(void);
 294
 295 extern vm_page_t        vm_page_grab(void);
 296
 297 extern void             vm_page_release(
 298                                         vm_page_t       page);
 299
 300 extern void             vm_page_release_limbo(
 301                                         vm_page_t       page);
 302
 303 extern void             vm_page_limbo_exchange(
 304                                         vm_page_t       limbo_m,
 305                                         vm_page_t       new_m);
 306
 307 extern boolean_t        vm_page_wait(
 308                                         int             interruptible );
 309
 310 extern vm_page_t        vm_page_alloc(
 311                                         vm_object_t             object,
 312                                         vm_object_offset_t      offset);
 313
 314 extern void             vm_page_init(
 315                                         vm_page_t       page,
 316                                         vm_offset_t     phys_addr);
 317
 318 extern void             vm_page_free(
 319                                         vm_page_t       page);
 320
 321 extern void             vm_page_activate(
 322                                         vm_page_t       page);
 323
 324 extern void             vm_page_deactivate(
 325                                         vm_page_t       page);
 326
 327 extern void             vm_page_rename(
 328                                         vm_page_t               page,
 329                                         vm_object_t             new_object,
 330                                         vm_object_offset_t      new_offset);
 331
 332 extern void             vm_page_insert(
 333                                         vm_page_t               page,
 334                                         vm_object_t             object,
 335                                         vm_object_offset_t      offset);
 336
 337 extern void             vm_page_replace(
 338                                         vm_page_t               mem,
 339                                         vm_object_t             object,
 340                                         vm_object_offset_t      offset);
 341
 342 extern void             vm_page_remove(
 343                                         vm_page_t       page);
 344
 345 extern void             vm_page_zero_fill(
 346                                         vm_page_t       page);
 347
 348 extern void             vm_page_part_zero_fill(
 349                                         vm_page_t       m,
 350                                         vm_offset_t     m_pa,
 351                                         vm_size_t       len);
 352
 353 extern void             vm_page_copy(
 354                                         vm_page_t       src_page,
 355                                         vm_page_t       dest_page);
 356
 357 extern void             vm_page_part_copy(
 358                                         vm_page_t       src_m,
 359                                         vm_offset_t     src_pa,
 360                                         vm_page_t       dst_m,
 361                                         vm_offset_t     dst_pa,
 362                                         vm_size_t       len);
 363
 364 extern void             vm_page_wire(
 365                                         vm_page_t       page);
 366
 367 extern void             vm_page_unwire(
 368                                         vm_page_t       page);
 369
 370 extern void             vm_set_page_size(void);
 371
 372 extern void             vm_page_gobble(
 373                                         vm_page_t      page);
 374
 375 /*
 376  *      Functions implemented as macros. m->wanted and m->busy are
 377  *      protected by the object lock.
 378  */
 379
 380 #define PAGE_ASSERT_WAIT(m, interruptible)                      \
 381                 (((m)->wanted = TRUE),                          \
 382                  assert_wait((event_t) (m), (interruptible)))
 383
 384 #define PAGE_SLEEP(o, m, interruptible)                         \
 385                 (((m)->wanted = TRUE),                          \
 386                  thread_sleep_vm_object((o), (m), (interruptible)))
 387
 388 #define PAGE_WAKEUP_DONE(m)                                     \
 389                 MACRO_BEGIN                                     \
 390                 (m)->busy = FALSE;                              \
 391                 if ((m)->wanted) {                              \
 392                         (m)->wanted = FALSE;                    \
 393                         thread_wakeup((event_t) (m));           \
 394                 }                                               \
 395                 MACRO_END
 396
 397 #define PAGE_WAKEUP(m)                                          \
 398                 MACRO_BEGIN                                     \
 399                 if ((m)->wanted) {                              \
 400                         (m)->wanted = FALSE;                    \
 401                         thread_wakeup((event_t) (m));           \
 402                 }                                               \
 403                 MACRO_END
 404
 405 #define VM_PAGE_FREE(p)                         \
 406                 MACRO_BEGIN                     \
 407                 vm_page_lock_queues();          \
 408                 vm_page_free(p);                \
 409                 vm_page_unlock_queues();        \
 410                 MACRO_END
 411
 412 #define VM_PAGE_GRAB_FICTITIOUS(M)                                      \
 413                 MACRO_BEGIN                                             \
 414                 while ((M = vm_page_grab_fictitious()) == VM_PAGE_NULL) \
 415                         vm_page_more_fictitious();                      \
 416                 MACRO_END
 417
 418 #define VM_PAGE_THROTTLED()                                             \
 419                 (vm_page_free_count < (vm_page_free_target -            \
 420                  ((vm_page_free_target-vm_page_free_min)>>2)))
 421
 422 #define VM_PAGE_WAIT()          ((void)vm_page_wait(THREAD_UNINT))
 423
 424 #define vm_page_lock_queues()   mutex_lock(&vm_page_queue_lock)
 425 #define vm_page_unlock_queues() mutex_unlock(&vm_page_queue_lock)
 426 #define vm_page_pin_lock()      simple_lock(&vm_page_preppin_lock)
 427 #define vm_page_pin_unlock()    simple_unlock(&vm_page_preppin_lock)
 428
 429 #define VM_PAGE_QUEUES_REMOVE(mem)                              \
 430         MACRO_BEGIN                                             \
 431         if (mem->active) {                                      \
 432                 assert(!mem->inactive);                         \
 433                 queue_remove(&vm_page_queue_active,             \
 434                         mem, vm_page_t, pageq);                 \
 435                 mem->active = FALSE;                            \
 436                 if (!mem->fictitious)                           \
 437                         vm_page_active_count--;                 \
 438         }                                                       \
 439                                                                 \
 440         if (mem->inactive) {                                    \
 441                 assert(!mem->active);                           \
 442                 if (mem->zero_fill) {                           \
 443                         queue_remove(&vm_page_queue_zf,         \
 444                         mem, vm_page_t, pageq);                 \
 445                 } else {                                        \
 446                         queue_remove(&vm_page_queue_inactive,   \
 447                         mem, vm_page_t, pageq);                 \
 448                 }                                               \
 449                 mem->inactive = FALSE;                          \
 450                 if (!mem->fictitious)                           \
 451                         vm_page_inactive_count--;               \
 452         }                                                       \
 453         MACRO_END
 454
 455 #endif  /* _VM_VM_PAGE_H_ */