2 Unix SMB/CIFS implementation.
3 Samba VFS module for handling offline files
4 with Tivoli Storage Manager Space Management
6 (c) Alexander Bokovoy, 2007, 2008
7 (c) Andrew Tridgell, 2007, 2008
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This VFS module accepts following options:
24 tsmsm: hsm script = <path to hsm script> (default does nothing)
25 hsm script should point to a shell script which accepts two arguments:
26 <operation> <filepath>
27 where <operation> is currently 'offline' to set offline status of the <filepath>
29 tsmsm: online ratio = ratio to check reported size against actual file size (0.5 by default)
30 tsmsm: attribute name = name of DMAPI attribute that is present when a file is offline.
31 Default is "IBMobj" (which is what GPFS uses)
33 The TSMSM VFS module tries to avoid calling expensive DMAPI calls with some heuristics
34 based on the fact that number of blocks reported of a file multiplied by 512 will be
35 bigger than 'online ratio' of actual size for online (non-migrated) files.
37 If checks fail, we call DMAPI and ask for specific attribute which present for
38 offline (migrated) files. If this attribute presents, we consider file offline.
44 #error "This module requires DMAPI support!"
47 #ifdef HAVE_XFS_DMAPI_H
48 #include <xfs/dmapi.h>
49 #elif defined(HAVE_SYS_DMI_H)
51 #elif defined(HAVE_SYS_JFSDMAPI_H)
52 #include <sys/jfsdmapi.h>
53 #elif defined(HAVE_SYS_DMAPI_H)
54 #include <sys/dmapi.h>
55 #elif defined(HAVE_DMAPI_H)
59 #ifndef _ISOC99_SOURCE
60 #define _ISOC99_SOURCE
65 /* optimisation tunables - used to avoid the DMAPI slow path */
66 #define FILE_IS_ONLINE_RATIO 0.5
68 /* default attribute name to look for */
69 #define DM_ATTRIB_OBJECT "IBMObj"
74 const char *attrib_name;
75 const char *attrib_value;
78 static void tsmsm_free_data(void **pptr) {
79 struct tsmsm_struct **tsmd = (struct tsmsm_struct **)pptr;
85 called when a client connects to a share
87 static int tsmsm_connect(struct vfs_handle_struct *handle,
90 struct tsmsm_struct *tsmd;
93 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
99 tsmd = TALLOC_ZERO_P(handle, struct tsmsm_struct);
101 SMB_VFS_NEXT_DISCONNECT(handle);
102 DEBUG(0,("tsmsm_connect: out of memory!\n"));
106 if (!dmapi_have_session()) {
107 SMB_VFS_NEXT_DISCONNECT(handle);
108 DEBUG(0,("tsmsm_connect: no DMAPI session for Samba is available!\n"));
113 tsmname = (handle->param ? handle->param : "tsmsm");
115 /* Get 'hsm script' and 'dmapi attribute' parameters to tsmd context */
116 tsmd->hsmscript = lp_parm_talloc_string(SNUM(handle->conn), tsmname,
118 talloc_steal(tsmd, tsmd->hsmscript);
120 tsmd->attrib_name = lp_parm_talloc_string(SNUM(handle->conn), tsmname,
121 "dmapi attribute", DM_ATTRIB_OBJECT);
122 talloc_steal(tsmd, tsmd->attrib_name);
124 tsmd->attrib_value = lp_parm_talloc_string(SNUM(handle->conn), "tsmsm",
125 "dmapi value", NULL);
126 talloc_steal(tsmd, tsmd->attrib_value);
128 /* retrieve 'online ratio'. In case of error default to FILE_IS_ONLINE_RATIO */
129 fres = lp_parm_const_string(SNUM(handle->conn), tsmname,
130 "online ratio", NULL);
132 tsmd->online_ratio = FILE_IS_ONLINE_RATIO;
134 tsmd->online_ratio = strtof(fres, NULL);
135 if (tsmd->online_ratio > 1.0 ||
136 tsmd->online_ratio <= 0.0) {
137 DEBUG(1, ("tsmsm_connect: invalid online ration %f - using %f.\n",
138 tsmd->online_ratio, (float)FILE_IS_ONLINE_RATIO));
142 /* Store the private data. */
143 SMB_VFS_HANDLE_SET_DATA(handle, tsmd, tsmsm_free_data,
144 struct tsmsm_struct, return -1);
148 static bool tsmsm_is_offline(struct vfs_handle_struct *handle,
149 const struct smb_filename *fname,
150 SMB_STRUCT_STAT *stbuf)
152 struct tsmsm_struct *tsmd = (struct tsmsm_struct *) handle->data;
153 const dm_sessid_t *dmsession_id;
154 void *dmhandle = NULL;
155 size_t dmhandle_len = 0;
157 dm_attrname_t dmname;
165 status = get_full_smb_filename(talloc_tos(), fname, &path);
166 if (!NT_STATUS_IS_OK(status)) {
167 errno = map_errno_from_nt_status(status);
171 /* if the file has more than FILE_IS_ONLINE_RATIO of blocks available,
172 then assume it is not offline (it may not be 100%, as it could be sparse) */
173 if (512 * stbuf->st_ex_blocks >=
174 stbuf->st_ex_size * tsmd->online_ratio) {
175 DEBUG(10,("%s not offline: st_blocks=%llu st_size=%llu "
176 "online_ratio=%.2f\n", path,
177 (unsigned long long)stbuf->st_ex_blocks,
178 (unsigned long long)stbuf->st_ex_size, tsmd->online_ratio));
182 dmsession_id = dmapi_get_current_session();
183 if (dmsession_id == NULL) {
184 DEBUG(2, ("tsmsm_is_offline: no DMAPI session available? "
185 "Assume file is online.\n"));
189 /* using POSIX capabilities does not work here. It's a slow path, so
190 * become_root() is just as good anyway (tridge)
193 /* Also, AIX has DMAPI but no POSIX capablities support. In this case,
194 * we need to be root to do DMAPI manipulations.
198 /* go the slow DMAPI route */
199 if (dm_path_to_handle((char*)path, &dmhandle, &dmhandle_len) != 0) {
200 DEBUG(2,("dm_path_to_handle failed - assuming offline (%s) - %s\n",
201 path, strerror(errno)));
206 memset(&dmname, 0, sizeof(dmname));
207 strlcpy((char *)&dmname.an_chars[0], tsmd->attrib_name, sizeof(dmname.an_chars));
209 if (tsmd->attrib_value != NULL) {
210 buflen = strlen(tsmd->attrib_value);
214 buf = talloc_zero_size(tsmd, buflen);
216 DEBUG(0,("out of memory in tsmsm_is_offline -- assuming online (%s)\n", path));
225 ret = dm_get_dmattr(*dmsession_id, dmhandle, dmhandle_len,
226 DM_NO_TOKEN, &dmname, buflen, buf, &rlen);
227 if (ret == -1 && errno == EINVAL) {
228 DEBUG(0, ("Stale DMAPI session, re-creating it.\n"));
230 if (dmapi_new_session()) {
231 dmsession_id = dmapi_get_current_session();
234 ("Unable to re-create DMAPI session, assuming offline (%s) - %s\n",
235 path, strerror(errno)));
237 dm_handle_free(dmhandle, dmhandle_len);
241 } while (ret == -1 && lerrno == EINVAL);
243 /* check if we need a specific attribute value */
244 if (tsmd->attrib_value != NULL) {
245 offline = (ret == 0 && rlen == buflen &&
246 memcmp(buf, tsmd->attrib_value, buflen) == 0);
248 /* its offline if the specified DMAPI attribute exists */
249 offline = (ret == 0 || (ret == -1 && errno == E2BIG));
252 DEBUG(10,("dm_get_dmattr %s ret=%d (%s)\n", path, ret, strerror(errno)));
256 dm_handle_free(dmhandle, dmhandle_len);
265 static bool tsmsm_aio_force(struct vfs_handle_struct *handle, struct files_struct *fsp)
267 SMB_STRUCT_STAT sbuf;
268 struct tsmsm_struct *tsmd = (struct tsmsm_struct *) handle->data;
269 /* see if the file might be offline. This is called before each IO
270 to ensure we use AIO if the file is offline. We don't do the full dmapi
271 call as that would be too slow, instead we err on the side of using AIO
272 if the file might be offline
274 if(SMB_VFS_FSTAT(fsp, &sbuf) == 0) {
275 DEBUG(10,("tsmsm_aio_force st_blocks=%llu st_size=%llu "
276 "online_ratio=%.2f\n", (unsigned long long)sbuf.st_ex_blocks,
277 (unsigned long long)sbuf.st_ex_size, tsmd->online_ratio));
278 return !(512 * sbuf.st_ex_blocks >=
279 sbuf.st_ex_size * tsmd->online_ratio);
284 static ssize_t tsmsm_aio_return(struct vfs_handle_struct *handle, struct files_struct *fsp,
285 SMB_STRUCT_AIOCB *aiocb)
289 result = SMB_VFS_NEXT_AIO_RETURN(handle, fsp, aiocb);
291 notify_fname(handle->conn, NOTIFY_ACTION_MODIFIED,
292 FILE_NOTIFY_CHANGE_ATTRIBUTES,
293 fsp->fsp_name->base_name);
299 static ssize_t tsmsm_sendfile(vfs_handle_struct *handle, int tofd, files_struct *fsp, const DATA_BLOB *hdr,
300 SMB_OFF_T offset, size_t n)
302 bool file_offline = tsmsm_aio_force(handle, fsp);
305 DEBUG(10,("tsmsm_sendfile on offline file - rejecting\n"));
310 return SMB_VFS_NEXT_SENDFILE(handle, tofd, fsp, hdr, offset, n);
313 /* We do overload pread to allow notification when file becomes online after offline status */
314 /* We don't intercept SMB_VFS_READ here because all file I/O now goes through SMB_VFS_PREAD instead */
315 static ssize_t tsmsm_pread(struct vfs_handle_struct *handle, struct files_struct *fsp,
316 void *data, size_t n, SMB_OFF_T offset) {
318 bool notify_online = tsmsm_aio_force(handle, fsp);
320 result = SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
321 if((result != -1) && notify_online) {
322 /* We can't actually force AIO at this point (came here not from reply_read_and_X)
323 what we can do is to send notification that file became online
325 notify_fname(handle->conn, NOTIFY_ACTION_MODIFIED,
326 FILE_NOTIFY_CHANGE_ATTRIBUTES,
327 fsp->fsp_name->base_name);
333 static ssize_t tsmsm_pwrite(struct vfs_handle_struct *handle, struct files_struct *fsp,
334 const void *data, size_t n, SMB_OFF_T offset) {
336 bool notify_online = tsmsm_aio_force(handle, fsp);
338 result = SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
339 if((result != -1) && notify_online) {
340 /* We can't actually force AIO at this point (came here not from reply_read_and_X)
341 what we can do is to send notification that file became online
343 notify_fname(handle->conn, NOTIFY_ACTION_MODIFIED,
344 FILE_NOTIFY_CHANGE_ATTRIBUTES,
345 fsp->fsp_name->base_name);
351 static int tsmsm_set_offline(struct vfs_handle_struct *handle,
352 const struct smb_filename *fname)
354 struct tsmsm_struct *tsmd = (struct tsmsm_struct *) handle->data;
360 if (tsmd->hsmscript == NULL) {
361 /* no script enabled */
362 DEBUG(1, ("tsmsm_set_offline: No 'tsmsm:hsm script' configured\n"));
366 status = get_full_smb_filename(talloc_tos(), fname, &path);
367 if (!NT_STATUS_IS_OK(status)) {
368 errno = map_errno_from_nt_status(status);
372 /* Now, call the script */
373 command = talloc_asprintf(tsmd, "%s offline \"%s\"", tsmd->hsmscript, path);
375 DEBUG(1, ("tsmsm_set_offline: can't allocate memory to run hsm script"));
378 DEBUG(10, ("tsmsm_set_offline: Running [%s]\n", command));
379 if((result = smbrun(command, NULL)) != 0) {
380 DEBUG(1,("tsmsm_set_offline: Running [%s] returned %d\n", command, result));
382 TALLOC_FREE(command);
386 static uint32_t tsmsm_fs_capabilities(struct vfs_handle_struct *handle,
387 enum timestamp_set_resolution *p_ts_res)
389 return SMB_VFS_NEXT_FS_CAPABILITIES(handle, p_ts_res) | FILE_SUPPORTS_REMOTE_STORAGE | FILE_SUPPORTS_REPARSE_POINTS;
392 static struct vfs_fn_pointers tsmsm_fns = {
393 .connect_fn = tsmsm_connect,
394 .fs_capabilities = tsmsm_fs_capabilities,
395 .aio_force = tsmsm_aio_force,
396 .aio_return_fn = tsmsm_aio_return,
397 .pread = tsmsm_pread,
398 .pwrite = tsmsm_pwrite,
399 .sendfile = tsmsm_sendfile,
400 .is_offline = tsmsm_is_offline,
401 .set_offline = tsmsm_set_offline,
404 NTSTATUS vfs_tsmsm_init(void);
405 NTSTATUS vfs_tsmsm_init(void)
407 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION,
408 "tsmsm", &tsmsm_fns);