VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR0LibSharedFolders.h@ 38736

Last change on this file since 38736 was 38736, checked in by vboxsync, 13 years ago

*: Please don NOT redefine logger macros.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.4 KB
Line 
1/** @file
2 * VBoxGuestLib - Central calls header.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBoxGuestLib_VBoxGuestR0LibSharedFolders_h
27#define ___VBoxGuestLib_VBoxGuestR0LibSharedFolders_h
28
29#include <VBox/VBoxGuestLib.h>
30#ifndef _NTIFS_
31# ifdef RT_OS_WINDOWS
32# if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
33# include <iprt/asm.h>
34# define _InterlockedExchange _InterlockedExchange_StupidDDKvsCompilerCrap
35# define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKvsCompilerCrap
36# define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKvsCompilerCrap
37# define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKvsCompilerCrap
38# pragma warning(disable : 4163)
39 RT_C_DECLS_BEGIN
40# include <ntddk.h>
41 RT_C_DECLS_END
42# pragma warning(default : 4163)
43# undef _InterlockedExchange
44# undef _InterlockedExchangeAdd
45# undef _InterlockedCompareExchange
46# undef _InterlockedAddLargeStatistic
47# else
48 RT_C_DECLS_BEGIN
49# include <ntddk.h>
50 RT_C_DECLS_END
51# endif
52# endif
53#endif
54
55#if defined(RT_OS_WINDOWS)
56/** @todo remove this legacy and use VBox/log.h and/or iprt/log.h. */
57# ifdef DEBUG
58# define LOG_ENABLED
59# endif
60# include "VBoxGuestLog.h"
61#endif
62
63#include <iprt/assert.h>
64#define ASSERTVBSF AssertRelease
65
66#include <VBox/shflsvc.h>
67
68typedef struct _VBSFCLIENT
69{
70 uint32_t ulClientID;
71 VBGLHGCMHANDLE handle;
72} VBSFCLIENT;
73typedef VBSFCLIENT *PVBSFCLIENT;
74
75typedef struct _VBSFMAP
76{
77 SHFLROOT root;
78} VBSFMAP, *PVBSFMAP;
79
80
81#define VBSF_DRIVE_LETTER_FIRST L'A'
82#define VBSF_DRIVE_LETTER_LAST L'Z'
83
84#define VBSF_MAX_DRIVES (VBSF_DRIVE_LETTER_LAST - VBSF_DRIVE_LETTER_FIRST)
85
86/* Poller thread flags. */
87#define VBSF_TF_NONE (0x0000)
88#define VBSF_TF_STARTED (0x0001)
89#define VBSF_TF_TERMINATE (0x0002)
90#define VBSF_TF_START_PROCESSING (0x0004)
91
92#define DRIVE_FLAG_WORKING (0x1)
93#define DRIVE_FLAG_LOCKED (0x2)
94#define DRIVE_FLAG_WRITE_PROTECTED (0x4)
95
96#ifdef RT_OS_WINDOWS
97/** Device extension structure for each drive letter we created. */
98typedef struct _VBSFDRIVE
99{
100 /* A pointer to the Driver object we created for the drive. */
101 PDEVICE_OBJECT pDeviceObject;
102
103 /** Root handle to access the drive. */
104 SHFLROOT root;
105
106 /** Informational string - the resource name on host. */
107 WCHAR awcNameHost[256];
108
109 /** Guest drive letter. */
110 WCHAR wcDriveLetter;
111
112 /** DRIVE_FLAG_* */
113 uint32_t u32DriveFlags;
114
115 /** Head of FCB list. */
116 LIST_ENTRY FCBHead;
117
118 /* Synchronise requests directed to the drive. */
119 ERESOURCE DriveResource;
120} VBSFDRIVE;
121typedef VBSFDRIVE *PVBSFDRIVE;
122#endif /* RT_OS_WINDOWS */
123
124/* forward decl */
125struct _MRX_VBOX_DEVICE_EXTENSION;
126typedef struct _MRX_VBOX_DEVICE_EXTENSION *PMRX_VBOX_DEVICE_EXTENSION;
127
128DECLVBGL(int) vboxInit (void);
129DECLVBGL(void) vboxUninit (void);
130DECLVBGL(int) vboxConnect (PVBSFCLIENT pClient);
131DECLVBGL(void) vboxDisconnect (PVBSFCLIENT pClient);
132
133DECLVBGL(int) vboxCallQueryMappings (PVBSFCLIENT pClient, SHFLMAPPING paMappings[], uint32_t *pcMappings);
134
135DECLVBGL(int) vboxCallQueryMapName (PVBSFCLIENT pClient, SHFLROOT root, SHFLSTRING *pString, uint32_t size);
136
137/**
138 * Create a new file or folder or open an existing one in a shared folder. Proxies
139 * to vbsfCreate in the host shared folder service.
140 *
141 * @returns IPRT status code, but see note below
142 * @param pClient Host-guest communication connection
143 * @param pMap The mapping for the shared folder in which the file
144 * or folder is to be created
145 * @param pParsedPath The path of the file or folder relative to the shared
146 * folder
147 * @param pCreateParms Parameters for file/folder creation. See the
148 * structure description in shflsvc.h
149 * @retval pCreateParms See the structure description in shflsvc.h
150 *
151 * @note This function reports errors as follows. The return value is always
152 * VINF_SUCCESS unless an exceptional condition occurs - out of
153 * memory, invalid arguments, etc. If the file or folder could not be
154 * opened or created, pCreateParms->Handle will be set to
155 * SHFL_HANDLE_NIL on return. In this case the value in
156 * pCreateParms->Result provides information as to why (e.g.
157 * SHFL_FILE_EXISTS). pCreateParms->Result is also set on success
158 * as additional information.
159 */
160DECLVBGL(int) vboxCallCreate (PVBSFCLIENT pClient, PVBSFMAP pMap, PSHFLSTRING pParsedPath, PSHFLCREATEPARMS pCreateParms);
161
162DECLVBGL(int) vboxCallClose (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE Handle);
163DECLVBGL(int) vboxCallRemove (PVBSFCLIENT pClient, PVBSFMAP pMap, PSHFLSTRING pParsedPath, uint32_t flags);
164DECLVBGL(int) vboxCallRename (PVBSFCLIENT pClient, PVBSFMAP pMap, PSHFLSTRING pSrcPath, PSHFLSTRING pDestPath, uint32_t flags);
165DECLVBGL(int) vboxCallFlush (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile);
166
167DECLVBGL(int) vboxCallRead (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer, uint8_t *pBuffer, bool fLocked);
168DECLVBGL(int) vboxCallWrite (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer, uint8_t *pBuffer, bool fLocked);
169DECLVBGL(int) VbglR0SfWritePhysCont(PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer, RTCCPHYS PhysBuffer);
170
171DECLVBGL(int) vboxCallLock (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint64_t cbSize, uint32_t fLock);
172
173DECLVBGL(int) vboxCallDirInfo (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile,PSHFLSTRING ParsedPath, uint32_t flags,
174 uint32_t index, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer, uint32_t *pcFiles);
175DECLVBGL(int) vboxCallFSInfo (PVBSFCLIENT pClient, PVBSFMAP pMap, SHFLHANDLE hFile, uint32_t flags, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer);
176
177DECLVBGL(int) vboxCallMapFolder (PVBSFCLIENT pClient, PSHFLSTRING szFolderName, PVBSFMAP pMap);
178DECLVBGL(int) vboxCallUnmapFolder (PVBSFCLIENT pClient, PVBSFMAP pMap);
179DECLVBGL(int) vboxCallSetUtf8 (PVBSFCLIENT pClient);
180
181DECLVBGL(int) vboxReadLink (PVBSFCLIENT pClient, PVBSFMAP pMap, PSHFLSTRING ParsedPath, uint32_t pcbBuffer, uint8_t *pBuffer);
182DECLVBGL(int) vboxCallSymlink (PVBSFCLIENT pClient, PVBSFMAP pMap, PSHFLSTRING pNewPath, PSHFLSTRING pOldPath, PSHFLFSOBJINFO pBuffer);
183DECLVBGL(int) vboxCallSetSymlinks (PVBSFCLIENT pClient);
184
185#endif /* !___VBoxGuestLib_VBoxGuestR0LibSharedFolders_h */
186
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