4 * vfs operations that deal with io control
6 * Copyright (C) International Business Machines Corp., 2005,2013
7 * Author(s): Steve French (sfrench@us.ibm.com)
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library 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
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/file.h>
26 #include <linux/mount.h>
28 #include <linux/pagemap.h>
31 #include "cifsproto.h"
32 #include "cifs_debug.h"
34 #include "cifs_ioctl.h"
35 #include "smb2proto.h"
36 #include <linux/btrfs.h>
38 static long cifs_ioctl_query_info(unsigned int xid, struct file *filep,
41 struct inode *inode = file_inode(filep);
42 struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
43 struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
44 struct dentry *dentry = filep->f_path.dentry;
45 const unsigned char *path;
46 void *page = alloc_dentry_path();
47 __le16 *utf16_path = NULL, root_path;
50 path = build_path_from_dentry(dentry, page);
52 free_dentry_path(page);
56 cifs_dbg(FYI, "%s %s\n", __func__, path);
60 utf16_path = &root_path;
62 utf16_path = cifs_convert_path_to_utf16(path + 1, cifs_sb);
69 if (tcon->ses->server->ops->ioctl_query_info)
70 rc = tcon->ses->server->ops->ioctl_query_info(
71 xid, tcon, cifs_sb, utf16_path,
72 filep->private_data ? 0 : 1, p);
77 if (utf16_path != &root_path)
79 free_dentry_path(page);
83 static long cifs_ioctl_copychunk(unsigned int xid, struct file *dst_file,
88 struct inode *src_inode;
90 cifs_dbg(FYI, "ioctl copychunk range\n");
91 /* the destination must be opened for writing */
92 if (!(dst_file->f_mode & FMODE_WRITE)) {
93 cifs_dbg(FYI, "file target not open for write\n");
97 /* check if target volume is readonly and take reference */
98 rc = mnt_want_write_file(dst_file);
100 cifs_dbg(FYI, "mnt_want_write failed with rc %d\n", rc);
104 src_file = fdget(srcfd);
105 if (!src_file.file) {
110 if (src_file.file->f_op->unlocked_ioctl != cifs_ioctl) {
112 cifs_dbg(VFS, "src file seems to be from a different filesystem type\n");
116 src_inode = file_inode(src_file.file);
118 if (S_ISDIR(src_inode->i_mode))
121 rc = cifs_file_copychunk_range(xid, src_file.file, 0, dst_file, 0,
122 src_inode->i_size, 0);
128 mnt_drop_write_file(dst_file);
132 static long smb_mnt_get_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
136 struct smb_mnt_fs_info *fsinf;
138 fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
143 fsinf->protocol_id = tcon->ses->server->vals->protocol_id;
144 fsinf->device_characteristics =
145 le32_to_cpu(tcon->fsDevInfo.DeviceCharacteristics);
146 fsinf->device_type = le32_to_cpu(tcon->fsDevInfo.DeviceType);
147 fsinf->fs_attributes = le32_to_cpu(tcon->fsAttrInfo.Attributes);
148 fsinf->max_path_component =
149 le32_to_cpu(tcon->fsAttrInfo.MaxPathNameComponentLength);
150 fsinf->vol_serial_number = tcon->vol_serial_number;
151 fsinf->vol_create_time = le64_to_cpu(tcon->vol_create_time);
152 fsinf->share_flags = tcon->share_flags;
153 fsinf->share_caps = le32_to_cpu(tcon->capabilities);
154 fsinf->sector_flags = tcon->ss_flags;
155 fsinf->optimal_sector_size = tcon->perf_sector_size;
156 fsinf->max_bytes_chunk = tcon->max_bytes_chunk;
157 fsinf->maximal_access = tcon->maximal_access;
158 fsinf->cifs_posix_caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
160 if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
167 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
169 struct cifs_sb_info *sbi = CIFS_SB(sb);
172 if (!capable(CAP_SYS_ADMIN))
175 if (get_user(flags, (__u32 __user *)arg))
178 if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
181 if (cifs_forced_shutdown(sbi))
184 cifs_dbg(VFS, "shut down requested (%d)", flags);
185 /* trace_cifs_shutdown(sb, flags);*/
189 * https://man7.org/linux/man-pages/man2/ioctl_xfs_goingdown.2.html
190 * for more information and description of original intent of the flags
194 * We could add support later for default flag which requires:
195 * "Flush all dirty data and metadata to disk"
196 * would need to call syncfs or equivalent to flush page cache for
197 * the mount and then issue fsync to server (if nostrictsync not set)
199 case CIFS_GOING_FLAGS_DEFAULT:
200 cifs_dbg(FYI, "shutdown with default flag not supported\n");
203 * FLAGS_LOGFLUSH is easy since it asks to write out metadata (not
204 * data) but metadata writes are not cached on the client, so can treat
205 * it similarly to NOLOGFLUSH
207 case CIFS_GOING_FLAGS_LOGFLUSH:
208 case CIFS_GOING_FLAGS_NOLOGFLUSH:
209 sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
217 static int cifs_dump_full_key(struct cifs_tcon *tcon, unsigned long arg)
219 struct smb3_full_key_debug_info pfull_key_inf;
221 struct list_head *tmp;
222 struct cifs_ses *ses;
225 if (!smb3_encryption_required(tcon))
228 ses = tcon->ses; /* default to user id for current user */
229 if (get_user(suid, (__u64 __user *)arg))
232 /* search to see if there is a session with a matching SMB UID */
233 spin_lock(&cifs_tcp_ses_lock);
234 list_for_each(tmp, &tcon->ses->server->smb_ses_list) {
235 ses = list_entry(tmp, struct cifs_ses, smb_ses_list);
236 if (ses->Suid == suid) {
241 spin_unlock(&cifs_tcp_ses_lock);
244 } /* else uses default user's SMB UID (ie current user) */
246 pfull_key_inf.cipher_type = le16_to_cpu(ses->server->cipher_type);
247 pfull_key_inf.Suid = ses->Suid;
248 memcpy(pfull_key_inf.auth_key, ses->auth_key.response,
249 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
250 memcpy(pfull_key_inf.smb3decryptionkey, ses->smb3decryptionkey,
251 32 /* SMB3_ENC_DEC_KEY_SIZE */);
252 memcpy(pfull_key_inf.smb3encryptionkey,
253 ses->smb3encryptionkey, 32 /* SMB3_ENC_DEC_KEY_SIZE */);
254 if (copy_to_user((void __user *)arg, &pfull_key_inf,
255 sizeof(struct smb3_full_key_debug_info)))
261 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
263 struct inode *inode = file_inode(filep);
264 struct smb3_key_debug_info pkey_inf;
265 int rc = -ENOTTY; /* strange error - but the precedent */
267 struct cifsFileInfo *pSMBFile = filep->private_data;
268 struct cifs_tcon *tcon;
269 struct tcon_link *tlink;
270 struct cifs_sb_info *cifs_sb;
271 __u64 ExtAttrBits = 0;
276 cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
278 case FS_IOC_GETFLAGS:
279 if (pSMBFile == NULL)
281 tcon = tlink_tcon(pSMBFile->tlink);
282 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
283 #ifdef CONFIG_CIFS_POSIX
284 if (CIFS_UNIX_EXTATTR_CAP & caps) {
285 __u64 ExtAttrMask = 0;
286 rc = CIFSGetExtAttr(xid, tcon,
287 pSMBFile->fid.netfid,
288 &ExtAttrBits, &ExtAttrMask);
290 rc = put_user(ExtAttrBits &
293 if (rc != EOPNOTSUPP)
296 #endif /* CONFIG_CIFS_POSIX */
298 if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
299 /* add in the compressed bit */
300 ExtAttrBits = FS_COMPR_FL;
301 rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
305 case FS_IOC_SETFLAGS:
306 if (pSMBFile == NULL)
308 tcon = tlink_tcon(pSMBFile->tlink);
309 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
311 if (get_user(ExtAttrBits, (int __user *)arg)) {
317 * if (CIFS_UNIX_EXTATTR_CAP & caps)
318 * rc = CIFSSetExtAttr(xid, tcon,
319 * pSMBFile->fid.netfid,
322 * if (rc != EOPNOTSUPP)
326 /* Currently only flag we can set is compressed flag */
327 if ((ExtAttrBits & FS_COMPR_FL) == 0)
330 /* Try to set compress flag */
331 if (tcon->ses->server->ops->set_compression) {
332 rc = tcon->ses->server->ops->set_compression(
333 xid, tcon, pSMBFile);
334 cifs_dbg(FYI, "set compress flag rc %d\n", rc);
337 case CIFS_IOC_COPYCHUNK_FILE:
338 rc = cifs_ioctl_copychunk(xid, filep, arg);
340 case CIFS_QUERY_INFO:
341 rc = cifs_ioctl_query_info(xid, filep, arg);
343 case CIFS_IOC_SET_INTEGRITY:
344 if (pSMBFile == NULL)
346 tcon = tlink_tcon(pSMBFile->tlink);
347 if (tcon->ses->server->ops->set_integrity)
348 rc = tcon->ses->server->ops->set_integrity(xid,
353 case CIFS_IOC_GET_MNT_INFO:
354 if (pSMBFile == NULL)
356 tcon = tlink_tcon(pSMBFile->tlink);
357 rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
359 case CIFS_ENUMERATE_SNAPSHOTS:
360 if (pSMBFile == NULL)
366 tcon = tlink_tcon(pSMBFile->tlink);
367 if (tcon->ses->server->ops->enum_snapshots)
368 rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
369 pSMBFile, (void __user *)arg);
374 if (pSMBFile == NULL)
376 if (!capable(CAP_SYS_ADMIN)) {
381 tcon = tlink_tcon(pSMBFile->tlink);
382 if (!smb3_encryption_required(tcon)) {
386 pkey_inf.cipher_type =
387 le16_to_cpu(tcon->ses->server->cipher_type);
388 pkey_inf.Suid = tcon->ses->Suid;
389 memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
390 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
391 memcpy(pkey_inf.smb3decryptionkey,
392 tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
393 memcpy(pkey_inf.smb3encryptionkey,
394 tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
395 if (copy_to_user((void __user *)arg, &pkey_inf,
396 sizeof(struct smb3_key_debug_info)))
402 * Dump full key (32 bytes instead of 16 bytes) is
403 * needed if GCM256 (stronger encryption) negotiated
405 case CIFS_DUMP_FULL_KEY:
406 if (pSMBFile == NULL)
408 if (!capable(CAP_SYS_ADMIN)) {
412 tcon = tlink_tcon(pSMBFile->tlink);
413 rc = cifs_dump_full_key(tcon, arg);
416 case CIFS_IOC_NOTIFY:
417 if (!S_ISDIR(inode->i_mode)) {
418 /* Notify can only be done on directories */
422 cifs_sb = CIFS_SB(inode->i_sb);
423 tlink = cifs_sb_tlink(cifs_sb);
428 tcon = tlink_tcon(tlink);
429 if (tcon && tcon->ses->server->ops->notify) {
430 rc = tcon->ses->server->ops->notify(xid,
431 filep, (void __user *)arg);
432 cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
435 cifs_put_tlink(tlink);
437 case CIFS_IOC_SHUTDOWN:
438 rc = cifs_shutdown(inode->i_sb, arg);
441 cifs_dbg(FYI, "unsupported ioctl\n");