VirtualBox

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

Last change on this file since 77524 was 77524, checked in by vboxsync, 6 years ago

linux/vboxsf: Code cleanups in the super block info area. bugref:9172
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.1 KB
Line 
1/* $Id: vfsmod.h 77524 2019-03-01 11:58:24Z 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::sf_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 sf_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 sf_create_aux until it will
176 * be opened with sf_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
189struct sf_dir_info {
190 /** @todo sf_handle. */
191 struct list_head info_list;
192};
193
194struct sf_dir_buf {
195 size_t cEntries;
196 size_t cbFree;
197 size_t cbUsed;
198 void *buf;
199 struct list_head head;
200};
201
202/**
203 * VBox specific information for a regular file.
204 */
205struct sf_reg_info {
206 /** Handle tracking structure. */
207 struct sf_handle Handle;
208};
209
210/**
211 * Sets the update-jiffies value for a dentry.
212 *
213 * This is used together with vbsf_super_info::ttl to reduce re-validation of
214 * dentry structures while walking.
215 *
216 * This used to be living in d_time, but since 4.9.0 that seems to have become
217 * unfashionable and d_fsdata is now used to for this purpose. We do this all
218 * the way back, since d_time seems only to have been used by the file system
219 * specific code (at least going back to 2.4.0).
220 */
221DECLINLINE(void) sf_dentry_set_update_jiffies(struct dentry *pDirEntry, unsigned long uToSet)
222{
223 pDirEntry->d_fsdata = (void *)uToSet;
224}
225
226/**
227 * Get the update-jiffies value for a dentry.
228 */
229DECLINLINE(unsigned long) sf_dentry_get_update_jiffies(struct dentry *pDirEntry)
230{
231 return (unsigned long)pDirEntry->d_fsdata;
232}
233
234/**
235 * Increase the time-to-live of @a pDirEntry and all ancestors.
236 * @param pDirEntry The directory entry cache entry which ancestors
237 * we should increase the TTL for.
238 */
239DECLINLINE(void) sf_dentry_chain_increase_ttl(struct dentry *pDirEntry)
240{
241#ifdef VBOX_STRICT
242 struct super_block * const pSuper = pDirEntry->d_sb;
243#endif
244 unsigned long const uToSet = jiffies;
245 do {
246 Assert(pDirEntry->d_sb == pSuper);
247 sf_dentry_set_update_jiffies(pDirEntry, uToSet);
248 pDirEntry = pDirEntry->d_parent;
249 } while (!IS_ROOT(pDirEntry));
250}
251
252/**
253 * Increase the time-to-live of all ancestors.
254 * @param pDirEntry The directory entry cache entry which ancestors
255 * we should increase the TTL for.
256 */
257DECLINLINE(void) sf_dentry_chain_increase_parent_ttl(struct dentry *pDirEntry)
258{
259 Assert(!pDirEntry->d_parent || pDirEntry->d_parent->d_sb == pDirEntry->d_sb);
260 pDirEntry = pDirEntry->d_parent;
261 if (pDirEntry)
262 sf_dentry_chain_increase_ttl(pDirEntry);
263}
264
265
266/* globals */
267extern VBGLSFCLIENT client_handle;
268extern spinlock_t g_SfHandleLock;
269
270
271/* forward declarations */
272extern struct inode_operations sf_dir_iops;
273extern struct inode_operations sf_lnk_iops;
274extern struct inode_operations sf_reg_iops;
275extern struct file_operations sf_dir_fops;
276extern struct file_operations sf_reg_fops;
277extern struct dentry_operations sf_dentry_ops;
278extern struct address_space_operations sf_reg_aops;
279
280extern void sf_handle_drop_chain(struct sf_inode_info *pInodeInfo);
281extern struct sf_handle *sf_handle_find(struct sf_inode_info *pInodeInfo, uint32_t fFlagsSet, uint32_t fFlagsClear);
282extern uint32_t sf_handle_release_slow(struct sf_handle *pHandle, struct vbsf_super_info *sf_g, const char *pszCaller);
283extern void sf_handle_append(struct sf_inode_info *pInodeInfo, struct sf_handle *pHandle);
284
285/**
286 * Releases a handle.
287 *
288 * @returns New reference count.
289 * @param pHandle The handle to release.
290 * @param sf_g The info structure for the shared folder associated
291 * with the handle.
292 * @param pszCaller The caller name (for logging failures).
293 */
294DECLINLINE(uint32_t) sf_handle_release(struct sf_handle *pHandle, struct vbsf_super_info *sf_g, const char *pszCaller)
295{
296 uint32_t cRefs;
297
298 Assert((pHandle->fFlags & SF_HANDLE_F_MAGIC_MASK) == SF_HANDLE_F_MAGIC);
299 Assert(pHandle->pInodeInfo);
300 Assert(pHandle->pInodeInfo && pHandle->pInodeInfo->u32Magic == SF_INODE_INFO_MAGIC);
301
302 cRefs = ASMAtomicDecU32(&pHandle->cRefs);
303 Assert(cRefs < _64M);
304 if (cRefs)
305 return cRefs;
306 return sf_handle_release_slow(pHandle, sf_g, pszCaller);
307}
308
309extern void sf_init_inode(struct inode *inode, struct sf_inode_info *sf_i, PSHFLFSOBJINFO info, struct vbsf_super_info *sf_g);
310extern int sf_stat(const char *caller, struct vbsf_super_info *sf_g,
311 SHFLSTRING * path, PSHFLFSOBJINFO result, int ok_to_fail);
312extern int sf_inode_revalidate(struct dentry *dentry);
313extern int sf_inode_revalidate_worker(struct dentry *dentry, bool fForced);
314extern int sf_inode_revalidate_with_handle(struct dentry *dentry, SHFLHANDLE hHostFile, bool fForced, bool fInodeLocked);
315#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
316# if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0)
317extern int sf_getattr(const struct path *path, struct kstat *kstat,
318 u32 request_mask, unsigned int query_flags);
319# else
320extern int sf_getattr(struct vfsmount *mnt, struct dentry *dentry,
321 struct kstat *kstat);
322# endif
323extern int sf_setattr(struct dentry *dentry, struct iattr *iattr);
324#endif
325extern int sf_path_from_dentry(const char *caller, struct vbsf_super_info *sf_g,
326 struct sf_inode_info *sf_i,
327 struct dentry *dentry, SHFLSTRING ** result);
328extern int sf_nlscpy(struct vbsf_super_info *sf_g, char *name,
329 size_t name_bound_len, const unsigned char *utf8_name,
330 size_t utf8_len);
331extern void sf_dir_info_free(struct sf_dir_info *p);
332extern void sf_dir_info_empty(struct sf_dir_info *p);
333extern struct sf_dir_info *sf_dir_info_alloc(void);
334extern int sf_dir_read_all(struct vbsf_super_info *sf_g,
335 struct sf_inode_info *sf_i, struct sf_dir_info *sf_d,
336 SHFLHANDLE handle);
337
338#ifdef __cplusplus
339# define CMC_API __attribute__ ((cdecl, regparm (0)))
340#else
341# define CMC_API __attribute__ ((regparm (0)))
342#endif
343
344#if 1
345# define TRACE() LogFunc(("tracepoint\n"))
346# define SFLOGFLOW(aArgs) Log(aArgs)
347# ifdef LOG_ENABLED
348# define SFLOG_ENABLED 1
349# endif
350#else
351# define TRACE() RTLogBackdoorPrintf("%s: tracepoint\n", __FUNCTION__)
352# define SFLOGFLOW(aArgs) RTLogBackdoorPrintf aArgs
353# define SFLOG_ENABLED 1
354#endif
355
356#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 19) || defined(KERNEL_FC6)
357/* FC6 kernel 2.6.18, vanilla kernel 2.6.19+ */
358# define GET_INODE_INFO(i) ((struct sf_inode_info *) (i)->i_private)
359# define SET_INODE_INFO(i, sf_i) (i)->i_private = sf_i
360#else
361/* vanilla kernel up to 2.6.18 */
362# define GET_INODE_INFO(i) ((struct sf_inode_info *) (i)->u.generic_ip)
363# define SET_INODE_INFO(i, sf_i) (i)->u.generic_ip = sf_i
364#endif
365
366#if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 19, 0)
367# define GET_F_DENTRY(f) (f->f_path.dentry)
368#else
369# define GET_F_DENTRY(f) (f->f_dentry)
370#endif
371
372#endif /* !GA_INCLUDED_SRC_linux_sharedfolders_vfsmod_h */
Note: See TracBrowser for help on using the repository browser.

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