1*27b03b36SApple OSS Distributions /* 2*27b03b36SApple OSS Distributions * Copyright (c) 2015 Apple Inc. All rights reserved. 3*27b03b36SApple OSS Distributions * 4*27b03b36SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*27b03b36SApple OSS Distributions * 6*27b03b36SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*27b03b36SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*27b03b36SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*27b03b36SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*27b03b36SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*27b03b36SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*27b03b36SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*27b03b36SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*27b03b36SApple OSS Distributions * 15*27b03b36SApple OSS Distributions * Please obtain a copy of the License at 16*27b03b36SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*27b03b36SApple OSS Distributions * 18*27b03b36SApple OSS Distributions * The Original Code and all software distributed under the License are 19*27b03b36SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*27b03b36SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*27b03b36SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*27b03b36SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*27b03b36SApple OSS Distributions * Please see the License for the specific language governing rights and 24*27b03b36SApple OSS Distributions * limitations under the License. 25*27b03b36SApple OSS Distributions * 26*27b03b36SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*27b03b36SApple OSS Distributions */ 28*27b03b36SApple OSS Distributions 29*27b03b36SApple OSS Distributions #ifndef SYS_DOC_TOMBSTONE_H_ 30*27b03b36SApple OSS Distributions #define SYS_DOC_TOMBSTONE_H_ 31*27b03b36SApple OSS Distributions 32*27b03b36SApple OSS Distributions #include <sys/types.h> 33*27b03b36SApple OSS Distributions #include <stdbool.h> 34*27b03b36SApple OSS Distributions 35*27b03b36SApple OSS Distributions #ifdef KERNEL_PRIVATE 36*27b03b36SApple OSS Distributions 37*27b03b36SApple OSS Distributions /* 38*27b03b36SApple OSS Distributions * struct representing a document "tombstone" that's recorded 39*27b03b36SApple OSS Distributions * when a thread manipulates files marked with a document-id. 40*27b03b36SApple OSS Distributions * if the thread recreates the same item, this tombstone is 41*27b03b36SApple OSS Distributions * used to preserve the document_id on the new file. 42*27b03b36SApple OSS Distributions * 43*27b03b36SApple OSS Distributions * It is a separate structure because of its size - we want to 44*27b03b36SApple OSS Distributions * allocate it on demand instead of just stuffing it into the 45*27b03b36SApple OSS Distributions * uthread structure. 46*27b03b36SApple OSS Distributions */ 47*27b03b36SApple OSS Distributions struct doc_tombstone { 48*27b03b36SApple OSS Distributions struct vnode *t_lastop_parent; 49*27b03b36SApple OSS Distributions struct vnode *t_lastop_item; 50*27b03b36SApple OSS Distributions uint32_t t_lastop_parent_vid; 51*27b03b36SApple OSS Distributions uint32_t t_lastop_item_vid; 52*27b03b36SApple OSS Distributions uint64_t t_lastop_fileid; 53*27b03b36SApple OSS Distributions uint64_t t_lastop_document_id; 54*27b03b36SApple OSS Distributions unsigned char t_lastop_filename[NAME_MAX + 1]; 55*27b03b36SApple OSS Distributions }; 56*27b03b36SApple OSS Distributions 57*27b03b36SApple OSS Distributions struct componentname; 58*27b03b36SApple OSS Distributions 59*27b03b36SApple OSS Distributions struct doc_tombstone *doc_tombstone_get(void); 60*27b03b36SApple OSS Distributions void doc_tombstone_clear(struct doc_tombstone *ut, struct vnode **old_vpp); 61*27b03b36SApple OSS Distributions void doc_tombstone_save(struct vnode *dvp, struct vnode *vp, 62*27b03b36SApple OSS Distributions struct componentname *cnp, uint64_t doc_id, 63*27b03b36SApple OSS Distributions ino64_t file_id); 64*27b03b36SApple OSS Distributions bool doc_tombstone_should_ignore_name(const char *nameptr, int len); 65*27b03b36SApple OSS Distributions bool doc_tombstone_should_save(struct doc_tombstone *ut, struct vnode *vp, 66*27b03b36SApple OSS Distributions struct componentname *cnp); 67*27b03b36SApple OSS Distributions 68*27b03b36SApple OSS Distributions #endif // defined(KERNEL_PRIVATE) 69*27b03b36SApple OSS Distributions 70*27b03b36SApple OSS Distributions #endif // SYS_DOC_TOMBSTONE_H_ 71