bsd/sys/fsevents.h

   1 /*
   2  * Copyright (c) 2000-2014 Apple 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 #ifndef FSEVENT_H
  29 #define FSEVENT_H 1
  30
  31 // Event types that you can ask to listen for
  32 #define FSE_INVALID             -1
  33 #define FSE_CREATE_FILE          0
  34 #define FSE_DELETE               1
  35 #define FSE_STAT_CHANGED         2
  36 #define FSE_RENAME               3
  37 #define FSE_CONTENT_MODIFIED     4
  38 #define FSE_EXCHANGE             5
  39 #define FSE_FINDER_INFO_CHANGED  6
  40 #define FSE_CREATE_DIR           7
  41 #define FSE_CHOWN                8
  42 #define FSE_XATTR_MODIFIED       9
  43 #define FSE_XATTR_REMOVED       10
  44 #define FSE_DOCID_CREATED       11
  45 #define FSE_DOCID_CHANGED       12
  46 #define FSE_UNMOUNT_PENDING     13 // iOS-only: client must respond via FSEVENTS_UNMOUNT_PENDING_ACK
  47 #define FSE_CLONE               14
  48
  49 #define FSE_MAX_EVENTS          15
  50 #define FSE_ALL_EVENTS         998
  51
  52 #define FSE_EVENTS_DROPPED     999
  53
  54 //
  55 // These defines only apply if you've asked for extended
  56 // type info.  In that case the type field's low 12-bits
  57 // contain the basic types defined above and the top 4
  58 // bits contain flags that indicate if an event had other
  59 // events combined with it or if it represents a directory
  60 // that has dropped events below it.
  61 //
  62 #define FSE_TYPE_MASK          0x0fff
  63 #define FSE_FLAG_MASK          0xf000
  64 #define FSE_FLAG_SHIFT         12
  65 #define FSE_GET_FLAGS(type)    (((type) >> 12) & 0x000f)
  66
  67 #define FSE_COMBINED_EVENTS          0x0001
  68 #define FSE_CONTAINS_DROPPED_EVENTS  0x0002
  69
  70
  71 // Actions for each event type
  72 #define FSE_IGNORE    0
  73 #define FSE_REPORT    1
  74 #define FSE_ASK       2    // Not implemented yet
  75
  76 // The types of each of the arguments for an event
  77 // Each type is followed by the size and then the
  78 // data.  FSE_ARG_VNODE is just a path string
  79 #define FSE_ARG_VNODE    0x0001   // next arg is a vnode pointer
  80 #define FSE_ARG_STRING   0x0002   // next arg is length followed by string ptr
  81 #define FSE_ARG_PATH     0x0003   // next arg is a full path
  82 #define FSE_ARG_INT32    0x0004   // next arg is a 32-bit int
  83 #define FSE_ARG_INT64    0x0005   // next arg is a 64-bit int
  84 #define FSE_ARG_RAW      0x0006   // next arg is a length followed by a void ptr
  85 #define FSE_ARG_INO      0x0007   // next arg is the inode number (ino_t)
  86 #define FSE_ARG_UID      0x0008   // next arg is the file's uid (uid_t)
  87 #define FSE_ARG_DEV      0x0009   // next arg is the file's dev_t
  88 #define FSE_ARG_MODE     0x000a   // next arg is the file's mode (as an int32, file type only)
  89 #define FSE_ARG_GID      0x000b   // next arg is the file's gid (gid_t)
  90 #define FSE_ARG_FINFO    0x000c   // next arg is a packed finfo (dev, ino, mode, uid, gid)
  91 #define FSE_ARG_DONE     0xb33f   // no more arguments
  92
  93 #define FSE_MAX_ARGS     12
  94
  95 //
  96 // These are special bits that be set in the 32-bit mode
  97 // field that /dev/fsevents provides.
  98 //
  99 #define FSE_MODE_HLINK         (1 << 31)    // notification is for a hard-link
 100 #define FSE_MODE_LAST_HLINK    (1 << 30)    // link count == 0 on a hard-link delete
 101 #define FSE_REMOTE_DIR_EVENT   (1 << 29)    // this is a remotely generated directory-level granularity event
 102 #define FSE_TRUNCATED_PATH     (1 << 28)    // the path for this item had to be truncated
 103 #define FSE_MODE_CLONE         (1 << 27)    // notification is for a clone
 104
 105 // ioctl's on /dev/fsevents
 106 typedef struct fsevent_clone_args {
 107     int8_t  *event_list;
 108     int32_t  num_events;
 109     int32_t  event_queue_depth;
 110     int32_t *fd;
 111 } fsevent_clone_args;
 112
 113 #define FSEVENTS_CLONE          _IOW('s', 1, fsevent_clone_args)
 114
 115
 116 // ioctl's on the cloned fd
 117 #pragma pack(push, 4)
 118 typedef struct fsevent_dev_filter_args {
 119     uint32_t  num_devices;
 120     dev_t    *devices;
 121 } fsevent_dev_filter_args;
 122 #pragma pack(pop)
 123
 124 #define FSEVENTS_DEVICE_FILTER          _IOW('s', 100, fsevent_dev_filter_args)
 125 #define FSEVENTS_WANT_COMPACT_EVENTS    _IO('s', 101)
 126 #define FSEVENTS_WANT_EXTENDED_INFO     _IO('s', 102)
 127 #define FSEVENTS_GET_CURRENT_ID         _IOR('s', 103, uint64_t)
 128 #define FSEVENTS_UNMOUNT_PENDING_ACK    _IOW('s', 104, dev_t)
 129
 130
 131 #ifdef BSD_KERNEL_PRIVATE
 132
 133 void fsevents_init(void);
 134 void fsevent_unmount(struct mount *mp, vfs_context_t ctx);
 135 struct vnode_attr;
 136 void create_fsevent_from_kevent(vnode_t vp, uint32_t kevents, struct vnode_attr *vap);
 137
 138 // misc utility functions for fsevent info and pathbuffers...
 139 typedef struct fse_info {
 140     ino64_t    ino;
 141     dev_t      dev;
 142     int32_t    mode;   // note: this is not a mode_t (it's 32-bits, not 16)
 143     uid_t      uid;
 144     gid_t      gid;
 145     uint64_t   nlink;  // only filled in if the vnode is marked as a hardlink
 146 } fse_info;
 147
 148 int   get_fse_info(struct vnode *vp, fse_info *fse, vfs_context_t ctx);
 149 int   vnode_get_fse_info_from_vap(vnode_t vp, fse_info *fse, struct vnode_attr *vap);
 150
 151 char *get_pathbuff(void);
 152 void  release_pathbuff(char *path);
 153
 154 #endif /* BSD_KERNEL_PRIVATE */
 155
 156 #ifdef KERNEL_PRIVATE
 157
 158 int  need_fsevent(int type, vnode_t vp);
 159 int  add_fsevent(int type, vfs_context_t, ...);
 160
 161 #endif /* KERNEL_PRIVATE */
 162
 163 #endif /* FSEVENT_H */