bsd/sys/ubc.h

   1 /*
   2  * Copyright (c) 1999-2004 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  *      Header file for Unified Buffer Cache.
  24  *
  25  */
  26
  27 #ifndef _SYS_UBC_H_
  28 #define _SYS_UBC_H_
  29
  30 #include <sys/appleapiopts.h>
  31 #include <sys/cdefs.h>
  32 #include <sys/kernel_types.h>
  33 #include <kern/locks.h>
  34 #include <mach/memory_object_types.h>
  35
  36
  37 /* defns for ubc_sync_range() and ubc_msync */
  38
  39 #define UBC_PUSHDIRTY   0x01    /* clean any dirty pages in the specified range to the backing store */
  40 #define UBC_PUSHALL     0x02    /* push both dirty and precious pages to the backing store */
  41 #define UBC_INVALIDATE  0x04    /* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
  42 #define UBC_SYNC        0x08    /* wait for I/Os generated by UBC_PUSHDIRTY to complete */
  43
  44 __BEGIN_DECLS
  45
  46 off_t           ubc_blktooff(struct vnode *, daddr64_t);
  47 daddr64_t       ubc_offtoblk(struct vnode *, off_t);
  48 off_t   ubc_getsize(struct vnode *);
  49 int     ubc_setsize(struct vnode *, off_t);
  50
  51 struct ucred *ubc_getcred(struct vnode *);
  52 int     ubc_setcred(struct vnode *, struct proc *);
  53
  54 int     ubc_sync_range(vnode_t, off_t, off_t, int);
  55 errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
  56 int     ubc_pages_resident(vnode_t);
  57
  58
  59 /* cluster IO routines */
  60 int     advisory_read(vnode_t, off_t, off_t, int);
  61
  62 int     cluster_read(vnode_t, struct uio *, off_t, int);
  63 int     cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
  64 int     cluster_pageout(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
  65 int     cluster_pagein(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
  66 int     cluster_push(vnode_t, int);
  67 int cluster_bp(buf_t);
  68 void cluster_zero(upl_t, vm_offset_t, int, buf_t);
  69
  70
  71 /* UPL routines */
  72 int     ubc_create_upl(vnode_t, off_t, long, upl_t *, upl_page_info_t **, int);
  73 int     ubc_upl_map(upl_t, upl_offset_t *);
  74 int     ubc_upl_unmap(upl_t);
  75 int     ubc_upl_commit(upl_t);
  76 int     ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
  77 int     ubc_upl_abort(upl_t, int);
  78 int     ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
  79
  80 upl_page_info_t *ubc_upl_pageinfo(upl_t);
  81
  82 __END_DECLS
  83
  84 #endif  /* _SYS_UBC_H_ */
  85