2 * Unix SMB/CIFS implementation.
4 * Support for OneFS Alternate Data Streams
6 * Copyright (C) Tim Prouty, 2008
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
24 #include "onefs_config.h"
26 #include <sys/isi_enc.h>
29 * OneFS stores streams without the explicit :$DATA at the end, so this strips
30 * it off. All onefs_stream functions must call through this instead of
31 * split_ntfs_stream_name directly.
33 NTSTATUS
onefs_split_ntfs_stream_name(TALLOC_CTX
*mem_ctx
, const char *fname
,
34 char **pbase
, char **pstream
)
39 status
= split_ntfs_stream_name(mem_ctx
, fname
, pbase
, pstream
);
40 if (!NT_STATUS_IS_OK(status
)) {
44 /* Default $DATA stream. */
45 if (pstream
== NULL
|| *pstream
== NULL
) {
49 /* Strip off the $DATA. */
50 stream
= strrchr_m(*pstream
, ':');
57 int onefs_is_stream(const char *path
, char **pbase
, char **pstream
,
60 (*is_stream
) = is_ntfs_stream_name(path
);
66 if (!NT_STATUS_IS_OK(onefs_split_ntfs_stream_name(talloc_tos(), path
,
68 DEBUG(10, ("onefs_split_ntfs_stream_name failed\n"));
76 int onefs_close(vfs_handle_struct
*handle
, struct files_struct
*fsp
)
81 ret
= SMB_VFS_NEXT_CLOSE(handle
, fsp
->base_fsp
);
83 ret2
= SMB_VFS_NEXT_CLOSE(handle
, fsp
);
85 return ret
? ret
: ret2
;
89 * Get the ADS directory fd for a file.
91 static int get_stream_dir_fd(connection_struct
*conn
, const char *base
,
98 /* If a valid base_fdp was given, use it. */
99 if (base_fdp
&& *base_fdp
>= 0) {
102 base_fd
= onefs_sys_create_file(conn
,
121 /* Open the ADS directory. */
122 dir_fd
= onefs_sys_create_file(conn
,
137 /* Close base_fd if it's not need or on error. */
138 if (!base_fdp
|| dir_fd
< 0) {
144 /* Set the out base_fdp if successful and it was requested. */
145 if (base_fdp
&& dir_fd
>= 0) {
152 int onefs_rename(vfs_handle_struct
*handle
, const char *oldname
,
155 TALLOC_CTX
*frame
= NULL
;
166 START_PROFILE(syscall_rename_at
);
168 frame
= talloc_stackframe();
170 ret
= onefs_is_stream(oldname
, &obase
, &osname
, &old_is_stream
);
172 END_PROFILE(syscall_rename_at
);
176 ret
= onefs_is_stream(newname
, &nbase
, &nsname
, &new_is_stream
);
178 END_PROFILE(syscall_rename_at
);
182 if (!old_is_stream
&& !new_is_stream
) {
183 ret
= SMB_VFS_NEXT_RENAME(handle
, oldname
, newname
);
184 END_PROFILE(syscall_rename_at
);
188 dir_fd
= get_stream_dir_fd(handle
->conn
, obase
, NULL
);
193 DEBUG(8,("onefs_rename called for %s : %s => %s : %s\n",
194 obase
, osname
, nbase
, nsname
));
196 /* Handle rename of stream to default stream specially. */
197 if (nsname
== NULL
) {
198 ret
= enc_renameat(dir_fd
, osname
, ENC_DEFAULT
, AT_FDCWD
,
201 ret
= enc_renameat(dir_fd
, osname
, ENC_DEFAULT
, dir_fd
, nsname
,
206 END_PROFILE(syscall_rename_at
);
218 * Merge a base file's sbuf into the a streams's sbuf.
220 static void merge_stat(SMB_STRUCT_STAT
*stream_sbuf
,
221 const SMB_STRUCT_STAT
*base_sbuf
)
223 int dos_flags
= (UF_DOS_NOINDEX
| UF_DOS_ARCHIVE
|
224 UF_DOS_HIDDEN
| UF_DOS_RO
| UF_DOS_SYSTEM
);
225 stream_sbuf
->st_mtime
= base_sbuf
->st_mtime
;
226 stream_sbuf
->st_ctime
= base_sbuf
->st_ctime
;
227 stream_sbuf
->st_atime
= base_sbuf
->st_atime
;
228 stream_sbuf
->st_flags
&= ~dos_flags
;
229 stream_sbuf
->st_flags
|= base_sbuf
->st_flags
& dos_flags
;
232 /* fake timestamps */
233 static void onefs_adjust_stat_time(vfs_handle_struct
*handle
, const char *fname
,
234 SMB_STRUCT_STAT
*sbuf
)
236 struct onefs_vfs_share_config cfg
;
237 struct timeval tv_now
= {0, 0};
238 bool static_mtime
= False
;
239 bool static_atime
= False
;
241 if (!onefs_get_config(SNUM(handle
->conn
),
242 ONEFS_VFS_CONFIG_FAKETIMESTAMPS
, &cfg
)) {
246 if (IS_MTIME_STATIC_PATH(handle
->conn
, &cfg
, fname
)) {
247 sbuf
->st_mtime
= sbuf
->st_birthtime
;
250 if (IS_ATIME_STATIC_PATH(handle
->conn
, &cfg
, fname
)) {
251 sbuf
->st_atime
= sbuf
->st_birthtime
;
255 if (IS_CTIME_NOW_PATH(handle
->conn
, &cfg
, fname
)) {
256 if (cfg
.ctime_slop
< 0) {
257 sbuf
->st_birthtime
= INT_MAX
- 1;
259 GetTimeOfDay(&tv_now
);
260 sbuf
->st_birthtime
= tv_now
.tv_sec
+ cfg
.ctime_slop
;
264 if (!static_mtime
&& IS_MTIME_NOW_PATH(handle
->conn
,&cfg
,fname
)) {
265 if (cfg
.mtime_slop
< 0) {
266 sbuf
->st_mtime
= INT_MAX
- 1;
268 if (tv_now
.tv_sec
== 0)
269 GetTimeOfDay(&tv_now
);
270 sbuf
->st_mtime
= tv_now
.tv_sec
+ cfg
.mtime_slop
;
273 if (!static_atime
&& IS_ATIME_NOW_PATH(handle
->conn
,&cfg
,fname
)) {
274 if (cfg
.atime_slop
< 0) {
275 sbuf
->st_atime
= INT_MAX
- 1;
277 if (tv_now
.tv_sec
== 0)
278 GetTimeOfDay(&tv_now
);
279 sbuf
->st_atime
= tv_now
.tv_sec
+ cfg
.atime_slop
;
284 static int stat_stream(vfs_handle_struct
*handle
, const char *base
,
285 const char *stream
, SMB_STRUCT_STAT
*sbuf
, int flags
)
287 SMB_STRUCT_STAT base_sbuf
;
288 int base_fd
= -1, dir_fd
, ret
, saved_errno
;
290 dir_fd
= get_stream_dir_fd(handle
->conn
, base
, &base_fd
);
295 /* Stat the stream. */
296 ret
= enc_fstatat(dir_fd
, stream
, ENC_DEFAULT
, sbuf
, flags
);
298 /* Now stat the base file and merge the results. */
299 ret
= sys_fstat(base_fd
, &base_sbuf
);
301 merge_stat(sbuf
, &base_sbuf
);
312 int onefs_stat(vfs_handle_struct
*handle
, const char *path
,
313 SMB_STRUCT_STAT
*sbuf
)
320 ret
= onefs_is_stream(path
, &base
, &stream
, &is_stream
);
325 ret
= SMB_VFS_NEXT_STAT(handle
, path
, sbuf
);
326 } else if (!stream
) {
327 /* If it's the ::$DATA stream just stat the base file name. */
328 ret
= SMB_VFS_NEXT_STAT(handle
, base
, sbuf
);
330 ret
= stat_stream(handle
, base
, stream
, sbuf
, 0);
333 onefs_adjust_stat_time(handle
, path
, sbuf
);
337 int onefs_fstat(vfs_handle_struct
*handle
, struct files_struct
*fsp
,
338 SMB_STRUCT_STAT
*sbuf
)
340 SMB_STRUCT_STAT base_sbuf
;
343 /* Stat the stream, by calling next_fstat on the stream's fd. */
344 ret
= SMB_VFS_NEXT_FSTAT(handle
, fsp
, sbuf
);
349 /* Stat the base file and merge the results. */
350 if (fsp
!= NULL
&& fsp
->base_fsp
!= NULL
) {
351 ret
= sys_fstat(fsp
->base_fsp
->fh
->fd
, &base_sbuf
);
353 merge_stat(sbuf
, &base_sbuf
);
357 onefs_adjust_stat_time(handle
, fsp
->fsp_name
, sbuf
);
361 int onefs_lstat(vfs_handle_struct
*handle
, const char *path
,
362 SMB_STRUCT_STAT
*sbuf
)
369 ret
= onefs_is_stream(path
, &base
, &stream
, &is_stream
);
374 ret
= SMB_VFS_NEXT_LSTAT(handle
, path
, sbuf
);
375 } else if (!stream
) {
376 /* If it's the ::$DATA stream just stat the base file name. */
377 ret
= SMB_VFS_NEXT_LSTAT(handle
, base
, sbuf
);
379 ret
= stat_stream(handle
, base
, stream
, sbuf
,
380 AT_SYMLINK_NOFOLLOW
);
383 onefs_adjust_stat_time(handle
, path
, sbuf
);
387 int onefs_unlink(vfs_handle_struct
*handle
, const char *path
)
393 int dir_fd
, saved_errno
;
395 ret
= onefs_is_stream(path
, &base
, &stream
, &is_stream
);
401 return SMB_VFS_NEXT_UNLINK(handle
, path
);
404 /* If it's the ::$DATA stream just unlink the base file name. */
406 return SMB_VFS_NEXT_UNLINK(handle
, base
);
409 dir_fd
= get_stream_dir_fd(handle
->conn
, base
, NULL
);
414 ret
= enc_unlinkat(dir_fd
, stream
, ENC_DEFAULT
, 0);
422 int onefs_vtimes_streams(vfs_handle_struct
*handle
, const char *fname
,
423 int flags
, struct timespec times
[3])
432 START_PROFILE(syscall_ntimes
);
434 ret
= onefs_is_stream(fname
, &base
, &stream
, &is_stream
);
439 ret
= vtimes(fname
, times
, flags
);
443 dirfd
= get_stream_dir_fd(handle
->conn
, base
, NULL
);
448 ret
= enc_vtimesat(dirfd
, stream
, ENC_DEFAULT
, times
, flags
);
450 END_PROFILE(syscall_ntimes
);
458 int onefs_chflags(vfs_handle_struct
*handle
, const char *path
,
464 if (!NT_STATUS_IS_OK(onefs_split_ntfs_stream_name(talloc_tos(), path
,
466 DEBUG(10, ("onefs_split_ntfs_stream_name failed\n"));
472 * Only set the attributes on the base file. ifs_createfile handles
473 * file creation attribute semantics.
475 return SMB_VFS_NEXT_CHFLAGS(handle
, base
, flags
);
479 * Streaminfo enumeration functionality
481 struct streaminfo_state
{
483 vfs_handle_struct
*handle
;
484 unsigned int num_streams
;
485 struct stream_struct
*streams
;
489 static bool add_one_stream(TALLOC_CTX
*mem_ctx
, unsigned int *num_streams
,
490 struct stream_struct
**streams
,
491 const char *name
, SMB_OFF_T size
,
492 SMB_OFF_T alloc_size
)
494 struct stream_struct
*tmp
;
496 tmp
= TALLOC_REALLOC_ARRAY(mem_ctx
, *streams
, struct stream_struct
,
502 tmp
[*num_streams
].name
= talloc_asprintf(mem_ctx
, ":%s:%s", name
,
504 if (tmp
[*num_streams
].name
== NULL
) {
508 tmp
[*num_streams
].size
= size
;
509 tmp
[*num_streams
].alloc_size
= alloc_size
;
516 static NTSTATUS
walk_onefs_streams(connection_struct
*conn
, files_struct
*fsp
,
518 struct streaminfo_state
*state
,
519 SMB_STRUCT_STAT
*base_sbuf
)
521 NTSTATUS status
= NT_STATUS_OK
;
522 bool opened_base_fd
= false;
527 SMB_STRUCT_DIR
*dirp
= NULL
;
528 SMB_STRUCT_DIRENT
*dp
= NULL
;
529 files_struct fake_fs
;
530 struct fd_handle fake_fh
;
531 SMB_STRUCT_STAT stream_sbuf
;
533 ZERO_STRUCT(fake_fh
);
534 ZERO_STRUCT(fake_fs
);
536 /* If the base file is already open, use its fd. */
537 if ((fsp
!= NULL
) && (fsp
->fh
->fd
!= -1)) {
538 base_fd
= fsp
->fh
->fd
;
540 opened_base_fd
= true;
543 dir_fd
= get_stream_dir_fd(conn
, fname
, &base_fd
);
545 return map_nt_error_from_unix(errno
);
548 /* Open the ADS directory. */
549 if ((dirp
= fdopendir(dir_fd
)) == NULL
) {
550 DEBUG(0, ("Error on opendir %s. errno=%d (%s)\n",
551 fname
, errno
, strerror(errno
)));
552 status
= map_nt_error_from_unix(errno
);
556 /* Initialize the dir state struct and add it to the list.
557 * This is a layer violation, and really should be handled by a
558 * VFS_FDOPENDIR() call which would properly setup the dir state.
559 * But since this is all within the onefs.so module, we cheat for
560 * now and call directly into the readdirplus code.
561 * NOTE: This state MUST be freed by a proper VFS_CLOSEDIR() call. */
562 ret
= onefs_rdp_add_dir_state(conn
, dirp
);
564 DEBUG(0, ("Error adding dir_state to the list\n"));
565 status
= map_nt_error_from_unix(errno
);
570 fake_fs
.fh
= &fake_fh
;
571 fake_fs
.fsp_name
= SMB_STRDUP(fname
);
573 /* Iterate over the streams in the ADS directory. */
574 while ((dp
= SMB_VFS_READDIR(conn
, dirp
, NULL
)) != NULL
) {
575 /* Skip the "." and ".." entries */
576 if ((strcmp(dp
->d_name
, ".") == 0) ||
577 (strcmp(dp
->d_name
, "..") == 0))
580 /* Open actual stream */
581 if ((stream_fd
= onefs_sys_create_file(conn
,
595 DEBUG(0, ("Error opening stream %s:%s. "
596 "errno=%d (%s)\n", fname
, dp
->d_name
, errno
,
601 /* Figure out the stat info. */
602 fake_fh
.fd
= stream_fd
;
603 ret
= SMB_VFS_FSTAT(&fake_fs
, &stream_sbuf
);
607 DEBUG(0, ("Error fstating stream %s:%s. "
608 "errno=%d (%s)\n", fname
, dp
->d_name
, errno
,
613 merge_stat(&stream_sbuf
, base_sbuf
);
615 if (!add_one_stream(state
->mem_ctx
,
616 &state
->num_streams
, &state
->streams
,
617 dp
->d_name
, stream_sbuf
.st_size
,
618 SMB_VFS_GET_ALLOC_SIZE(conn
, NULL
,
620 state
->status
= NT_STATUS_NO_MEMORY
;
626 /* Cleanup everything that was opened. */
628 SMB_VFS_CLOSEDIR(conn
, dirp
);
633 if (opened_base_fd
) {
634 SMB_ASSERT(base_fd
>= 0);
638 SAFE_FREE(fake_fs
.fsp_name
);
642 NTSTATUS
onefs_streaminfo(vfs_handle_struct
*handle
,
643 struct files_struct
*fsp
,
646 unsigned int *num_streams
,
647 struct stream_struct
**streams
)
649 SMB_STRUCT_STAT sbuf
;
652 struct streaminfo_state state
;
654 /* Get a valid stat. */
655 if ((fsp
!= NULL
) && (fsp
->fh
->fd
!= -1)) {
656 if (is_ntfs_stream_name(fsp
->fsp_name
)) {
657 return NT_STATUS_INVALID_PARAMETER
;
659 ret
= SMB_VFS_FSTAT(fsp
, &sbuf
);
661 if (is_ntfs_stream_name(fname
)) {
662 return NT_STATUS_INVALID_PARAMETER
;
664 ret
= SMB_VFS_STAT(handle
->conn
, fname
, &sbuf
);
668 return map_nt_error_from_unix(errno
);
671 state
.streams
= NULL
;
672 state
.num_streams
= 0;
674 if (lp_parm_bool(SNUM(handle
->conn
), PARM_ONEFS_TYPE
,
675 PARM_IGNORE_STREAMS
, PARM_IGNORE_STREAMS_DEFAULT
)) {
679 /* Add the default stream. */
680 if (S_ISREG(sbuf
.st_mode
)) {
681 if (!add_one_stream(mem_ctx
,
682 &state
.num_streams
, &state
.streams
,
684 SMB_VFS_GET_ALLOC_SIZE(handle
->conn
, fsp
,
686 return NT_STATUS_NO_MEMORY
;
690 state
.mem_ctx
= mem_ctx
;
691 state
.handle
= handle
;
692 state
.status
= NT_STATUS_OK
;
694 /* If there are more streams, add them too. */
695 if (sbuf
.st_flags
& UF_HASADS
) {
697 status
= walk_onefs_streams(handle
->conn
, fsp
, fname
,
700 if (!NT_STATUS_IS_OK(status
)) {
701 TALLOC_FREE(state
.streams
);
705 if (!NT_STATUS_IS_OK(state
.status
)) {
706 TALLOC_FREE(state
.streams
);
711 *num_streams
= state
.num_streams
;
712 *streams
= state
.streams
;