bsd/sys/fsctl.h

   1 /*
   2  * Copyright (c) 2000 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 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1982, 1986, 1990, 1993, 1994
  31  *      The Regents of the University of California.  All rights reserved.
  32  * (c) UNIX System Laboratories, Inc.
  33  * All or some portions of this file are derived from material licensed
  34  * to the University of California by American Telephone and Telegraph
  35  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  36  * the permission of UNIX System Laboratories, Inc.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      @(#)fsctl.h     8.6 (Berkeley) 3/28/94
  67  */
  68
  69 #ifndef _SYS_FSCTL_H_
  70 #define _SYS_FSCTL_H_
  71
  72 #include <sys/ioccom.h>
  73
  74 #define FSIOC_SYNC_VOLUME       _IOW('A', 1, uint32_t)
  75 #define FSCTL_SYNC_VOLUME       IOCBASECMD(FSIOC_SYNC_VOLUME)
  76
  77 #define FSCTL_SYNC_FULLSYNC     (1<<0)  /* Flush the data fully to disk, if supported by the filesystem */
  78 #define FSCTL_SYNC_WAIT         (1<<1)  /* Wait for the sync to complete */
  79
  80
  81 typedef struct package_ext_info {
  82     const char *strings;
  83     uint32_t    num_entries;
  84     uint32_t    max_width;
  85 } package_ext_info;
  86
  87 #define FSIOC_SET_PACKAGE_EXTS  _IOW('A', 2, struct package_ext_info)
  88 #define FSCTL_SET_PACKAGE_EXTS  IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)
  89
  90 #define FSIOC_WAIT_FOR_SYNC     _IOR('A', 3, int32_t)
  91 #define FSCTL_WAIT_FOR_SYNC     IOCBASECMD(FSIOC_WAIT_FOR_SYNC)
  92
  93
  94 //
  95 // Spotlight and fseventsd use these fsctl()'s to find out
  96 // the mount time of a volume and the last time it was
  97 // unmounted.  Both HFS and ZFS support these calls.
  98 //
  99 // User space code should pass the "_IOC_" macros while the
 100 // kernel should test for the "_FSCTL_" variant of the macro
 101 // in its vnop_ioctl function.
 102 //
 103 // NOTE: the values for these defines should _not_ be changed
 104 //       or else it will break binary compatibility with mds
 105 //       and fseventsd.
 106 //
 107 #define SPOTLIGHT_IOC_GET_MOUNT_TIME _IOR('h', 18, u_int32_t)
 108 #define SPOTLIGHT_FSCTL_GET_MOUNT_TIME IOCBASECMD(SPOTLIGHT_IOC_GET_MOUNT_TIME)
 109 #define SPOTLIGHT_IOC_GET_LAST_MTIME _IOR('h', 19, u_int32_t)
 110 #define SPOTLIGHT_FSCTL_GET_LAST_MTIME IOCBASECMD(SPOTLIGHT_IOC_GET_LAST_MTIME)
 111
 112
 113 #ifdef KERNEL
 114
 115 typedef struct user64_package_ext_info {
 116     user64_addr_t strings;
 117     uint32_t      num_entries;
 118     uint32_t      max_width;
 119 } user64_package_ext_info;
 120
 121 typedef struct user32_package_ext_info {
 122     user32_addr_t strings;
 123     uint32_t      num_entries;
 124     uint32_t      max_width;
 125 } user32_package_ext_info;
 126
 127 #endif  // KERNEL
 128
 129
 130 #ifndef KERNEL
 131
 132 #include <sys/cdefs.h>
 133
 134 __BEGIN_DECLS
 135
 136 int     fsctl(const char *,unsigned long,void*,unsigned int);
 137 int     ffsctl(int,unsigned long,void*,unsigned int);
 138
 139 __END_DECLS
 140
 141 #endif /* !KERNEL */
 142 #endif /* !_SYS_FSCTL_H_ */