Merge tag 'linux-kselftest-4.15-rc1' of git://git.kernel.org/pub/scm/linux/kernel...
[linux/fpc-iii.git] / fs / ubifs / xattr.c
blob5ddc89d564fd4827f3d95beb6e4ce64d8fe963c3
1 /*
2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Artem Bityutskiy (Битюцкий Артём)
20 * Adrian Hunter
24 * This file implements UBIFS extended attributes support.
26 * Extended attributes are implemented as regular inodes with attached data,
27 * which limits extended attribute size to UBIFS block size (4KiB). Names of
28 * extended attributes are described by extended attribute entries (xentries),
29 * which are almost identical to directory entries, but have different key type.
31 * In other words, the situation with extended attributes is very similar to
32 * directories. Indeed, any inode (but of course not xattr inodes) may have a
33 * number of associated xentries, just like directory inodes have associated
34 * directory entries. Extended attribute entries store the name of the extended
35 * attribute, the host inode number, and the extended attribute inode number.
36 * Similarly, direntries store the name, the parent and the target inode
37 * numbers. Thus, most of the common UBIFS mechanisms may be re-used for
38 * extended attributes.
40 * The number of extended attributes is not limited, but there is Linux
41 * limitation on the maximum possible size of the list of all extended
42 * attributes associated with an inode (%XATTR_LIST_MAX), so UBIFS makes sure
43 * the sum of all extended attribute names of the inode does not exceed that
44 * limit.
46 * Extended attributes are synchronous, which means they are written to the
47 * flash media synchronously and there is no write-back for extended attribute
48 * inodes. The extended attribute values are not stored in compressed form on
49 * the media.
51 * Since extended attributes are represented by regular inodes, they are cached
52 * in the VFS inode cache. The xentries are cached in the LNC cache (see
53 * tnc.c).
55 * ACL support is not implemented.
58 #include "ubifs.h"
59 #include <linux/fs.h>
60 #include <linux/slab.h>
61 #include <linux/xattr.h>
64 * Limit the number of extended attributes per inode so that the total size
65 * (@xattr_size) is guaranteeded to fit in an 'unsigned int'.
67 #define MAX_XATTRS_PER_INODE 65535
70 * Extended attribute type constants.
72 * USER_XATTR: user extended attribute ("user.*")
73 * TRUSTED_XATTR: trusted extended attribute ("trusted.*)
74 * SECURITY_XATTR: security extended attribute ("security.*")
76 enum {
77 USER_XATTR,
78 TRUSTED_XATTR,
79 SECURITY_XATTR,
82 static const struct inode_operations empty_iops;
83 static const struct file_operations empty_fops;
85 /**
86 * create_xattr - create an extended attribute.
87 * @c: UBIFS file-system description object
88 * @host: host inode
89 * @nm: extended attribute name
90 * @value: extended attribute value
91 * @size: size of extended attribute value
93 * This is a helper function which creates an extended attribute of name @nm
94 * and value @value for inode @host. The host inode is also updated on flash
95 * because the ctime and extended attribute accounting data changes. This
96 * function returns zero in case of success and a negative error code in case
97 * of failure.
99 static int create_xattr(struct ubifs_info *c, struct inode *host,
100 const struct fscrypt_name *nm, const void *value, int size)
102 int err, names_len;
103 struct inode *inode;
104 struct ubifs_inode *ui, *host_ui = ubifs_inode(host);
105 struct ubifs_budget_req req = { .new_ino = 1, .new_dent = 1,
106 .new_ino_d = ALIGN(size, 8), .dirtied_ino = 1,
107 .dirtied_ino_d = ALIGN(host_ui->data_len, 8) };
109 if (host_ui->xattr_cnt >= MAX_XATTRS_PER_INODE) {
110 ubifs_err(c, "inode %lu already has too many xattrs (%d), cannot create more",
111 host->i_ino, host_ui->xattr_cnt);
112 return -ENOSPC;
115 * Linux limits the maximum size of the extended attribute names list
116 * to %XATTR_LIST_MAX. This means we should not allow creating more
117 * extended attributes if the name list becomes larger. This limitation
118 * is artificial for UBIFS, though.
120 names_len = host_ui->xattr_names + host_ui->xattr_cnt + fname_len(nm) + 1;
121 if (names_len > XATTR_LIST_MAX) {
122 ubifs_err(c, "cannot add one more xattr name to inode %lu, total names length would become %d, max. is %d",
123 host->i_ino, names_len, XATTR_LIST_MAX);
124 return -ENOSPC;
127 err = ubifs_budget_space(c, &req);
128 if (err)
129 return err;
131 inode = ubifs_new_inode(c, host, S_IFREG | S_IRWXUGO);
132 if (IS_ERR(inode)) {
133 err = PTR_ERR(inode);
134 goto out_budg;
137 /* Re-define all operations to be "nothing" */
138 inode->i_mapping->a_ops = &empty_aops;
139 inode->i_op = &empty_iops;
140 inode->i_fop = &empty_fops;
142 inode->i_flags |= S_SYNC | S_NOATIME | S_NOCMTIME | S_NOQUOTA;
143 ui = ubifs_inode(inode);
144 ui->xattr = 1;
145 ui->flags |= UBIFS_XATTR_FL;
146 ui->data = kmemdup(value, size, GFP_NOFS);
147 if (!ui->data) {
148 err = -ENOMEM;
149 goto out_free;
151 inode->i_size = ui->ui_size = size;
152 ui->data_len = size;
154 mutex_lock(&host_ui->ui_mutex);
155 host->i_ctime = current_time(host);
156 host_ui->xattr_cnt += 1;
157 host_ui->xattr_size += CALC_DENT_SIZE(fname_len(nm));
158 host_ui->xattr_size += CALC_XATTR_BYTES(size);
159 host_ui->xattr_names += fname_len(nm);
162 * We handle UBIFS_XATTR_NAME_ENCRYPTION_CONTEXT here because we
163 * have to set the UBIFS_CRYPT_FL flag on the host inode.
164 * To avoid multiple updates of the same inode in the same operation,
165 * let's do it here.
167 if (strcmp(fname_name(nm), UBIFS_XATTR_NAME_ENCRYPTION_CONTEXT) == 0)
168 host_ui->flags |= UBIFS_CRYPT_FL;
170 err = ubifs_jnl_update(c, host, nm, inode, 0, 1);
171 if (err)
172 goto out_cancel;
173 ubifs_set_inode_flags(host);
174 mutex_unlock(&host_ui->ui_mutex);
176 ubifs_release_budget(c, &req);
177 insert_inode_hash(inode);
178 iput(inode);
179 return 0;
181 out_cancel:
182 host_ui->xattr_cnt -= 1;
183 host_ui->xattr_size -= CALC_DENT_SIZE(fname_len(nm));
184 host_ui->xattr_size -= CALC_XATTR_BYTES(size);
185 host_ui->xattr_names -= fname_len(nm);
186 host_ui->flags &= ~UBIFS_CRYPT_FL;
187 mutex_unlock(&host_ui->ui_mutex);
188 out_free:
189 make_bad_inode(inode);
190 iput(inode);
191 out_budg:
192 ubifs_release_budget(c, &req);
193 return err;
197 * change_xattr - change an extended attribute.
198 * @c: UBIFS file-system description object
199 * @host: host inode
200 * @inode: extended attribute inode
201 * @value: extended attribute value
202 * @size: size of extended attribute value
204 * This helper function changes the value of extended attribute @inode with new
205 * data from @value. Returns zero in case of success and a negative error code
206 * in case of failure.
208 static int change_xattr(struct ubifs_info *c, struct inode *host,
209 struct inode *inode, const void *value, int size)
211 int err;
212 struct ubifs_inode *host_ui = ubifs_inode(host);
213 struct ubifs_inode *ui = ubifs_inode(inode);
214 void *buf = NULL;
215 int old_size;
216 struct ubifs_budget_req req = { .dirtied_ino = 2,
217 .dirtied_ino_d = ALIGN(size, 8) + ALIGN(host_ui->data_len, 8) };
219 ubifs_assert(ui->data_len == inode->i_size);
220 err = ubifs_budget_space(c, &req);
221 if (err)
222 return err;
224 buf = kmemdup(value, size, GFP_NOFS);
225 if (!buf) {
226 err = -ENOMEM;
227 goto out_free;
229 mutex_lock(&ui->ui_mutex);
230 kfree(ui->data);
231 ui->data = buf;
232 inode->i_size = ui->ui_size = size;
233 old_size = ui->data_len;
234 ui->data_len = size;
235 mutex_unlock(&ui->ui_mutex);
237 mutex_lock(&host_ui->ui_mutex);
238 host->i_ctime = current_time(host);
239 host_ui->xattr_size -= CALC_XATTR_BYTES(old_size);
240 host_ui->xattr_size += CALC_XATTR_BYTES(size);
243 * It is important to write the host inode after the xattr inode
244 * because if the host inode gets synchronized (via 'fsync()'), then
245 * the extended attribute inode gets synchronized, because it goes
246 * before the host inode in the write-buffer.
248 err = ubifs_jnl_change_xattr(c, inode, host);
249 if (err)
250 goto out_cancel;
251 mutex_unlock(&host_ui->ui_mutex);
253 ubifs_release_budget(c, &req);
254 return 0;
256 out_cancel:
257 host_ui->xattr_size -= CALC_XATTR_BYTES(size);
258 host_ui->xattr_size += CALC_XATTR_BYTES(old_size);
259 mutex_unlock(&host_ui->ui_mutex);
260 make_bad_inode(inode);
261 out_free:
262 ubifs_release_budget(c, &req);
263 return err;
266 static struct inode *iget_xattr(struct ubifs_info *c, ino_t inum)
268 struct inode *inode;
270 inode = ubifs_iget(c->vfs_sb, inum);
271 if (IS_ERR(inode)) {
272 ubifs_err(c, "dead extended attribute entry, error %d",
273 (int)PTR_ERR(inode));
274 return inode;
276 if (ubifs_inode(inode)->xattr)
277 return inode;
278 ubifs_err(c, "corrupt extended attribute entry");
279 iput(inode);
280 return ERR_PTR(-EINVAL);
283 int ubifs_xattr_set(struct inode *host, const char *name, const void *value,
284 size_t size, int flags, bool check_lock)
286 struct inode *inode;
287 struct ubifs_info *c = host->i_sb->s_fs_info;
288 struct fscrypt_name nm = { .disk_name = FSTR_INIT((char *)name, strlen(name))};
289 struct ubifs_dent_node *xent;
290 union ubifs_key key;
291 int err;
293 if (check_lock)
294 ubifs_assert(inode_is_locked(host));
296 if (size > UBIFS_MAX_INO_DATA)
297 return -ERANGE;
299 if (fname_len(&nm) > UBIFS_MAX_NLEN)
300 return -ENAMETOOLONG;
302 xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
303 if (!xent)
304 return -ENOMEM;
307 * The extended attribute entries are stored in LNC, so multiple
308 * look-ups do not involve reading the flash.
310 xent_key_init(c, &key, host->i_ino, &nm);
311 err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
312 if (err) {
313 if (err != -ENOENT)
314 goto out_free;
316 if (flags & XATTR_REPLACE)
317 /* We are asked not to create the xattr */
318 err = -ENODATA;
319 else
320 err = create_xattr(c, host, &nm, value, size);
321 goto out_free;
324 if (flags & XATTR_CREATE) {
325 /* We are asked not to replace the xattr */
326 err = -EEXIST;
327 goto out_free;
330 inode = iget_xattr(c, le64_to_cpu(xent->inum));
331 if (IS_ERR(inode)) {
332 err = PTR_ERR(inode);
333 goto out_free;
336 err = change_xattr(c, host, inode, value, size);
337 iput(inode);
339 out_free:
340 kfree(xent);
341 return err;
344 ssize_t ubifs_xattr_get(struct inode *host, const char *name, void *buf,
345 size_t size)
347 struct inode *inode;
348 struct ubifs_info *c = host->i_sb->s_fs_info;
349 struct fscrypt_name nm = { .disk_name = FSTR_INIT((char *)name, strlen(name))};
350 struct ubifs_inode *ui;
351 struct ubifs_dent_node *xent;
352 union ubifs_key key;
353 int err;
355 if (fname_len(&nm) > UBIFS_MAX_NLEN)
356 return -ENAMETOOLONG;
358 xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
359 if (!xent)
360 return -ENOMEM;
362 xent_key_init(c, &key, host->i_ino, &nm);
363 err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
364 if (err) {
365 if (err == -ENOENT)
366 err = -ENODATA;
367 goto out_unlock;
370 inode = iget_xattr(c, le64_to_cpu(xent->inum));
371 if (IS_ERR(inode)) {
372 err = PTR_ERR(inode);
373 goto out_unlock;
376 ui = ubifs_inode(inode);
377 ubifs_assert(inode->i_size == ui->data_len);
378 ubifs_assert(ubifs_inode(host)->xattr_size > ui->data_len);
380 mutex_lock(&ui->ui_mutex);
381 if (buf) {
382 /* If @buf is %NULL we are supposed to return the length */
383 if (ui->data_len > size) {
384 ubifs_err(c, "buffer size %zd, xattr len %d",
385 size, ui->data_len);
386 err = -ERANGE;
387 goto out_iput;
390 memcpy(buf, ui->data, ui->data_len);
392 err = ui->data_len;
394 out_iput:
395 mutex_unlock(&ui->ui_mutex);
396 iput(inode);
397 out_unlock:
398 kfree(xent);
399 return err;
402 static bool xattr_visible(const char *name)
404 /* File encryption related xattrs are for internal use only */
405 if (strcmp(name, UBIFS_XATTR_NAME_ENCRYPTION_CONTEXT) == 0)
406 return false;
408 /* Show trusted namespace only for "power" users */
409 if (strncmp(name, XATTR_TRUSTED_PREFIX,
410 XATTR_TRUSTED_PREFIX_LEN) == 0 && !capable(CAP_SYS_ADMIN))
411 return false;
413 return true;
416 ssize_t ubifs_listxattr(struct dentry *dentry, char *buffer, size_t size)
418 union ubifs_key key;
419 struct inode *host = d_inode(dentry);
420 struct ubifs_info *c = host->i_sb->s_fs_info;
421 struct ubifs_inode *host_ui = ubifs_inode(host);
422 struct ubifs_dent_node *xent, *pxent = NULL;
423 int err, len, written = 0;
424 struct fscrypt_name nm = {0};
426 dbg_gen("ino %lu ('%pd'), buffer size %zd", host->i_ino,
427 dentry, size);
429 len = host_ui->xattr_names + host_ui->xattr_cnt;
430 if (!buffer)
432 * We should return the minimum buffer size which will fit a
433 * null-terminated list of all the extended attribute names.
435 return len;
437 if (len > size)
438 return -ERANGE;
440 lowest_xent_key(c, &key, host->i_ino);
441 while (1) {
442 xent = ubifs_tnc_next_ent(c, &key, &nm);
443 if (IS_ERR(xent)) {
444 err = PTR_ERR(xent);
445 break;
448 fname_name(&nm) = xent->name;
449 fname_len(&nm) = le16_to_cpu(xent->nlen);
451 if (xattr_visible(xent->name)) {
452 memcpy(buffer + written, fname_name(&nm), fname_len(&nm) + 1);
453 written += fname_len(&nm) + 1;
456 kfree(pxent);
457 pxent = xent;
458 key_read(c, &xent->key, &key);
461 kfree(pxent);
462 if (err != -ENOENT) {
463 ubifs_err(c, "cannot find next direntry, error %d", err);
464 return err;
467 ubifs_assert(written <= size);
468 return written;
471 static int remove_xattr(struct ubifs_info *c, struct inode *host,
472 struct inode *inode, const struct fscrypt_name *nm)
474 int err;
475 struct ubifs_inode *host_ui = ubifs_inode(host);
476 struct ubifs_inode *ui = ubifs_inode(inode);
477 struct ubifs_budget_req req = { .dirtied_ino = 2, .mod_dent = 1,
478 .dirtied_ino_d = ALIGN(host_ui->data_len, 8) };
480 ubifs_assert(ui->data_len == inode->i_size);
482 err = ubifs_budget_space(c, &req);
483 if (err)
484 return err;
486 mutex_lock(&host_ui->ui_mutex);
487 host->i_ctime = current_time(host);
488 host_ui->xattr_cnt -= 1;
489 host_ui->xattr_size -= CALC_DENT_SIZE(fname_len(nm));
490 host_ui->xattr_size -= CALC_XATTR_BYTES(ui->data_len);
491 host_ui->xattr_names -= fname_len(nm);
493 err = ubifs_jnl_delete_xattr(c, host, inode, nm);
494 if (err)
495 goto out_cancel;
496 mutex_unlock(&host_ui->ui_mutex);
498 ubifs_release_budget(c, &req);
499 return 0;
501 out_cancel:
502 host_ui->xattr_cnt += 1;
503 host_ui->xattr_size += CALC_DENT_SIZE(fname_len(nm));
504 host_ui->xattr_size += CALC_XATTR_BYTES(ui->data_len);
505 host_ui->xattr_names += fname_len(nm);
506 mutex_unlock(&host_ui->ui_mutex);
507 ubifs_release_budget(c, &req);
508 make_bad_inode(inode);
509 return err;
513 * ubifs_evict_xattr_inode - Evict an xattr inode.
514 * @c: UBIFS file-system description object
515 * @xattr_inum: xattr inode number
517 * When an inode that hosts xattrs is being removed we have to make sure
518 * that cached inodes of the xattrs also get removed from the inode cache
519 * otherwise we'd waste memory. This function looks up an inode from the
520 * inode cache and clears the link counter such that iput() will evict
521 * the inode.
523 void ubifs_evict_xattr_inode(struct ubifs_info *c, ino_t xattr_inum)
525 struct inode *inode;
527 inode = ilookup(c->vfs_sb, xattr_inum);
528 if (inode) {
529 clear_nlink(inode);
530 iput(inode);
534 static int ubifs_xattr_remove(struct inode *host, const char *name)
536 struct inode *inode;
537 struct ubifs_info *c = host->i_sb->s_fs_info;
538 struct fscrypt_name nm = { .disk_name = FSTR_INIT((char *)name, strlen(name))};
539 struct ubifs_dent_node *xent;
540 union ubifs_key key;
541 int err;
543 ubifs_assert(inode_is_locked(host));
545 if (fname_len(&nm) > UBIFS_MAX_NLEN)
546 return -ENAMETOOLONG;
548 xent = kmalloc(UBIFS_MAX_XENT_NODE_SZ, GFP_NOFS);
549 if (!xent)
550 return -ENOMEM;
552 xent_key_init(c, &key, host->i_ino, &nm);
553 err = ubifs_tnc_lookup_nm(c, &key, xent, &nm);
554 if (err) {
555 if (err == -ENOENT)
556 err = -ENODATA;
557 goto out_free;
560 inode = iget_xattr(c, le64_to_cpu(xent->inum));
561 if (IS_ERR(inode)) {
562 err = PTR_ERR(inode);
563 goto out_free;
566 ubifs_assert(inode->i_nlink == 1);
567 clear_nlink(inode);
568 err = remove_xattr(c, host, inode, &nm);
569 if (err)
570 set_nlink(inode, 1);
572 /* If @i_nlink is 0, 'iput()' will delete the inode */
573 iput(inode);
575 out_free:
576 kfree(xent);
577 return err;
580 #ifdef CONFIG_UBIFS_FS_SECURITY
581 static int init_xattrs(struct inode *inode, const struct xattr *xattr_array,
582 void *fs_info)
584 const struct xattr *xattr;
585 char *name;
586 int err = 0;
588 for (xattr = xattr_array; xattr->name != NULL; xattr++) {
589 name = kmalloc(XATTR_SECURITY_PREFIX_LEN +
590 strlen(xattr->name) + 1, GFP_NOFS);
591 if (!name) {
592 err = -ENOMEM;
593 break;
595 strcpy(name, XATTR_SECURITY_PREFIX);
596 strcpy(name + XATTR_SECURITY_PREFIX_LEN, xattr->name);
598 * creating a new inode without holding the inode rwsem,
599 * no need to check whether inode is locked.
601 err = ubifs_xattr_set(inode, name, xattr->value,
602 xattr->value_len, 0, false);
603 kfree(name);
604 if (err < 0)
605 break;
608 return err;
611 int ubifs_init_security(struct inode *dentry, struct inode *inode,
612 const struct qstr *qstr)
614 int err;
616 err = security_inode_init_security(inode, dentry, qstr,
617 &init_xattrs, 0);
618 if (err) {
619 struct ubifs_info *c = dentry->i_sb->s_fs_info;
620 ubifs_err(c, "cannot initialize security for inode %lu, error %d",
621 inode->i_ino, err);
623 return err;
625 #endif
627 static int xattr_get(const struct xattr_handler *handler,
628 struct dentry *dentry, struct inode *inode,
629 const char *name, void *buffer, size_t size)
631 dbg_gen("xattr '%s', ino %lu ('%pd'), buf size %zd", name,
632 inode->i_ino, dentry, size);
634 name = xattr_full_name(handler, name);
635 return ubifs_xattr_get(inode, name, buffer, size);
638 static int xattr_set(const struct xattr_handler *handler,
639 struct dentry *dentry, struct inode *inode,
640 const char *name, const void *value,
641 size_t size, int flags)
643 dbg_gen("xattr '%s', host ino %lu ('%pd'), size %zd",
644 name, inode->i_ino, dentry, size);
646 name = xattr_full_name(handler, name);
648 if (value)
649 return ubifs_xattr_set(inode, name, value, size, flags, true);
650 else
651 return ubifs_xattr_remove(inode, name);
654 static const struct xattr_handler ubifs_user_xattr_handler = {
655 .prefix = XATTR_USER_PREFIX,
656 .get = xattr_get,
657 .set = xattr_set,
660 static const struct xattr_handler ubifs_trusted_xattr_handler = {
661 .prefix = XATTR_TRUSTED_PREFIX,
662 .get = xattr_get,
663 .set = xattr_set,
666 #ifdef CONFIG_UBIFS_FS_SECURITY
667 static const struct xattr_handler ubifs_security_xattr_handler = {
668 .prefix = XATTR_SECURITY_PREFIX,
669 .get = xattr_get,
670 .set = xattr_set,
672 #endif
674 const struct xattr_handler *ubifs_xattr_handlers[] = {
675 &ubifs_user_xattr_handler,
676 &ubifs_trusted_xattr_handler,
677 #ifdef CONFIG_UBIFS_FS_SECURITY
678 &ubifs_security_xattr_handler,
679 #endif
680 NULL