VirtualBox

source: vbox/trunk/src/VBox/Additions/linux/sharedfolders/vfsmod.h@ 77529

最後變更 在這個檔案從77529是 77529,由 vboxsync 提交於 6 年 前

linux/vboxsf: Use vbxsf as prefix here - part I. bugref:9172
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 12.4 KB
行 
1/* $Id: vfsmod.h 77529 2019-03-01 14:13:40Z vboxsync $ */
2/** @file
3 * vboxsf - Linux Shared Folders VFS, internal header.
4 */
5
6/*
7 * Copyright (C) 2006-2019 Oracle Corporation
8 *
9 * Permission is hereby granted, free of charge, to any person
10 * obtaining a copy of this software and associated documentation
11 * files (the "Software"), to deal in the Software without
12 * restriction, including without limitation the rights to use,
13 * copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the
15 * Software is furnished to do so, subject to the following
16 * conditions:
17 *
18 * The above copyright notice and this permission notice shall be
19 * included in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
23 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28 * OTHER DEALINGS IN THE SOFTWARE.
29 */
30
31#ifndef GA_INCLUDED_SRC_linux_sharedfolders_vfsmod_h
32#define GA_INCLUDED_SRC_linux_sharedfolders_vfsmod_h
33#ifndef RT_WITHOUT_PRAGMA_ONCE
34# pragma once
35#endif
36
37#if 0 /* Enables strict checks. */
38# define RT_STRICT
39# define VBOX_STRICT
40#endif
41
42#define LOG_GROUP LOG_GROUP_SHARED_FOLDERS
43#include "the-linux-kernel.h"
44#include <iprt/list.h>
45#include <iprt/asm.h>
46#include <VBox/log.h>
47
48#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
49# include <linux/backing-dev.h>
50#endif
51
52#include <VBox/VBoxGuestLibSharedFolders.h>
53#include <VBox/VBoxGuestLibSharedFoldersInline.h>
54#include <iprt/asm.h>
55#include "vbsfmount.h"
56
57
58/*
59 * inode compatibility glue.
60 */
61#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
62
63DECLINLINE(loff_t) i_size_read(struct inode *pInode)
64{
65 AssertCompile(sizeof(loff_t) == sizeof(uint64_t));
66 return ASMAtomicReadU64((uint64_t volatile *)&pInode->i_size);
67}
68
69DECLINLINE(void) i_size_write(struct inode *pInode, loff_t cbNew)
70{
71 AssertCompile(sizeof(pInode->i_size) == sizeof(uint64_t));
72 ASMAtomicWriteU64((uint64_t volatile *)&pInode->i_size, cbNew);
73}
74
75#endif /* < 2.6.0 */
76
77#if LINUX_VERSION_CODE < KERNEL_VERSION(3, 2, 0)
78DECLINLINE(void) set_nlink(struct inode *pInode, unsigned int cLinks)
79{
80 pInode->i_nlink = cLinks;
81}
82#endif
83
84
85#define DIR_BUFFER_SIZE (16*_1K)
86
87/**
88 * VBox specific per-mount (shared folder) information.
89 */
90struct vbsf_super_info {
91 VBGLSFMAP map;
92 struct nls_table *nls;
93 /** time-to-live value for direntry and inode info in jiffies.
94 * Zero == disabled. */
95 unsigned long ttl;
96 /** The mount option value for /proc/mounts. */
97 int ttl_msec;
98 int uid;
99 int gid;
100 int dmode;
101 int fmode;
102 int dmask;
103 int fmask;
104 /** Maximum number of pages to allow in an I/O buffer with the host.
105 * This applies to read and write operations. */
106 uint32_t cMaxIoPages;
107 /** Mount tag for VBoxService automounter. @since 6.0 */
108 char tag[32];
109#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0) && LINUX_VERSION_CODE < KERNEL_VERSION(4, 11, 0)
110 /** The backing device info structure. */
111 struct backing_dev_info bdi;
112#endif
113};
114
115/* Following casts are here to prevent assignment of void * to
116 pointers of arbitrary type */
117#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
118# define VBSF_GET_SUPER_INFO(sb) ((struct vbsf_super_info *)(sb)->u.generic_sbp)
119# define VBSF_SET_SUPER_INFO(sb, sf_g) do { (sb)->u.generic_sbp = sf_g; } while (0)
120#else
121# define VBSF_GET_SUPER_INFO(sb) ((struct vbsf_super_info *)(sb)->s_fs_info)
122# define VBSF_SET_SUPER_INFO(sb, sf_g) do { (sb)->s_fs_info = sf_g;} while (0)
123#endif
124
125
126/**
127 * For associating inodes with host handles.
128 *
129 * This is necessary for address_space_operations::vbsf_writepage and allows
130 * optimizing stat, lookups and other operations on open files and directories.
131 */
132struct sf_handle {
133 /** List entry (head sf_inode_info::HandleList). */
134 RTLISTNODE Entry;
135 /** Host file/whatever handle. */
136 SHFLHANDLE hHost;
137 /** SF_HANDLE_F_XXX */
138 uint32_t fFlags;
139 /** Reference counter.
140 * Close the handle and free the structure when it reaches zero. */
141 uint32_t volatile cRefs;
142#ifdef VBOX_STRICT
143 /** For strictness checks. */
144 struct sf_inode_info *pInodeInfo;
145#endif
146};
147
148/** @name SF_HANDLE_F_XXX - Handle summary flags (sf_handle::fFlags).
149 * @{ */
150#define SF_HANDLE_F_READ UINT32_C(0x00000001)
151#define SF_HANDLE_F_WRITE UINT32_C(0x00000002)
152#define SF_HANDLE_F_APPEND UINT32_C(0x00000004)
153#define SF_HANDLE_F_FILE UINT32_C(0x00000010)
154#define SF_HANDLE_F_ON_LIST UINT32_C(0x00000080)
155#define SF_HANDLE_F_MAGIC_MASK UINT32_C(0xffffff00)
156#define SF_HANDLE_F_MAGIC UINT32_C(0x75030700) /**< Maurice Ravel (1875-03-07). */
157#define SF_HANDLE_F_MAGIC_DEAD UINT32_C(0x19371228)
158/** @} */
159
160/**
161 * VBox specific per-inode information.
162 */
163struct sf_inode_info {
164 /** Which file */
165 SHFLSTRING *path;
166 /** Some information was changed, update data on next revalidate */
167 bool force_restat;
168 /** directory content changed, update the whole directory on next vbsf_getdent */
169 bool force_reread;
170 /** The timestamp (jiffies) where the inode info was last updated. */
171 unsigned long ts_up_to_date;
172 /** The birth time. */
173 RTTIMESPEC BirthTime;
174
175 /** handle valid if a file was created with vbsf_create_worker until it will
176 * be opened with vbsf_reg_open()
177 * @todo r=bird: figure this one out... */
178 SHFLHANDLE handle;
179
180 /** List of open handles (struct sf_handle), protected by g_SfHandleLock. */
181 RTLISTANCHOR HandleList;
182#ifdef VBOX_STRICT
183 uint32_t u32Magic;
184# define SF_INODE_INFO_MAGIC UINT32_C(0x18620822) /**< Claude Debussy */
185# define SF_INODE_INFO_MAGIC_DEAD UINT32_C(0x19180325)
186#endif
187};
188
189#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19) || defined(KERNEL_FC6)
190/* FC6 kernel 2.6.18, vanilla kernel 2.6.19+ */
191# define GET_INODE_INFO(i) ((struct sf_inode_info *) (i)->i_private)
192# define SET_INODE_INFO(i, sf_i) (i)->i_private = sf_i
193#else
194/* vanilla kernel up to 2.6.18 */
195# define GET_INODE_INFO(i) ((struct sf_inode_info *) (i)->u.generic_ip)
196# define SET_INODE_INFO(i, sf_i) (i)->u.generic_ip = sf_i
197#endif
198
199struct sf_dir_info {
200 /** @todo sf_handle. */
201 struct list_head info_list;
202};
203
204struct sf_dir_buf {
205 size_t cEntries;
206 size_t cbFree;
207 size_t cbUsed;
208 void *buf;
209 struct list_head head;
210};
211
212/**
213 * VBox specific information for a regular file.
214 */
215struct sf_reg_info {
216 /** Handle tracking structure. */
217 struct sf_handle Handle;
218};
219
220/**
221 * Sets the update-jiffies value for a dentry.
222 *
223 * This is used together with vbsf_super_info::ttl to reduce re-validation of
224 * dentry structures while walking.
225 *
226 * This used to be living in d_time, but since 4.9.0 that seems to have become
227 * unfashionable and d_fsdata is now used to for this purpose. We do this all
228 * the way back, since d_time seems only to have been used by the file system
229 * specific code (at least going back to 2.4.0).
230 */
231DECLINLINE(void) vbsf_dentry_set_update_jiffies(struct dentry *pDirEntry, unsigned long uToSet)
232{
233 pDirEntry->d_fsdata = (void *)uToSet;
234}
235
236/**
237 * Get the update-jiffies value for a dentry.
238 */
239DECLINLINE(unsigned long) vbsf_dentry_get_update_jiffies(struct dentry *pDirEntry)
240{
241 return (unsigned long)pDirEntry->d_fsdata;
242}
243
244/**
245 * Increase the time-to-live of @a pDirEntry and all ancestors.
246 * @param pDirEntry The directory entry cache entry which ancestors
247 * we should increase the TTL for.
248 */
249DECLINLINE(void) vbsf_dentry_chain_increase_ttl(struct dentry *pDirEntry)
250{
251#ifdef VBOX_STRICT
252 struct super_block * const pSuper = pDirEntry->d_sb;
253#endif
254 unsigned long const uToSet = jiffies;
255 do {
256 Assert(pDirEntry->d_sb == pSuper);
257 vbsf_dentry_set_update_jiffies(pDirEntry, uToSet);
258 pDirEntry = pDirEntry->d_parent;
259 } while (!IS_ROOT(pDirEntry));
260}
261
262/**
263 * Increase the time-to-live of all ancestors.
264 * @param pDirEntry The directory entry cache entry which ancestors
265 * we should increase the TTL for.
266 */
267DECLINLINE(void) vbsf_dentry_chain_increase_parent_ttl(struct dentry *pDirEntry)
268{
269 Assert(!pDirEntry->d_parent || pDirEntry->d_parent->d_sb == pDirEntry->d_sb);
270 pDirEntry = pDirEntry->d_parent;
271 if (pDirEntry)
272 vbsf_dentry_chain_increase_ttl(pDirEntry);
273}
274
275
276/* globals */
277extern VBGLSFCLIENT g_SfClient;
278extern spinlock_t g_SfHandleLock;
279
280
281/* forward declarations */
282extern struct inode_operations vbsf_dir_iops;
283extern struct inode_operations vbsf_lnk_iops;
284extern struct inode_operations vbsf_reg_iops;
285extern struct file_operations vbsf_dir_fops;
286extern struct file_operations vbsf_reg_fops;
287extern struct dentry_operations vbsf_dentry_ops;
288extern struct address_space_operations vbsf_reg_aops;
289
290extern void vbsf_handle_drop_chain(struct sf_inode_info *pInodeInfo);
291extern struct sf_handle *vbsf_handle_find(struct sf_inode_info *pInodeInfo, uint32_t fFlagsSet, uint32_t fFlagsClear);
292extern uint32_t vbsf_handle_release_slow(struct sf_handle *pHandle, struct vbsf_super_info *sf_g, const char *pszCaller);
293extern void vbsf_handle_append(struct sf_inode_info *pInodeInfo, struct sf_handle *pHandle);
294
295/**
296 * Releases a handle.
297 *
298 * @returns New reference count.
299 * @param pHandle The handle to release.
300 * @param sf_g The info structure for the shared folder associated
301 * with the handle.
302 * @param pszCaller The caller name (for logging failures).
303 */
304DECLINLINE(uint32_t) vbsf_handle_release(struct sf_handle *pHandle, struct vbsf_super_info *sf_g, const char *pszCaller)
305{
306 uint32_t cRefs;
307
308 Assert((pHandle->fFlags & SF_HANDLE_F_MAGIC_MASK) == SF_HANDLE_F_MAGIC);
309 Assert(pHandle->pInodeInfo);
310 Assert(pHandle->pInodeInfo && pHandle->pInodeInfo->u32Magic == SF_INODE_INFO_MAGIC);
311
312 cRefs = ASMAtomicDecU32(&pHandle->cRefs);
313 Assert(cRefs < _64M);
314 if (cRefs)
315 return cRefs;
316 return vbsf_handle_release_slow(pHandle, sf_g, pszCaller);
317}
318
319extern void vbsf_init_inode(struct inode *inode, struct sf_inode_info *sf_i, PSHFLFSOBJINFO info, struct vbsf_super_info *sf_g);
320extern int vbsf_stat(const char *caller, struct vbsf_super_info *sf_g, SHFLSTRING * path, PSHFLFSOBJINFO result, int ok_to_fail);
321extern int vbsf_inode_revalidate(struct dentry *dentry);
322extern int vbsf_inode_revalidate_worker(struct dentry *dentry, bool fForced);
323extern int vbsf_inode_revalidate_with_handle(struct dentry *dentry, SHFLHANDLE hHostFile, bool fForced, bool fInodeLocked);
324#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
325# if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0)
326extern int vbsf_inode_getattr(const struct path *path, struct kstat *kstat, u32 request_mask, unsigned int query_flags);
327# else
328extern int vbsf_inode_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *kstat);
329# endif
330extern int vbsf_inode_setattr(struct dentry *dentry, struct iattr *iattr);
331#endif
332extern int vbsf_path_from_dentry(const char *caller, struct vbsf_super_info *sf_g, struct sf_inode_info *sf_i,
333 struct dentry *dentry, SHFLSTRING ** result);
334extern int vbsf_nlscpy(struct vbsf_super_info *sf_g, char *name, size_t name_bound_len,
335 const unsigned char *utf8_name, size_t utf8_len);
336extern void vbsf_dir_info_free(struct sf_dir_info *p);
337extern void vbsf_dir_info_empty(struct sf_dir_info *p);
338extern struct sf_dir_info *vbsf_dir_info_alloc(void);
339extern int vbsf_dir_read_all(struct vbsf_super_info *sf_g, struct sf_inode_info *sf_i,
340 struct sf_dir_info *sf_d, SHFLHANDLE handle);
341
342#if 1
343# define TRACE() LogFunc(("tracepoint\n"))
344# define SFLOGFLOW(aArgs) Log(aArgs)
345# ifdef LOG_ENABLED
346# define SFLOG_ENABLED 1
347# endif
348#else
349# define TRACE() RTLogBackdoorPrintf("%s: tracepoint\n", __FUNCTION__)
350# define SFLOGFLOW(aArgs) RTLogBackdoorPrintf aArgs
351# define SFLOG_ENABLED 1
352#endif
353
354#if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 19, 0)
355# define GET_F_DENTRY(f) (f->f_path.dentry)
356#else
357# define GET_F_DENTRY(f) (f->f_dentry)
358#endif
359
360#endif /* !GA_INCLUDED_SRC_linux_sharedfolders_vfsmod_h */
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette