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/>.
23 #include <sys/isi_enc.h>
26 * OneFS stores streams without the explicit :$DATA at the end, so this strips
27 * it off. All onefs_stream functions must call through this instead of
28 * split_ntfs_stream_name directly.
30 NTSTATUS onefs_split_ntfs_stream_name(TALLOC_CTX *mem_ctx, const char *fname,
31 char **pbase, char **pstream)
36 status = split_ntfs_stream_name(mem_ctx, fname, pbase, pstream);
37 if (!NT_STATUS_IS_OK(status)) {
41 /* Default $DATA stream. */
42 if (pstream == NULL || *pstream == NULL) {
46 /* Strip off the $DATA. */
47 stream = strrchr_m(*pstream, ':');
54 int onefs_is_stream(const char *path, char **pbase, char **pstream,
57 (*is_stream) = is_ntfs_stream_name(path);
63 if (!NT_STATUS_IS_OK(onefs_split_ntfs_stream_name(talloc_tos(), path,
65 DEBUG(10, ("onefs_split_ntfs_stream_name failed\n"));
73 int onefs_close(vfs_handle_struct *handle, struct files_struct *fsp)
78 ret = SMB_VFS_NEXT_CLOSE(handle, fsp->base_fsp);
80 ret2 = SMB_VFS_NEXT_CLOSE(handle, fsp);
82 return ret ? ret : ret2;
86 * Get the ADS directory fd for a file.
88 static int get_stream_dir_fd(connection_struct *conn, const char *base,
95 /* If a valid base_fdp was given, use it. */
96 if (base_fdp && *base_fdp >= 0) {
99 base_fd = onefs_sys_create_file(conn,
118 /* Open the ADS directory. */
119 dir_fd = onefs_sys_create_file(conn,
134 /* Close base_fd if it's not need or on error. */
135 if (!base_fdp || dir_fd < 0) {
141 /* Set the out base_fdp if successful and it was requested. */
142 if (base_fdp && dir_fd >= 0) {
149 int onefs_rename(vfs_handle_struct *handle, const char *oldname,
152 TALLOC_CTX *frame = NULL;
163 START_PROFILE(syscall_rename_at);
165 frame = talloc_stackframe();
167 ret = onefs_is_stream(oldname, &obase, &osname, &old_is_stream);
169 END_PROFILE(syscall_rename_at);
173 ret = onefs_is_stream(newname, &nbase, &nsname, &new_is_stream);
175 END_PROFILE(syscall_rename_at);
179 if (!old_is_stream && !new_is_stream) {
180 ret = SMB_VFS_NEXT_RENAME(handle, oldname, newname);
181 END_PROFILE(syscall_rename_at);
185 dir_fd = get_stream_dir_fd(handle->conn, obase, NULL);
190 DEBUG(8,("onefs_rename called for %s : %s => %s : %s\n",
191 obase, osname, nbase, nsname));
193 /* Handle rename of stream to default stream specially. */
194 if (nsname == NULL) {
195 ret = enc_renameat(dir_fd, osname, ENC_DEFAULT, AT_FDCWD,
198 ret = enc_renameat(dir_fd, osname, ENC_DEFAULT, dir_fd, nsname,
203 END_PROFILE(syscall_rename_at);
215 * Merge a base file's sbuf into the a streams's sbuf.
217 static void merge_stat(SMB_STRUCT_STAT *stream_sbuf,
218 const SMB_STRUCT_STAT *base_sbuf)
220 int dos_flags = (UF_DOS_NOINDEX | UF_DOS_ARCHIVE |
221 UF_DOS_HIDDEN | UF_DOS_RO | UF_DOS_SYSTEM);
222 stream_sbuf->st_mtime = base_sbuf->st_mtime;
223 stream_sbuf->st_ctime = base_sbuf->st_ctime;
224 stream_sbuf->st_atime = base_sbuf->st_atime;
225 stream_sbuf->st_flags &= ~dos_flags;
226 stream_sbuf->st_flags |= base_sbuf->st_flags & dos_flags;
229 /* fake timestamps */
230 static void onefs_adjust_stat_time(vfs_handle_struct *handle, const char *fname,
231 SMB_STRUCT_STAT *sbuf)
233 struct onefs_vfs_share_config cfg;
234 struct timeval tv_now = {0, 0};
235 bool static_mtime = False;
236 bool static_atime = False;
238 if (!onefs_get_config(SNUM(handle->conn),
239 ONEFS_VFS_CONFIG_FAKETIMESTAMPS, &cfg)) {
243 if (IS_MTIME_STATIC_PATH(handle->conn, &cfg, fname)) {
244 sbuf->st_mtime = sbuf->st_birthtime;
247 if (IS_ATIME_STATIC_PATH(handle->conn, &cfg, fname)) {
248 sbuf->st_atime = sbuf->st_birthtime;
252 if (IS_CTIME_NOW_PATH(handle->conn, &cfg, fname)) {
253 if (cfg.ctime_slop < 0) {
254 sbuf->st_birthtime = INT_MAX - 1;
256 GetTimeOfDay(&tv_now);
257 sbuf->st_birthtime = tv_now.tv_sec + cfg.ctime_slop;
261 if (!static_mtime && IS_MTIME_NOW_PATH(handle->conn,&cfg,fname)) {
262 if (cfg.mtime_slop < 0) {
263 sbuf->st_mtime = INT_MAX - 1;
265 if (tv_now.tv_sec == 0)
266 GetTimeOfDay(&tv_now);
267 sbuf->st_mtime = tv_now.tv_sec + cfg.mtime_slop;
270 if (!static_atime && IS_ATIME_NOW_PATH(handle->conn,&cfg,fname)) {
271 if (cfg.atime_slop < 0) {
272 sbuf->st_atime = INT_MAX - 1;
274 if (tv_now.tv_sec == 0)
275 GetTimeOfDay(&tv_now);
276 sbuf->st_atime = tv_now.tv_sec + cfg.atime_slop;
281 static int stat_stream(vfs_handle_struct *handle, const char *base,
282 const char *stream, SMB_STRUCT_STAT *sbuf, int flags)
284 SMB_STRUCT_STAT base_sbuf;
285 int base_fd = -1, dir_fd, ret, saved_errno;
287 dir_fd = get_stream_dir_fd(handle->conn, base, &base_fd);
292 /* Stat the stream. */
293 ret = enc_fstatat(dir_fd, stream, ENC_DEFAULT, sbuf, flags);
295 /* Now stat the base file and merge the results. */
296 ret = sys_fstat(base_fd, &base_sbuf);
298 merge_stat(sbuf, &base_sbuf);
309 int onefs_stat(vfs_handle_struct *handle, const char *path,
310 SMB_STRUCT_STAT *sbuf)
317 ret = onefs_is_stream(path, &base, &stream, &is_stream);
322 ret = SMB_VFS_NEXT_STAT(handle, path, sbuf);
323 } else if (!stream) {
324 /* If it's the ::$DATA stream just stat the base file name. */
325 ret = SMB_VFS_NEXT_STAT(handle, base, sbuf);
327 ret = stat_stream(handle, base, stream, sbuf, 0);
330 onefs_adjust_stat_time(handle, path, sbuf);
334 int onefs_fstat(vfs_handle_struct *handle, struct files_struct *fsp,
335 SMB_STRUCT_STAT *sbuf)
337 SMB_STRUCT_STAT base_sbuf;
340 /* Stat the stream, by calling next_fstat on the stream's fd. */
341 ret = SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
346 /* Stat the base file and merge the results. */
347 if (fsp != NULL && fsp->base_fsp != NULL) {
348 ret = sys_fstat(fsp->base_fsp->fh->fd, &base_sbuf);
350 merge_stat(sbuf, &base_sbuf);
354 onefs_adjust_stat_time(handle, fsp->fsp_name, sbuf);
358 int onefs_lstat(vfs_handle_struct *handle, const char *path,
359 SMB_STRUCT_STAT *sbuf)
366 ret = onefs_is_stream(path, &base, &stream, &is_stream);
371 ret = SMB_VFS_NEXT_LSTAT(handle, path, sbuf);
372 } else if (!stream) {
373 /* If it's the ::$DATA stream just stat the base file name. */
374 ret = SMB_VFS_NEXT_LSTAT(handle, base, sbuf);
376 ret = stat_stream(handle, base, stream, sbuf,
377 AT_SYMLINK_NOFOLLOW);
380 onefs_adjust_stat_time(handle, path, sbuf);
384 int onefs_unlink(vfs_handle_struct *handle, const char *path)
390 int dir_fd, saved_errno;
392 ret = onefs_is_stream(path, &base, &stream, &is_stream);
398 return SMB_VFS_NEXT_UNLINK(handle, path);
401 /* If it's the ::$DATA stream just unlink the base file name. */
403 return SMB_VFS_NEXT_UNLINK(handle, base);
406 dir_fd = get_stream_dir_fd(handle->conn, base, NULL);
411 ret = enc_unlinkat(dir_fd, stream, ENC_DEFAULT, 0);
419 int onefs_vtimes_streams(vfs_handle_struct *handle, const char *fname,
420 int flags, struct timespec times[3])
429 START_PROFILE(syscall_ntimes);
431 ret = onefs_is_stream(fname, &base, &stream, &is_stream);
436 ret = vtimes(fname, times, flags);
440 dirfd = get_stream_dir_fd(handle->conn, base, NULL);
445 ret = enc_vtimesat(dirfd, stream, ENC_DEFAULT, times, flags);
447 END_PROFILE(syscall_ntimes);
455 int onefs_chflags(vfs_handle_struct *handle, const char *path,
461 if (!NT_STATUS_IS_OK(onefs_split_ntfs_stream_name(talloc_tos(), path,
463 DEBUG(10, ("onefs_split_ntfs_stream_name failed\n"));
469 * Only set the attributes on the base file. ifs_createfile handles
470 * file creation attribute semantics.
472 return SMB_VFS_NEXT_CHFLAGS(handle, base, flags);
476 * Streaminfo enumeration functionality
478 struct streaminfo_state {
480 vfs_handle_struct *handle;
481 unsigned int num_streams;
482 struct stream_struct *streams;
486 static bool add_one_stream(TALLOC_CTX *mem_ctx, unsigned int *num_streams,
487 struct stream_struct **streams,
488 const char *name, SMB_OFF_T size,
489 SMB_OFF_T alloc_size)
491 struct stream_struct *tmp;
493 tmp = TALLOC_REALLOC_ARRAY(mem_ctx, *streams, struct stream_struct,
499 tmp[*num_streams].name = talloc_asprintf(mem_ctx, ":%s:%s", name,
501 if (tmp[*num_streams].name == NULL) {
505 tmp[*num_streams].size = size;
506 tmp[*num_streams].alloc_size = alloc_size;
513 static NTSTATUS walk_onefs_streams(connection_struct *conn, files_struct *fsp,
515 struct streaminfo_state *state,
516 SMB_STRUCT_STAT *base_sbuf)
518 NTSTATUS status = NT_STATUS_OK;
519 bool opened_base_fd = false;
524 SMB_STRUCT_DIR *dirp = NULL;
525 SMB_STRUCT_DIRENT *dp = NULL;
526 files_struct fake_fs;
527 struct fd_handle fake_fh;
528 SMB_STRUCT_STAT stream_sbuf;
530 ZERO_STRUCT(fake_fh);
531 ZERO_STRUCT(fake_fs);
533 /* If the base file is already open, use its fd. */
534 if ((fsp != NULL) && (fsp->fh->fd != -1)) {
535 base_fd = fsp->fh->fd;
537 opened_base_fd = true;
540 dir_fd = get_stream_dir_fd(conn, fname, &base_fd);
542 return map_nt_error_from_unix(errno);
545 /* Open the ADS directory. */
546 if ((dirp = fdopendir(dir_fd)) == NULL) {
547 DEBUG(0, ("Error on opendir %s. errno=%d (%s)\n",
548 fname, errno, strerror(errno)));
549 status = map_nt_error_from_unix(errno);
553 /* Initialize the dir state struct and add it to the list.
554 * This is a layer violation, and really should be handled by a
555 * VFS_FDOPENDIR() call which would properly setup the dir state.
556 * But since this is all within the onefs.so module, we cheat for
557 * now and call directly into the readdirplus code.
558 * NOTE: This state MUST be freed by a proper VFS_CLOSEDIR() call. */
559 ret = onefs_rdp_add_dir_state(conn, dirp);
561 DEBUG(0, ("Error adding dir_state to the list\n"));
562 status = map_nt_error_from_unix(errno);
567 fake_fs.fh = &fake_fh;
568 fake_fs.fsp_name = SMB_STRDUP(fname);
570 /* Iterate over the streams in the ADS directory. */
571 while ((dp = SMB_VFS_READDIR(conn, dirp, NULL)) != NULL) {
572 /* Skip the "." and ".." entries */
573 if ((strcmp(dp->d_name, ".") == 0) ||
574 (strcmp(dp->d_name, "..") == 0))
577 /* Open actual stream */
578 if ((stream_fd = onefs_sys_create_file(conn,
592 DEBUG(0, ("Error opening stream %s:%s. "
593 "errno=%d (%s)\n", fname, dp->d_name, errno,
598 /* Figure out the stat info. */
599 fake_fh.fd = stream_fd;
600 ret = SMB_VFS_FSTAT(&fake_fs, &stream_sbuf);
604 DEBUG(0, ("Error fstating stream %s:%s. "
605 "errno=%d (%s)\n", fname, dp->d_name, errno,
610 merge_stat(&stream_sbuf, base_sbuf);
612 if (!add_one_stream(state->mem_ctx,
613 &state->num_streams, &state->streams,
614 dp->d_name, stream_sbuf.st_size,
615 SMB_VFS_GET_ALLOC_SIZE(conn, NULL,
617 state->status = NT_STATUS_NO_MEMORY;
623 /* Cleanup everything that was opened. */
625 SMB_VFS_CLOSEDIR(conn, dirp);
630 if (opened_base_fd) {
631 SMB_ASSERT(base_fd >= 0);
635 SAFE_FREE(fake_fs.fsp_name);
639 NTSTATUS onefs_streaminfo(vfs_handle_struct *handle,
640 struct files_struct *fsp,
643 unsigned int *num_streams,
644 struct stream_struct **streams)
646 SMB_STRUCT_STAT sbuf;
649 struct streaminfo_state state;
651 /* Get a valid stat. */
652 if ((fsp != NULL) && (fsp->fh->fd != -1)) {
653 if (is_ntfs_stream_name(fsp->fsp_name)) {
654 return NT_STATUS_INVALID_PARAMETER;
656 ret = SMB_VFS_FSTAT(fsp, &sbuf);
658 if (is_ntfs_stream_name(fname)) {
659 return NT_STATUS_INVALID_PARAMETER;
661 ret = SMB_VFS_STAT(handle->conn, fname, &sbuf);
665 return map_nt_error_from_unix(errno);
668 state.streams = NULL;
669 state.num_streams = 0;
671 /* Add the default stream. */
672 if (S_ISREG(sbuf.st_mode)) {
673 if (!add_one_stream(mem_ctx,
674 &state.num_streams, &state.streams,
676 SMB_VFS_GET_ALLOC_SIZE(handle->conn, fsp,
678 return NT_STATUS_NO_MEMORY;
682 state.mem_ctx = mem_ctx;
683 state.handle = handle;
684 state.status = NT_STATUS_OK;
686 /* If there are more streams, add them too. */
687 if (sbuf.st_flags & UF_HASADS) {
689 status = walk_onefs_streams(handle->conn, fsp, fname,
692 if (!NT_STATUS_IS_OK(status)) {
693 TALLOC_FREE(state.streams);
697 if (!NT_STATUS_IS_OK(state.status)) {
698 TALLOC_FREE(state.streams);
703 *num_streams = state.num_streams;
704 *streams = state.streams;