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>
28 NTSTATUS onefs_stream_prep_smb_fname(TALLOC_CTX *ctx,
29 const struct smb_filename *smb_fname_in,
30 struct smb_filename **smb_fname_out)
32 char *stream_name = NULL;
36 * Only attempt to strip off the trailing :$DATA if there is an actual
37 * stream there. If it is the default stream, the smb_fname_out will
38 * just have a NULL stream so the base file is opened.
40 if (smb_fname_in->stream_name &&
41 !is_ntfs_default_stream_smb_fname(smb_fname_in)) {
42 char *str_tmp = smb_fname_in->stream_name;
44 /* First strip off the leading ':' */
45 if (str_tmp[0] == ':') {
49 /* Create a new copy of the stream_name. */
50 stream_name = talloc_strdup(ctx, str_tmp);
51 if (stream_name == NULL) {
52 return NT_STATUS_NO_MEMORY;
55 /* Strip off the :$DATA if one exists. */
56 str_tmp = strrchr_m(stream_name, ':');
58 if (StrCaseCmp(str_tmp, ":$DATA") != 0) {
59 return NT_STATUS_INVALID_PARAMETER;
66 * If there was a stream that wasn't the default stream the leading
67 * colon and trailing :$DATA has now been stripped off. Create a new
68 * smb_filename to pass back.
70 status = create_synthetic_smb_fname(ctx, smb_fname_in->base_name,
71 stream_name, &smb_fname_in->st,
73 TALLOC_FREE(stream_name);
75 if (!NT_STATUS_IS_OK(status)) {
76 DEBUG(5, ("Failed to prep stream name for %s: %s\n",
78 smb_fname_str_dbg(*smb_fname_out) : "NULL",
84 int onefs_close(vfs_handle_struct *handle, struct files_struct *fsp)
89 ret = SMB_VFS_NEXT_CLOSE(handle, fsp->base_fsp);
91 ret2 = SMB_VFS_NEXT_CLOSE(handle, fsp);
93 return ret ? ret : ret2;
97 * Get the ADS directory fd for a file.
99 static int get_stream_dir_fd(connection_struct *conn, const char *base,
106 DEBUG(10, ("Getting stream directory fd: %s (%d)\n", base,
107 base_fdp ? *base_fdp : -1));
109 /* If a valid base_fdp was given, use it. */
110 if (base_fdp && *base_fdp >= 0) {
113 base_fd = onefs_sys_create_file(conn,
128 DEBUG(5, ("Failed getting base fd: %s\n",
134 /* Open the ADS directory. */
135 dir_fd = onefs_sys_create_file(conn,
150 /* Close base_fd if it's not need or on error. */
151 if (!base_fdp || dir_fd < 0) {
157 /* Set the out base_fdp if successful and it was requested. */
158 if (base_fdp && dir_fd >= 0) {
163 DEBUG(5, ("Failed getting stream directory fd: %s\n",
170 int onefs_rename(vfs_handle_struct *handle,
171 const struct smb_filename *smb_fname_src,
172 const struct smb_filename *smb_fname_dst)
174 struct smb_filename *smb_fname_src_onefs = NULL;
175 struct smb_filename *smb_fname_dst_onefs = NULL;
181 START_PROFILE(syscall_rename_at);
183 if (!is_ntfs_stream_smb_fname(smb_fname_src) &&
184 !is_ntfs_stream_smb_fname(smb_fname_dst)) {
185 ret = SMB_VFS_NEXT_RENAME(handle, smb_fname_src,
190 /* For now don't allow renames from or to the default stream. */
191 if (is_ntfs_default_stream_smb_fname(smb_fname_src) ||
192 is_ntfs_default_stream_smb_fname(smb_fname_dst)) {
193 DEBUG(3, ("Unable to rename to/from a default stream: %s -> "
194 "%s\n", smb_fname_str_dbg(smb_fname_src),
195 smb_fname_str_dbg(smb_fname_dst)));
200 /* prep stream smb_filename structs. */
201 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname_src,
202 &smb_fname_src_onefs);
203 if (!NT_STATUS_IS_OK(status)) {
204 errno = map_errno_from_nt_status(status);
207 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname_dst,
208 &smb_fname_dst_onefs);
209 if (!NT_STATUS_IS_OK(status)) {
210 errno = map_errno_from_nt_status(status);
214 dir_fd = get_stream_dir_fd(handle->conn, smb_fname_src->base_name,
220 DEBUG(8, ("onefs_rename called for %s => %s\n",
221 smb_fname_str_dbg(smb_fname_src_onefs),
222 smb_fname_str_dbg(smb_fname_dst_onefs)));
224 /* Handle rename of stream to default stream specially. */
225 if (smb_fname_dst_onefs->stream_name == NULL) {
226 ret = enc_renameat(dir_fd, smb_fname_src_onefs->stream_name,
227 ENC_DEFAULT, AT_FDCWD,
228 smb_fname_dst_onefs->base_name,
231 ret = enc_renameat(dir_fd, smb_fname_src_onefs->stream_name,
233 smb_fname_dst_onefs->stream_name,
238 END_PROFILE(syscall_rename_at);
239 TALLOC_FREE(smb_fname_src_onefs);
240 TALLOC_FREE(smb_fname_dst_onefs);
251 * Merge a base file's sbuf into the a streams's sbuf.
253 static void merge_stat(SMB_STRUCT_STAT *stream_sbuf,
254 const SMB_STRUCT_STAT *base_sbuf)
256 int dos_flags = (UF_DOS_NOINDEX | UF_DOS_ARCHIVE |
257 UF_DOS_HIDDEN | UF_DOS_RO | UF_DOS_SYSTEM);
258 stream_sbuf->st_ex_mtime = base_sbuf->st_ex_mtime;
259 stream_sbuf->st_ex_ctime = base_sbuf->st_ex_ctime;
260 stream_sbuf->st_ex_atime = base_sbuf->st_ex_atime;
261 stream_sbuf->st_ex_flags &= ~dos_flags;
262 stream_sbuf->st_ex_flags |= base_sbuf->st_ex_flags & dos_flags;
265 /* fake timestamps */
266 static void onefs_adjust_stat_time(struct connection_struct *conn,
267 const char *fname, SMB_STRUCT_STAT *sbuf)
269 struct onefs_vfs_share_config cfg;
270 struct timeval tv_now = {0, 0};
271 bool static_mtime = False;
272 bool static_atime = False;
274 if (!onefs_get_config(SNUM(conn),
275 ONEFS_VFS_CONFIG_FAKETIMESTAMPS, &cfg)) {
279 if (IS_MTIME_STATIC_PATH(conn, &cfg, fname)) {
280 sbuf->st_ex_mtime = sbuf->st_ex_btime;
283 if (IS_ATIME_STATIC_PATH(conn, &cfg, fname)) {
284 sbuf->st_ex_atime = sbuf->st_ex_btime;
288 if (IS_CTIME_NOW_PATH(conn, &cfg, fname)) {
289 if (cfg.ctime_slop < 0) {
290 sbuf->st_ex_btime.tv_sec = INT_MAX - 1;
292 GetTimeOfDay(&tv_now);
293 sbuf->st_ex_btime.tv_sec = tv_now.tv_sec +
298 if (!static_mtime && IS_MTIME_NOW_PATH(conn,&cfg,fname)) {
299 if (cfg.mtime_slop < 0) {
300 sbuf->st_ex_mtime.tv_sec = INT_MAX - 1;
302 if (tv_now.tv_sec == 0)
303 GetTimeOfDay(&tv_now);
304 sbuf->st_ex_mtime.tv_sec = tv_now.tv_sec +
308 if (!static_atime && IS_ATIME_NOW_PATH(conn,&cfg,fname)) {
309 if (cfg.atime_slop < 0) {
310 sbuf->st_ex_atime.tv_sec = INT_MAX - 1;
312 if (tv_now.tv_sec == 0)
313 GetTimeOfDay(&tv_now);
314 sbuf->st_ex_atime.tv_sec = tv_now.tv_sec +
320 static int stat_stream(struct connection_struct *conn, const char *base,
321 const char *stream, SMB_STRUCT_STAT *sbuf, int flags)
323 SMB_STRUCT_STAT base_sbuf;
324 int base_fd = -1, dir_fd, ret, saved_errno;
326 dir_fd = get_stream_dir_fd(conn, base, &base_fd);
331 /* Stat the stream. */
332 ret = onefs_sys_fstat_at(dir_fd, stream, sbuf, flags);
334 DEBUG(10, ("stat of stream '%s' failed: %s\n", stream,
337 /* Now stat the base file and merge the results. */
338 ret = onefs_sys_fstat(base_fd, &base_sbuf);
340 merge_stat(sbuf, &base_sbuf);
351 int onefs_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
353 struct smb_filename *smb_fname_onefs = NULL;
357 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname,
359 if (!NT_STATUS_IS_OK(status)) {
360 errno = map_errno_from_nt_status(status);
365 * If the smb_fname has no stream or is :$DATA, then just stat the
366 * base stream. Otherwise stat the stream.
368 if (!is_ntfs_stream_smb_fname(smb_fname_onefs)) {
369 ret = onefs_sys_stat(smb_fname_onefs->base_name,
372 ret = stat_stream(handle->conn, smb_fname_onefs->base_name,
373 smb_fname_onefs->stream_name, &smb_fname->st,
377 onefs_adjust_stat_time(handle->conn, smb_fname->base_name,
380 TALLOC_FREE(smb_fname_onefs);
385 int onefs_fstat(vfs_handle_struct *handle, struct files_struct *fsp,
386 SMB_STRUCT_STAT *sbuf)
388 SMB_STRUCT_STAT base_sbuf;
391 /* Stat the stream, by calling next_fstat on the stream's fd. */
392 ret = onefs_sys_fstat(fsp->fh->fd, sbuf);
397 /* Stat the base file and merge the results. */
398 if (fsp != NULL && fsp->base_fsp != NULL) {
399 ret = onefs_sys_fstat(fsp->base_fsp->fh->fd, &base_sbuf);
401 merge_stat(sbuf, &base_sbuf);
405 onefs_adjust_stat_time(handle->conn, fsp->fsp_name->base_name, sbuf);
409 int onefs_lstat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
411 struct smb_filename *smb_fname_onefs = NULL;
415 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname,
417 if (!NT_STATUS_IS_OK(status)) {
418 errno = map_errno_from_nt_status(status);
423 * If the smb_fname has no stream or is :$DATA, then just stat the
424 * base stream. Otherwise stat the stream.
426 if (!is_ntfs_stream_smb_fname(smb_fname_onefs)) {
427 ret = onefs_sys_lstat(smb_fname_onefs->base_name,
430 ret = stat_stream(handle->conn, smb_fname_onefs->base_name,
431 smb_fname_onefs->stream_name, &smb_fname->st,
432 AT_SYMLINK_NOFOLLOW);
435 onefs_adjust_stat_time(handle->conn, smb_fname->base_name,
438 TALLOC_FREE(smb_fname_onefs);
443 int onefs_unlink(vfs_handle_struct *handle,
444 const struct smb_filename *smb_fname)
446 struct smb_filename *smb_fname_onefs = NULL;
448 int dir_fd, saved_errno;
452 if (!is_ntfs_stream_smb_fname(smb_fname)) {
453 return SMB_VFS_NEXT_UNLINK(handle, smb_fname);
456 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname,
458 if (!NT_STATUS_IS_OK(status)) {
459 errno = map_errno_from_nt_status(status);
463 /* Default stream (the ::$DATA was just stripped off). */
464 if (!is_ntfs_stream_smb_fname(smb_fname_onefs)) {
465 ret = SMB_VFS_NEXT_UNLINK(handle, smb_fname_onefs);
469 dir_fd = get_stream_dir_fd(handle->conn, smb_fname_onefs->base_name,
476 ret = enc_unlinkat(dir_fd, smb_fname_onefs->stream_name, ENC_DEFAULT,
483 TALLOC_FREE(smb_fname_onefs);
487 int onefs_vtimes_streams(vfs_handle_struct *handle,
488 const struct smb_filename *smb_fname,
489 int flags, struct timespec times[3])
491 struct smb_filename *smb_fname_onefs = NULL;
497 START_PROFILE(syscall_ntimes);
499 if (!is_ntfs_stream_smb_fname(smb_fname)) {
500 ret = vtimes(smb_fname->base_name, times, flags);
504 status = onefs_stream_prep_smb_fname(talloc_tos(), smb_fname,
506 if (!NT_STATUS_IS_OK(status)) {
507 errno = map_errno_from_nt_status(status);
511 /* Default stream (the ::$DATA was just stripped off). */
512 if (!is_ntfs_stream_smb_fname(smb_fname_onefs)) {
513 ret = vtimes(smb_fname_onefs->base_name, times, flags);
517 dirfd = get_stream_dir_fd(handle->conn, smb_fname->base_name, NULL);
523 ret = enc_vtimesat(dirfd, smb_fname_onefs->stream_name, ENC_DEFAULT,
531 END_PROFILE(syscall_ntimes);
532 TALLOC_FREE(smb_fname_onefs);
537 * Streaminfo enumeration functionality
539 struct streaminfo_state {
541 vfs_handle_struct *handle;
542 unsigned int num_streams;
543 struct stream_struct *streams;
547 static bool add_one_stream(TALLOC_CTX *mem_ctx, unsigned int *num_streams,
548 struct stream_struct **streams,
549 const char *name, SMB_OFF_T size,
550 SMB_OFF_T alloc_size)
552 struct stream_struct *tmp;
554 tmp = TALLOC_REALLOC_ARRAY(mem_ctx, *streams, struct stream_struct,
560 tmp[*num_streams].name = talloc_asprintf(mem_ctx, ":%s:%s", name,
562 if (tmp[*num_streams].name == NULL) {
566 tmp[*num_streams].size = size;
567 tmp[*num_streams].alloc_size = alloc_size;
574 static NTSTATUS walk_onefs_streams(connection_struct *conn, files_struct *fsp,
576 struct streaminfo_state *state,
577 SMB_STRUCT_STAT *base_sbuf)
579 NTSTATUS status = NT_STATUS_OK;
580 bool opened_base_fd = false;
585 SMB_STRUCT_DIR *dirp = NULL;
586 SMB_STRUCT_DIRENT *dp = NULL;
587 files_struct fake_fs;
588 struct fd_handle fake_fh;
589 SMB_STRUCT_STAT stream_sbuf;
591 ZERO_STRUCT(fake_fh);
592 ZERO_STRUCT(fake_fs);
594 /* If the base file is already open, use its fd. */
595 if ((fsp != NULL) && (fsp->fh->fd != -1)) {
596 base_fd = fsp->fh->fd;
598 opened_base_fd = true;
601 dir_fd = get_stream_dir_fd(conn, fname, &base_fd);
603 return map_nt_error_from_unix(errno);
606 /* Open the ADS directory. */
607 if ((dirp = fdopendir(dir_fd)) == NULL) {
608 DEBUG(0, ("Error on opendir %s. errno=%d (%s)\n",
609 fname, errno, strerror(errno)));
610 status = map_nt_error_from_unix(errno);
614 /* Initialize the dir state struct and add it to the list.
615 * This is a layer violation, and really should be handled by a
616 * VFS_FDOPENDIR() call which would properly setup the dir state.
617 * But since this is all within the onefs.so module, we cheat for
618 * now and call directly into the readdirplus code.
619 * NOTE: This state MUST be freed by a proper VFS_CLOSEDIR() call. */
620 ret = onefs_rdp_add_dir_state(conn, dirp);
622 DEBUG(0, ("Error adding dir_state to the list\n"));
623 status = map_nt_error_from_unix(errno);
628 fake_fs.fh = &fake_fh;
629 status = create_synthetic_smb_fname(talloc_tos(), fname, NULL, NULL,
631 if (!NT_STATUS_IS_OK(status)) {
635 /* Iterate over the streams in the ADS directory. */
636 while ((dp = SMB_VFS_READDIR(conn, dirp, NULL)) != NULL) {
637 /* Skip the "." and ".." entries */
638 if ((strcmp(dp->d_name, ".") == 0) ||
639 (strcmp(dp->d_name, "..") == 0))
642 /* Open actual stream */
643 if ((stream_fd = onefs_sys_create_file(conn,
657 DEBUG(0, ("Error opening stream %s:%s. "
658 "errno=%d (%s)\n", fname, dp->d_name, errno,
663 /* Figure out the stat info. */
664 fake_fh.fd = stream_fd;
665 ret = SMB_VFS_FSTAT(&fake_fs, &stream_sbuf);
669 DEBUG(0, ("Error fstating stream %s:%s. "
670 "errno=%d (%s)\n", fname, dp->d_name, errno,
675 merge_stat(&stream_sbuf, base_sbuf);
677 if (!add_one_stream(state->mem_ctx,
678 &state->num_streams, &state->streams,
679 dp->d_name, stream_sbuf.st_ex_size,
680 SMB_VFS_GET_ALLOC_SIZE(conn, NULL,
682 state->status = NT_STATUS_NO_MEMORY;
688 /* Cleanup everything that was opened. */
690 SMB_VFS_CLOSEDIR(conn, dirp);
695 if (opened_base_fd) {
696 SMB_ASSERT(base_fd >= 0);
700 TALLOC_FREE(fake_fs.fsp_name);
704 NTSTATUS onefs_streaminfo(vfs_handle_struct *handle,
705 struct files_struct *fsp,
708 unsigned int *num_streams,
709 struct stream_struct **streams)
711 SMB_STRUCT_STAT sbuf;
714 struct streaminfo_state state;
716 /* Get a valid stat. */
717 if ((fsp != NULL) && (fsp->fh->fd != -1)) {
718 ret = SMB_VFS_FSTAT(fsp, &sbuf);
720 struct smb_filename *smb_fname = NULL;
722 status = create_synthetic_smb_fname(talloc_tos(), fname, NULL,
724 if (!NT_STATUS_IS_OK(status)) {
727 ret = SMB_VFS_STAT(handle->conn, smb_fname);
729 sbuf = smb_fname->st;
731 TALLOC_FREE(smb_fname);
735 return map_nt_error_from_unix(errno);
738 state.streams = NULL;
739 state.num_streams = 0;
741 if (lp_parm_bool(SNUM(handle->conn), PARM_ONEFS_TYPE,
742 PARM_IGNORE_STREAMS, PARM_IGNORE_STREAMS_DEFAULT)) {
746 /* Add the default stream. */
747 if (S_ISREG(sbuf.st_ex_mode)) {
748 if (!add_one_stream(mem_ctx,
749 &state.num_streams, &state.streams,
751 SMB_VFS_GET_ALLOC_SIZE(handle->conn, fsp,
753 return NT_STATUS_NO_MEMORY;
757 state.mem_ctx = mem_ctx;
758 state.handle = handle;
759 state.status = NT_STATUS_OK;
761 /* If there are more streams, add them too. */
762 if (sbuf.st_ex_flags & UF_HASADS) {
764 status = walk_onefs_streams(handle->conn, fsp, fname,
767 if (!NT_STATUS_IS_OK(status)) {
768 TALLOC_FREE(state.streams);
772 if (!NT_STATUS_IS_OK(state.status)) {
773 TALLOC_FREE(state.streams);
778 *num_streams = state.num_streams;
779 *streams = state.streams;