fs/smbsrv/smb_write.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#include <sys/sdt.h>
#include <smbsrv/smb_incl.h>
#include <smbsrv/smb_fsops.h>
#include <smbsrv/mbuf.h>
#include <smbsrv/netbios.h>


#define	SMB_WRMODE_WRITE_THRU	0x0001
#define	SMB_WRMODE_IS_STABLE(M)	((M) & SMB_WRMODE_WRITE_THRU)


typedef struct smb_write_param {
	struct vardata_block w_vdb;
	uint64_t w_offset;
	uint16_t w_mode;
	uint16_t w_count;
} smb_write_param_t;


int smb_write_common(struct smb_request *sr, smb_write_param_t *param);
int smb_write_truncate(struct smb_request *sr, smb_write_param_t *param);
int smb_set_file_size(struct smb_request *sr);


/*
 * Write count bytes at the specified offset in a file.  The offset is
 * limited to 32-bits.  If the count is zero, the file is truncated to
 * the length specified by the offset.
 *
 * The response count indicates the actual number of bytes written, which
 * will equal the requested count on success.  If request and response
 * counts differ but there is no error, the client will assume that the
 * server encountered a resource issue.
 */
int
smb_com_write(struct smb_request *sr)
{
	smb_write_param_t *param;
	uint32_t off;
	int rc;

	param = kmem_zalloc(sizeof (smb_write_param_t), KM_SLEEP);

	rc = smbsr_decode_vwv(sr, "wwl", &sr->smb_fid, &param->w_count, &off);
	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	sr->fid_ofile = smb_ofile_lookup_by_fid(sr->tid_tree, sr->smb_fid);
	if (sr->fid_ofile == NULL) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_cifs_error(sr, NT_STATUS_INVALID_HANDLE,
		    ERRDOS, ERRbadfid);
		/* NOTREACHED */
	}

	param->w_offset = (uint64_t)off;
	param->w_vdb.uio.uio_loffset = (offset_t)param->w_offset;

	if (param->w_count == 0) {
		rc = smb_write_truncate(sr, param);
	} else {
		rc = smbsr_decode_data(sr, "D", &param->w_vdb);

		if ((rc != 0) || (param->w_vdb.len != param->w_count)) {
			kmem_free(param, sizeof (smb_write_param_t));
			smbsr_decode_error(sr);
			/* NOTREACHED */
		}

		param->w_vdb.uio.uio_loffset = (offset_t)param->w_offset;

		rc = smb_write_common(sr, param);
	}

	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_errno(sr, rc);
		/* NOTREACHED */
	}

	smbsr_encode_result(sr, 1, 0, "bww", 1, param->w_count, 0);
	kmem_free(param, sizeof (smb_write_param_t));
	return (SDRC_NORMAL_REPLY);
}

/*
 * Write count bytes to a file and then close the file.  This function
 * can only be used to write to 32-bit offsets and the client must set
 * WordCount (6 or 12) correctly in order to locate the data to be
 * written.  If an error occurs on the write, the file should still be
 * closed.  If Count is 0, the file is truncated (or extended) to offset.
 *
 * If the last_write time is non-zero, last_write should be used to set
 * the mtime.  Otherwise the file system stamps the mtime.  Failure to
 * set mtime should not result in an error response.
 */
int
smb_com_write_and_close(struct smb_request *sr)
{
	smb_write_param_t *param;
	uint32_t last_write;
	uint32_t off;
	int rc = 0;

	param = kmem_zalloc(sizeof (smb_write_param_t), KM_SLEEP);

	if (sr->smb_wct == 12) {
		rc = smbsr_decode_vwv(sr, "wwll12.", &sr->smb_fid,
		    &param->w_count, &off, &last_write);
	} else {
		rc = smbsr_decode_vwv(sr, "wwll", &sr->smb_fid,
		    &param->w_count, &off, &last_write);
	}

	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	sr->fid_ofile = smb_ofile_lookup_by_fid(sr->tid_tree, sr->smb_fid);
	if (sr->fid_ofile == NULL) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_cifs_error(sr, NT_STATUS_INVALID_HANDLE,
		    ERRDOS, ERRbadfid);
		/* NOTREACHED */
	}

	param->w_offset = (uint64_t)off;

	if (param->w_count == 0) {
		rc = smb_write_truncate(sr, param);
	} else {
		/*
		 * There may be a bug here: should this be "3.#B"?
		 */
		rc = smbsr_decode_data(sr, ".#B", param->w_count,
		    &param->w_vdb);

		if ((rc != 0) || (param->w_vdb.len != param->w_count)) {
			kmem_free(param, sizeof (smb_write_param_t));
			smbsr_decode_error(sr);
			/* NOTREACHED */
		}

		param->w_vdb.uio.uio_loffset = (offset_t)param->w_offset;

		rc = smb_write_common(sr, param);
	}

	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_errno(sr, rc);
		/* NOTREACHED */
	}

	if ((rc = smb_common_close(sr, last_write)) != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_errno(sr, rc);
		/* NOTREACHED */
	}

	smbsr_encode_result(sr, 1, 0, "bww", 1, param->w_count, 0);
	kmem_free(param, sizeof (smb_write_param_t));
	return (SDRC_NORMAL_REPLY);
}

/*
 * Write count bytes to a file at the specified offset and then unlock
 * them.  Write behind is safe because the client should have the range
 * locked and this request is allowed to extend the file - note that
 * offest is limited to 32-bits.  It is an error for count to be zero.
 *
 * The SmbLockAndRead/SmbWriteAndUnlock sub-dialect is only valid on disk
 * files.  Reject any attempt to use it on other shares.
 *
 * The response count indicates the actual number of bytes written, which
 * will equal the requested count on success.  If request and response
 * counts differ but there is no error, the client will assume that the
 * server encountered a resource issue.
 */
int
smb_com_write_and_unlock(struct smb_request *sr)
{
	smb_write_param_t *param;
	uint32_t off;
	uint32_t result;
	uint16_t remcnt;
	int rc = 0;

	if (STYPE_ISDSK(sr->tid_tree->t_res_type) == 0) {
		smbsr_raise_error(sr, ERRDOS, ERRnoaccess);
		/* NOTREACHED */
	}

	param = kmem_zalloc(sizeof (smb_write_param_t), KM_SLEEP);

	rc = smbsr_decode_vwv(sr, "wwlw", &sr->smb_fid, &param->w_count, &off,
	    &remcnt);
	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	sr->fid_ofile = smb_ofile_lookup_by_fid(sr->tid_tree, sr->smb_fid);
	if (sr->fid_ofile == NULL) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_cifs_error(sr, NT_STATUS_INVALID_HANDLE,
		    ERRDOS, ERRbadfid);
		/* NOTREACHED */
	}

	if (param->w_count == 0) {
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	rc = smbsr_decode_data(sr, "D", &param->w_vdb);

	if ((rc != 0) || (param->w_count != param->w_vdb.len)) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	param->w_offset = (uint64_t)off;
	param->w_vdb.uio.uio_loffset = (offset_t)param->w_offset;

	if ((rc = smb_write_common(sr, param)) != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_errno(sr, rc);
		/* NOTREACHED */
	}

	result = smb_unlock_range(sr, sr->fid_ofile->f_node, param->w_offset,
	    (uint64_t)param->w_count);
	if (result != NT_STATUS_SUCCESS) {
		kmem_free(param, sizeof (smb_write_param_t));
		smb_unlock_range_raise_error(sr, result);
		/* NOTREACHED */
	}

	smbsr_encode_result(sr, 1, 0, "bww", 1, param->w_count, 0);
	kmem_free(param, sizeof (smb_write_param_t));
	return (SDRC_NORMAL_REPLY);
}

/*
 * Write bytes to a file (SMB Core).  This request was extended in
 * LM 0.12 to support 64-bit offsets, indicated by sending a wct of
 * 14, instead of 12, and including additional offset information.
 *
 * A ByteCount of 0 does not truncate the file - use SMB_COM_WRITE
 * to truncate a file.  A zero length merely transfers zero bytes.
 *
 * If bit 0 of WriteMode is set, Fid must refer to a disk file and
 * the data must be on stable storage before responding.
 */
int
smb_com_write_andx(struct smb_request *sr)
{
	smb_write_param_t *param;
	uint32_t off_low;
	uint32_t off_high;
	uint16_t data_offset;
	uint16_t remcnt;
	int rc = 0;

	param = kmem_zalloc(sizeof (smb_write_param_t), KM_SLEEP);

	if (sr->smb_wct == 14) {
		rc = smbsr_decode_vwv(sr, "4.wl4.ww2.wwl", &sr->smb_fid,
		    &off_low, &param->w_mode, &remcnt, &param->w_count,
		    &data_offset, &off_high);

		data_offset -= 63;
		param->w_offset = ((uint64_t)off_high << 32) | off_low;
	} else {
		rc = smbsr_decode_vwv(sr, "4.wl4.ww2.ww", &sr->smb_fid,
		    &off_low, &param->w_mode, &remcnt, &param->w_count,
		    &data_offset);

		param->w_offset = (uint64_t)off_low;
		data_offset -= 59;
	}

	if (rc != 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	sr->fid_ofile = smb_ofile_lookup_by_fid(sr->tid_tree, sr->smb_fid);
	if (sr->fid_ofile == NULL) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_cifs_error(sr, NT_STATUS_INVALID_HANDLE,
		    ERRDOS, ERRbadfid);
		/* NOTREACHED */
	}

	if (SMB_WRMODE_IS_STABLE(param->w_mode) &&
	    STYPE_ISDSK(sr->tid_tree->t_res_type) == 0) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_raise_error(sr, ERRSRV, ERRaccess);
		/* NOTREACHED */
	}

	rc = smbsr_decode_data(sr, "#.#B", data_offset, param->w_count,
	    &param->w_vdb);
	if ((rc != 0) || (param->w_vdb.len != param->w_count)) {
		kmem_free(param, sizeof (smb_write_param_t));
		smbsr_decode_error(sr);
		/* NOTREACHED */
	}

	param->w_vdb.uio.uio_loffset = (offset_t)param->w_offset;

	if (param->w_count != 0) {
		if ((rc = smb_write_common(sr, param)) != 0) {
			kmem_free(param, sizeof (smb_write_param_t));
			smbsr_raise_errno(sr, rc);
			/* NOTREACHED */
		}
	}

	smbsr_encode_result(sr, 6, 0, "bb1.ww6.w",
	    6, sr->andx_com, 15, param->w_count, 0);

	kmem_free(param, sizeof (smb_write_param_t));
	return (SDRC_NORMAL_REPLY);
}

/*
 * Common function for writing files or IPC/MSRPC named pipes.
 *
 * Returns errno values.
 */
int
smb_write_common(struct smb_request *sr, smb_write_param_t *param)
{
	struct smb_ofile *ofile = sr->fid_ofile;
	smb_node_t *node;
	uint32_t stability = FSSTAB_UNSTABLE;
	uint32_t lcount;
	int rc = 0;

	switch (sr->tid_tree->t_res_type & STYPE_MASK) {
	case STYPE_DISKTREE:
		node = ofile->f_node;

		if (node->attr.sa_vattr.va_type != VDIR) {
			rc = smb_lock_range_access(sr, node, param->w_offset,
			    param->w_count, FILE_WRITE_DATA);
			if (rc != NT_STATUS_SUCCESS) {
				smbsr_raise_cifs_error(sr, rc,
				    ERRSRV, ERRaccess);
				/* NOTREACHED */
			}
		}

		if (SMB_WRMODE_IS_STABLE(param->w_mode) ||
		    (node->flags & NODE_FLAGS_WRITE_THROUGH)) {
			stability = FSSTAB_FILE_SYNC;
		}

		rc = smb_fsop_write(sr, sr->user_cr, node,
		    &param->w_vdb.uio, &lcount, &node->attr, &stability);

		if (rc)
			return (rc);

		node->flags |= NODE_FLAGS_SYNCATIME;

		if (node->flags & NODE_FLAGS_SET_SIZE) {
			if ((param->w_offset + lcount) >= node->n_size) {
				node->flags &= ~NODE_FLAGS_SET_SIZE;
				node->n_size = param->w_offset + lcount;
			}
		}

		param->w_count = (uint16_t)lcount;
		break;

	case STYPE_IPC:
		param->w_count = (uint16_t)param->w_vdb.uio.uio_resid;

		if ((rc = smb_rpc_write(sr, &param->w_vdb.uio)) != 0)
			param->w_count = 0;
		break;

	default:
		rc = EACCES;
		break;
	}

	if (rc != 0)
		return (rc);

	mutex_enter(&ofile->f_mutex);
	ofile->f_seek_pos = param->w_offset + param->w_count;
	mutex_exit(&ofile->f_mutex);
	return (rc);
}

/*
 * Truncate a disk file to the specified offset.
 * Typically, w_count will be zero here.
 *
 * Returns errno values.
 */
int
smb_write_truncate(struct smb_request *sr, smb_write_param_t *param)
{
	struct smb_ofile *ofile = sr->fid_ofile;
	smb_node_t *node = ofile->f_node;
	int rc;

	if (STYPE_ISDSK(sr->tid_tree->t_res_type) == 0)
		return (0);

	if (node->attr.sa_vattr.va_type != VDIR) {
		rc = smb_lock_range_access(sr, node, param->w_offset,
		    param->w_count, FILE_WRITE_DATA);
		if (rc != NT_STATUS_SUCCESS) {
			smbsr_raise_cifs_error(sr, rc,
			    ERRSRV, ERRaccess);
			/* NOTREACHED */
		}
	}

	/*
	 * XXX what if the file has been opened only with
	 * FILE_APPEND_DATA?
	 */
	rc = smb_ofile_access(ofile, sr->user_cr, FILE_WRITE_DATA);
	if (rc != NT_STATUS_SUCCESS) {
		smbsr_raise_cifs_error(sr, NT_STATUS_ACCESS_DENIED,
		    ERRDOS, ERROR_ACCESS_DENIED);
		/* NOTREACHED */
	}

	node->flags |= NODE_FLAGS_SET_SIZE;
	node->n_size = param->w_offset;

	if ((rc = smb_set_file_size(sr)) != 0)
		return (rc);

	mutex_enter(&ofile->f_mutex);
	ofile->f_seek_pos = param->w_offset + param->w_count;
	mutex_exit(&ofile->f_mutex);
	return (0);
}

/*
 * Set the file size using the value in the node. The file will only be
 * updated if NODE_FLAGS_SET_SIZE is set.  It is safe to pass a null node
 * pointer, we just return success.
 *
 * The node attributes are refreshed here from the file system. So any
 * attributes that are affected by file size changes, i.e. the mtime,
 * will be current.
 *
 * Note that smb_write_andx cannot be used to reduce the file size so,
 * if this is required, smb_write is called with a count of zero and
 * the appropriate file length in offset. The file should be resized
 * to the length specified by the offset.
 *
 * Returns 0 on success. Otherwise returns EACCES.
 */
int
smb_set_file_size(struct smb_request *sr)
{
	struct smb_node *node;
	smb_attr_t new_attr;
	uint32_t dosattr;

	if ((node = sr->fid_ofile->f_node) == 0)
		return (0);

	if ((node->flags & NODE_FLAGS_SET_SIZE) == 0)
		return (0);

	node->flags &= ~NODE_FLAGS_SET_SIZE;

	dosattr = smb_node_get_dosattr(node);

	if (dosattr & SMB_FA_READONLY) {
		if (((node->flags & NODE_FLAGS_CREATED) == 0) ||
		    (sr->session->s_kid != node->n_orig_session_id))
			return (EACCES);
	}

	bzero(&new_attr, sizeof (new_attr));
	new_attr.sa_vattr.va_size = node->n_size;
	new_attr.sa_mask = SMB_AT_SIZE;

	(void) smb_fsop_setattr(sr, sr->user_cr, node, &new_attr,
	    &node->attr);

	return (0);
}

/*
 * write_complete is sent acknowledge completion of raw write requests.
 * We never send raw write commands to other servers so, if we receive a
 * write_complete, we treat it as an error.
 */
int
smb_com_write_complete(struct smb_request *sr)
{
	smbsr_decode_error(sr);
	/* NOT REACHED */
	return (0);
}

/*
 * The Write Block Multiplexed protocol is used to maximize performance
 * when writing a large block of data.
 *
 * The mpx sub protocol is not supported because we support only
 * connection oriented transports and NT supports SMB_COM_READ_MPX
 * only over connectionless transports.
 */
int /*ARGSUSED*/
smb_com_write_mpx(struct smb_request *sr)
{
	return (SDRC_UNIMPLEMENTED);
}

int /*ARGSUSED*/
smb_com_write_mpx_secondary(struct smb_request *sr)
{
	return (SDRC_UNIMPLEMENTED);
}