1/*
2 * Copyright (c) 2015 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
29#ifndef SYS_DOC_TOMBSTONE_H_
30#define SYS_DOC_TOMBSTONE_H_
31
32#include <sys/types.h>
33#include <stdbool.h>
34
35#ifdef KERNEL_PRIVATE
36
37/*
38 * struct representing a document "tombstone" that's recorded
39 * when a thread manipulates files marked with a document-id.
40 * if the thread recreates the same item, this tombstone is
41 * used to preserve the document_id on the new file.
42 *
43 * It is a separate structure because of its size - we want to
44 * allocate it on demand instead of just stuffing it into the
45 * uthread structure.
46 */
47struct doc_tombstone {
48 struct vnode *t_lastop_parent;
49 struct vnode *t_lastop_item;
50 uint32_t t_lastop_parent_vid;
51 uint32_t t_lastop_item_vid;
52 uint64_t t_lastop_fileid;
53 uint64_t t_lastop_document_id;
54 unsigned char t_lastop_filename[NAME_MAX + 1];
55};
56
57struct componentname;
58
59struct doc_tombstone *doc_tombstone_get(void);
60void doc_tombstone_clear(struct doc_tombstone *ut, struct vnode **old_vpp);
61void doc_tombstone_save(struct vnode *dvp, struct vnode *vp,
62 struct componentname *cnp, uint64_t doc_id,
63 ino64_t file_id);
64bool doc_tombstone_should_ignore_name(const char *nameptr, int len);
65bool doc_tombstone_should_save(struct doc_tombstone *ut, struct vnode *vp,
66 struct componentname *cnp);
67
68#endif // defined(KERNEL_PRIVATE)
69
70#endif // SYS_DOC_TOMBSTONE_H_
71