usr/src/sys/vm/vm_pager.h

/*
 * Copyright (c) 1990 University of Utah.
 * Copyright (c) 1991, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * the Systems Programming Group of the University of Utah Computer
 * Science Department.
 *
 * %sccs.include.redist.c%
 *
 *      @(#)vm_pager.h  8.1 (Berkeley) %G%
 */

/*
 * Pager routine interface definition.
 * For BSD we use a cleaner version of the internal pager interface.
 */

#ifndef _VM_PAGER_
#define _VM_PAGER_

struct  pager_struct {
        queue_head_t    pg_list;        /* links for list management */
        caddr_t         pg_handle;      /* external handle (vp, dev, fp) */
        int             pg_type;        /* type of pager */
        struct pagerops *pg_ops;        /* pager operations */
        caddr_t         pg_data;        /* private pager data */
};

/* pager types */
#define PG_DFLT         -1
#define PG_SWAP         0
#define PG_VNODE        1
#define PG_DEVICE       2

struct  pagerops {
        void            (*pgo_init)             /* Initialize pager. */
                            __P((void));
        vm_pager_t      (*pgo_alloc)            /* Allocate pager. */
                            __P((caddr_t, vm_size_t, vm_prot_t));
        void            (*pgo_dealloc)          /* Disassociate. */
                            __P((vm_pager_t));
        int             (*pgo_getpage)          /* Get (read) page. */
                            __P((vm_pager_t, vm_page_t, boolean_t));
        int             (*pgo_putpage)          /* Put (write) page. */
                            __P((vm_pager_t, vm_page_t, boolean_t));
        boolean_t       (*pgo_haspage)          /* Does pager have page? */
                            __P((vm_pager_t, vm_offset_t));
};

/*
 * get/put return values
 * OK    operation was successful
 * BAD   specified data was out of the accepted range
 * FAIL  specified data was in range, but doesn't exist
 * PEND  operations was initiated but not completed
 * ERROR error while accessing data that is in range and exists
 */
#define VM_PAGER_OK     0
#define VM_PAGER_BAD    1
#define VM_PAGER_FAIL   2
#define VM_PAGER_PEND   3
#define VM_PAGER_ERROR  4

#define VM_PAGER_ALLOC(h, s, p)         (*(pg)->pg_ops->pgo_alloc)(h, s, p)
#define VM_PAGER_DEALLOC(pg)            (*(pg)->pg_ops->pgo_dealloc)(pg)
#define VM_PAGER_GET(pg, m, s)          (*(pg)->pg_ops->pgo_getpage)(pg, m, s)
#define VM_PAGER_PUT(pg, m, s)          (*(pg)->pg_ops->pgo_putpage)(pg, m, s)
#define VM_PAGER_HASPAGE(pg, o)         (*(pg)->pg_ops->pgo_haspage)(pg, o)

#ifdef KERNEL
extern struct pagerops *dfltpagerops;

vm_pager_t       vm_pager_allocate __P((int, caddr_t, vm_size_t, vm_prot_t));
void             vm_pager_deallocate __P((vm_pager_t));
int              vm_pager_get __P((vm_pager_t, vm_page_t, boolean_t));
boolean_t        vm_pager_has_page __P((vm_pager_t, vm_offset_t));
void             vm_pager_init __P((void));
vm_pager_t       vm_pager_lookup __P((queue_head_t *, caddr_t));
vm_offset_t      vm_pager_map_page __P((vm_page_t));
int              vm_pager_put __P((vm_pager_t, vm_page_t, boolean_t));
void             vm_pager_sync __P((void));
void             vm_pager_unmap_page __P((vm_offset_t));
#endif

#endif  /* _VM_PAGER_ */