1 /* -------------------------------------------------------------------------
2 * File: fs/jffs2/xattr.c
3 * XATTR support on JFFS2 FileSystem
5 * Implemented by KaiGai Kohei <kaigai@ak.jp.nec.com>
6 * Copyright (C) 2006 NEC Corporation
8 * For licensing information, see the file 'LICENCE' in the jffs2 directory.
9 * ------------------------------------------------------------------------- */
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
14 #include <linux/time.h>
15 #include <linux/pagemap.h>
16 #include <linux/highmem.h>
17 #include <linux/crc32.h>
18 #include <linux/jffs2.h>
19 #include <linux/xattr.h>
20 #include <linux/mtd/mtd.h>
22 /* -------- xdatum related functions ----------------
23 * xattr_datum_hashkey(xprefix, xname, xvalue, xsize)
24 * is used to calcurate xdatum hashkey. The reminder of hashkey into XATTRINDEX_HASHSIZE is
25 * the index of the xattr name/value pair cache (c->xattrindex).
26 * unload_xattr_datum(c, xd)
27 * is used to release xattr name/value pair and detach from c->xattrindex.
28 * reclaim_xattr_datum(c)
29 * is used to reclaim xattr name/value pairs on the xattr name/value pair cache when
30 * memory usage by cache is over c->xdatum_mem_threshold. Currentry, this threshold
31 * is hard coded as 32KiB.
32 * delete_xattr_datum_node(c, xd)
33 * is used to delete a jffs2 node is dominated by xdatum. When EBS(Erase Block Summary) is
34 * enabled, it overwrites the obsolete node by myself.
35 * delete_xattr_datum(c, xd)
36 * is used to delete jffs2_xattr_datum object. It must be called with 0-value of reference
37 * counter. (It means how many jffs2_xattr_ref object refers this xdatum.)
38 * do_verify_xattr_datum(c, xd)
39 * is used to load the xdatum informations without name/value pair from the medium.
40 * It's necessary once, because those informations are not collected during mounting
41 * process when EBS is enabled.
42 * 0 will be returned, if success. An negative return value means recoverable error, and
43 * positive return value means unrecoverable error. Thus, caller must remove this xdatum
44 * and xref when it returned positive value.
45 * do_load_xattr_datum(c, xd)
46 * is used to load name/value pair from the medium.
47 * The meanings of return value is same as do_verify_xattr_datum().
48 * load_xattr_datum(c, xd)
49 * is used to be as a wrapper of do_verify_xattr_datum() and do_load_xattr_datum().
50 * If xd need to call do_verify_xattr_datum() at first, it's called before calling
51 * do_load_xattr_datum(). The meanings of return value is same as do_verify_xattr_datum().
52 * save_xattr_datum(c, xd, phys_ofs)
53 * is used to write xdatum to medium. xd->version will be incremented.
54 * create_xattr_datum(c, xprefix, xname, xvalue, xsize, phys_ofs)
55 * is used to create new xdatum and write to medium.
56 * -------------------------------------------------- */
58 static uint32_t xattr_datum_hashkey(int xprefix
, const char *xname
, const char *xvalue
, int xsize
)
60 int name_len
= strlen(xname
);
62 return crc32(xprefix
, xname
, name_len
) ^ crc32(xprefix
, xvalue
, xsize
);
65 static void unload_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
67 /* must be called under down_write(xattr_sem) */
68 D1(dbg_xattr("%s: xid=%u, version=%u\n", __FUNCTION__
, xd
->xid
, xd
->version
));
70 c
->xdatum_mem_usage
-= (xd
->name_len
+ 1 + xd
->value_len
);
74 list_del_init(&xd
->xindex
);
80 static void reclaim_xattr_datum(struct jffs2_sb_info
*c
)
82 /* must be called under down_write(xattr_sem) */
83 struct jffs2_xattr_datum
*xd
, *_xd
;
84 uint32_t target
, before
;
88 if (c
->xdatum_mem_threshold
> c
->xdatum_mem_usage
)
91 before
= c
->xdatum_mem_usage
;
92 target
= c
->xdatum_mem_usage
* 4 / 5; /* 20% reduction */
93 for (count
= 0; count
< XATTRINDEX_HASHSIZE
; count
++) {
94 list_for_each_entry_safe(xd
, _xd
, &c
->xattrindex
[index
], xindex
) {
95 if (xd
->flags
& JFFS2_XFLAGS_HOT
) {
96 xd
->flags
&= ~JFFS2_XFLAGS_HOT
;
97 } else if (!(xd
->flags
& JFFS2_XFLAGS_BIND
)) {
98 unload_xattr_datum(c
, xd
);
100 if (c
->xdatum_mem_usage
<= target
)
103 index
= (index
+1) % XATTRINDEX_HASHSIZE
;
106 JFFS2_NOTICE("xdatum_mem_usage from %u byte to %u byte (%u byte reclaimed)\n",
107 before
, c
->xdatum_mem_usage
, before
- c
->xdatum_mem_usage
);
110 static void delete_xattr_datum_node(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
112 /* must be called under down_write(xattr_sem) */
113 struct jffs2_raw_xattr rx
;
118 JFFS2_WARNING("xdatum (xid=%u) is removed twice.\n", xd
->xid
);
121 if (jffs2_sum_active()) {
122 memset(&rx
, 0xff, sizeof(struct jffs2_raw_xattr
));
123 rc
= jffs2_flash_read(c
, ref_offset(xd
->node
),
124 sizeof(struct jffs2_unknown_node
),
125 &length
, (char *)&rx
);
126 if (rc
|| length
!= sizeof(struct jffs2_unknown_node
)) {
127 JFFS2_ERROR("jffs2_flash_read()=%d, req=%u, read=%u at %#08x\n",
128 rc
, sizeof(struct jffs2_unknown_node
),
129 length
, ref_offset(xd
->node
));
131 rc
= jffs2_flash_write(c
, ref_offset(xd
->node
), sizeof(rx
),
132 &length
, (char *)&rx
);
133 if (rc
|| length
!= sizeof(struct jffs2_raw_xattr
)) {
134 JFFS2_ERROR("jffs2_flash_write()=%d, req=%u, wrote=%u ar %#08x\n",
135 rc
, sizeof(rx
), length
, ref_offset(xd
->node
));
138 spin_lock(&c
->erase_completion_lock
);
139 xd
->node
->next_in_ino
= NULL
;
140 spin_unlock(&c
->erase_completion_lock
);
141 jffs2_mark_node_obsolete(c
, xd
->node
);
145 static void delete_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
147 /* must be called under down_write(xattr_sem) */
150 unload_xattr_datum(c
, xd
);
152 delete_xattr_datum_node(c
, xd
);
155 jffs2_free_xattr_datum(xd
);
158 static int do_verify_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
160 /* must be called under down_write(xattr_sem) */
161 struct jffs2_eraseblock
*jeb
;
162 struct jffs2_raw_xattr rx
;
164 uint32_t crc
, totlen
;
168 BUG_ON(ref_flags(xd
->node
) != REF_UNCHECKED
);
170 rc
= jffs2_flash_read(c
, ref_offset(xd
->node
), sizeof(rx
), &readlen
, (char *)&rx
);
171 if (rc
|| readlen
!= sizeof(rx
)) {
172 JFFS2_WARNING("jffs2_flash_read()=%d, req=%u, read=%u at %#08x\n",
173 rc
, sizeof(rx
), readlen
, ref_offset(xd
->node
));
174 return rc
? rc
: -EIO
;
176 crc
= crc32(0, &rx
, sizeof(rx
) - 4);
177 if (crc
!= je32_to_cpu(rx
.node_crc
)) {
178 if (je32_to_cpu(rx
.node_crc
) != 0xffffffff)
179 JFFS2_ERROR("node CRC failed at %#08x, read=%#08x, calc=%#08x\n",
180 ref_offset(xd
->node
), je32_to_cpu(rx
.hdr_crc
), crc
);
183 totlen
= PAD(sizeof(rx
) + rx
.name_len
+ 1 + je16_to_cpu(rx
.value_len
));
184 if (je16_to_cpu(rx
.magic
) != JFFS2_MAGIC_BITMASK
185 || je16_to_cpu(rx
.nodetype
) != JFFS2_NODETYPE_XATTR
186 || je32_to_cpu(rx
.totlen
) != totlen
187 || je32_to_cpu(rx
.xid
) != xd
->xid
188 || je32_to_cpu(rx
.version
) != xd
->version
) {
189 JFFS2_ERROR("inconsistent xdatum at %#08x, magic=%#04x/%#04x, "
190 "nodetype=%#04x/%#04x, totlen=%u/%u, xid=%u/%u, version=%u/%u\n",
191 ref_offset(xd
->node
), je16_to_cpu(rx
.magic
), JFFS2_MAGIC_BITMASK
,
192 je16_to_cpu(rx
.nodetype
), JFFS2_NODETYPE_XATTR
,
193 je32_to_cpu(rx
.totlen
), totlen
,
194 je32_to_cpu(rx
.xid
), xd
->xid
,
195 je32_to_cpu(rx
.version
), xd
->version
);
198 xd
->xprefix
= rx
.xprefix
;
199 xd
->name_len
= rx
.name_len
;
200 xd
->value_len
= je16_to_cpu(rx
.value_len
);
201 xd
->data_crc
= je32_to_cpu(rx
.data_crc
);
203 /* This JFFS2_NODETYPE_XATTR node is checked */
204 jeb
= &c
->blocks
[ref_offset(xd
->node
) / c
->sector_size
];
205 totlen
= PAD(je32_to_cpu(rx
.totlen
));
207 spin_lock(&c
->erase_completion_lock
);
208 c
->unchecked_size
-= totlen
; c
->used_size
+= totlen
;
209 jeb
->unchecked_size
-= totlen
; jeb
->used_size
+= totlen
;
210 xd
->node
->flash_offset
= ref_offset(xd
->node
) | REF_PRISTINE
;
211 spin_unlock(&c
->erase_completion_lock
);
213 /* unchecked xdatum is chained with c->xattr_unchecked */
214 list_del_init(&xd
->xindex
);
216 dbg_xattr("success on verfying xdatum (xid=%u, version=%u)\n",
217 xd
->xid
, xd
->version
);
222 static int do_load_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
224 /* must be called under down_write(xattr_sem) */
227 uint32_t crc
, length
;
228 int i
, ret
, retry
= 0;
231 BUG_ON(ref_flags(xd
->node
) != REF_PRISTINE
);
232 BUG_ON(!list_empty(&xd
->xindex
));
234 length
= xd
->name_len
+ 1 + xd
->value_len
;
235 data
= kmalloc(length
, GFP_KERNEL
);
239 ret
= jffs2_flash_read(c
, ref_offset(xd
->node
)+sizeof(struct jffs2_raw_xattr
),
240 length
, &readlen
, data
);
242 if (ret
|| length
!=readlen
) {
243 JFFS2_WARNING("jffs2_flash_read() returned %d, request=%d, readlen=%d, at %#08x\n",
244 ret
, length
, readlen
, ref_offset(xd
->node
));
246 return ret
? ret
: -EIO
;
249 data
[xd
->name_len
] = '\0';
250 crc
= crc32(0, data
, length
);
251 if (crc
!= xd
->data_crc
) {
252 JFFS2_WARNING("node CRC failed (JFFS2_NODETYPE_XREF)"
253 " at %#08x, read: 0x%08x calculated: 0x%08x\n",
254 ref_offset(xd
->node
), xd
->data_crc
, crc
);
259 xd
->flags
|= JFFS2_XFLAGS_HOT
;
261 xd
->xvalue
= data
+ xd
->name_len
+1;
263 c
->xdatum_mem_usage
+= length
;
265 xd
->hashkey
= xattr_datum_hashkey(xd
->xprefix
, xd
->xname
, xd
->xvalue
, xd
->value_len
);
266 i
= xd
->hashkey
% XATTRINDEX_HASHSIZE
;
267 list_add(&xd
->xindex
, &c
->xattrindex
[i
]);
270 reclaim_xattr_datum(c
);
275 dbg_xattr("success on loading xdatum (xid=%u, xprefix=%u, xname='%s')\n",
276 xd
->xid
, xd
->xprefix
, xd
->xname
);
281 static int load_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
)
283 /* must be called under down_write(xattr_sem);
284 * rc < 0 : recoverable error, try again
286 * rc > 0 : Unrecoverable error, this node should be deleted.
292 if (unlikely(ref_flags(xd
->node
) != REF_PRISTINE
)) {
293 rc
= do_verify_xattr_datum(c
, xd
);
295 list_del_init(&xd
->xindex
);
296 delete_xattr_datum_node(c
, xd
);
300 rc
= do_load_xattr_datum(c
, xd
);
304 static int save_xattr_datum(struct jffs2_sb_info
*c
, struct jffs2_xattr_datum
*xd
, uint32_t phys_ofs
)
306 /* must be called under down_write(xattr_sem) */
307 struct jffs2_raw_xattr rx
;
308 struct jffs2_raw_node_ref
*raw
;
315 vecs
[0].iov_base
= &rx
;
316 vecs
[0].iov_len
= PAD(sizeof(rx
));
317 vecs
[1].iov_base
= xd
->xname
;
318 vecs
[1].iov_len
= xd
->name_len
+ 1 + xd
->value_len
;
319 totlen
= vecs
[0].iov_len
+ vecs
[1].iov_len
;
321 raw
= jffs2_alloc_raw_node_ref();
324 raw
->flash_offset
= phys_ofs
;
325 raw
->__totlen
= PAD(totlen
);
326 raw
->next_phys
= NULL
;
327 raw
->next_in_ino
= (void *)xd
;
329 /* Setup raw-xattr */
330 rx
.magic
= cpu_to_je16(JFFS2_MAGIC_BITMASK
);
331 rx
.nodetype
= cpu_to_je16(JFFS2_NODETYPE_XATTR
);
332 rx
.totlen
= cpu_to_je32(PAD(totlen
));
333 rx
.hdr_crc
= cpu_to_je32(crc32(0, &rx
, sizeof(struct jffs2_unknown_node
) - 4));
335 rx
.xid
= cpu_to_je32(xd
->xid
);
336 rx
.version
= cpu_to_je32(++xd
->version
);
337 rx
.xprefix
= xd
->xprefix
;
338 rx
.name_len
= xd
->name_len
;
339 rx
.value_len
= cpu_to_je16(xd
->value_len
);
340 rx
.data_crc
= cpu_to_je32(crc32(0, vecs
[1].iov_base
, vecs
[1].iov_len
));
341 rx
.node_crc
= cpu_to_je32(crc32(0, &rx
, sizeof(struct jffs2_raw_xattr
) - 4));
343 rc
= jffs2_flash_writev(c
, vecs
, 2, phys_ofs
, &length
, 0);
344 if (rc
|| totlen
!= length
) {
345 JFFS2_WARNING("jffs2_flash_writev()=%d, req=%u, wrote=%u, at %#08x\n",
346 rc
, totlen
, length
, phys_ofs
);
349 raw
->flash_offset
|= REF_OBSOLETE
;
350 raw
->next_in_ino
= NULL
;
351 jffs2_add_physical_node_ref(c
, raw
);
352 jffs2_mark_node_obsolete(c
, raw
);
354 jffs2_free_raw_node_ref(raw
);
358 BUG_ON(raw
->__totlen
< sizeof(struct jffs2_raw_xattr
));
360 raw
->flash_offset
|= REF_PRISTINE
;
361 jffs2_add_physical_node_ref(c
, raw
);
363 delete_xattr_datum_node(c
, xd
);
366 dbg_xattr("success on saving xdatum (xid=%u, version=%u, xprefix=%u, xname='%s')\n",
367 xd
->xid
, xd
->version
, xd
->xprefix
, xd
->xname
);
372 static struct jffs2_xattr_datum
*create_xattr_datum(struct jffs2_sb_info
*c
,
373 int xprefix
, const char *xname
,
374 const char *xvalue
, int xsize
,
377 /* must be called under down_write(xattr_sem) */
378 struct jffs2_xattr_datum
*xd
;
379 uint32_t hashkey
, name_len
;
383 /* Search xattr_datum has same xname/xvalue by index */
384 hashkey
= xattr_datum_hashkey(xprefix
, xname
, xvalue
, xsize
);
385 i
= hashkey
% XATTRINDEX_HASHSIZE
;
386 list_for_each_entry(xd
, &c
->xattrindex
[i
], xindex
) {
387 if (xd
->hashkey
==hashkey
388 && xd
->xprefix
==xprefix
389 && xd
->value_len
==xsize
390 && !strcmp(xd
->xname
, xname
)
391 && !memcmp(xd
->xvalue
, xvalue
, xsize
)) {
397 /* Not found, Create NEW XATTR-Cache */
398 name_len
= strlen(xname
);
400 xd
= jffs2_alloc_xattr_datum();
402 return ERR_PTR(-ENOMEM
);
404 data
= kmalloc(name_len
+ 1 + xsize
, GFP_KERNEL
);
406 jffs2_free_xattr_datum(xd
);
407 return ERR_PTR(-ENOMEM
);
410 memcpy(data
+ name_len
+ 1, xvalue
, xsize
);
413 xd
->xid
= ++c
->highest_xid
;
414 xd
->flags
|= JFFS2_XFLAGS_HOT
;
415 xd
->xprefix
= xprefix
;
417 xd
->hashkey
= hashkey
;
419 xd
->xvalue
= data
+ name_len
+ 1;
420 xd
->name_len
= name_len
;
421 xd
->value_len
= xsize
;
422 xd
->data_crc
= crc32(0, data
, xd
->name_len
+ 1 + xd
->value_len
);
424 rc
= save_xattr_datum(c
, xd
, phys_ofs
);
427 jffs2_free_xattr_datum(xd
);
431 /* Insert Hash Index */
432 i
= hashkey
% XATTRINDEX_HASHSIZE
;
433 list_add(&xd
->xindex
, &c
->xattrindex
[i
]);
435 c
->xdatum_mem_usage
+= (xd
->name_len
+ 1 + xd
->value_len
);
436 reclaim_xattr_datum(c
);
441 /* -------- xdatum related functions ----------------
442 * verify_xattr_ref(c, ref)
443 * is used to load xref information from medium. Because summary data does not
444 * contain xid/ino, it's necessary to verify once while mounting process.
445 * delete_xattr_ref_node(c, ref)
446 * is used to delete a jffs2 node is dominated by xref. When EBS is enabled,
447 * it overwrites the obsolete node by myself.
448 * delete_xattr_ref(c, ref)
449 * is used to delete jffs2_xattr_ref object. If the reference counter of xdatum
450 * is refered by this xref become 0, delete_xattr_datum() is called later.
451 * save_xattr_ref(c, ref, phys_ofs)
452 * is used to write xref to medium.
453 * create_xattr_ref(c, ic, xd, phys_ofs)
454 * is used to create a new xref and write to medium.
455 * jffs2_xattr_delete_inode(c, ic)
456 * is called to remove xrefs related to obsolete inode when inode is unlinked.
457 * jffs2_xattr_free_inode(c, ic)
458 * is called to release xattr related objects when unmounting.
459 * check_xattr_ref_inode(c, ic)
460 * is used to confirm inode does not have duplicate xattr name/value pair.
461 * -------------------------------------------------- */
462 static int verify_xattr_ref(struct jffs2_sb_info
*c
, struct jffs2_xattr_ref
*ref
)
464 struct jffs2_eraseblock
*jeb
;
465 struct jffs2_raw_xref rr
;
467 uint32_t crc
, totlen
;
470 BUG_ON(ref_flags(ref
->node
) != REF_UNCHECKED
);
472 rc
= jffs2_flash_read(c
, ref_offset(ref
->node
), sizeof(rr
), &readlen
, (char *)&rr
);
473 if (rc
|| sizeof(rr
) != readlen
) {
474 JFFS2_WARNING("jffs2_flash_read()=%d, req=%u, read=%u, at %#08x\n",
475 rc
, sizeof(rr
), readlen
, ref_offset(ref
->node
));
476 return rc
? rc
: -EIO
;
479 crc
= crc32(0, &rr
, sizeof(rr
) - 4);
480 if (crc
!= je32_to_cpu(rr
.node_crc
)) {
481 if (je32_to_cpu(rr
.node_crc
) != 0xffffffff)
482 JFFS2_ERROR("node CRC failed at %#08x, read=%#08x, calc=%#08x\n",
483 ref_offset(ref
->node
), je32_to_cpu(rr
.node_crc
), crc
);
486 if (je16_to_cpu(rr
.magic
) != JFFS2_MAGIC_BITMASK
487 || je16_to_cpu(rr
.nodetype
) != JFFS2_NODETYPE_XREF
488 || je32_to_cpu(rr
.totlen
) != PAD(sizeof(rr
))) {
489 JFFS2_ERROR("inconsistent xref at %#08x, magic=%#04x/%#04x, "
490 "nodetype=%#04x/%#04x, totlen=%u/%u\n",
491 ref_offset(ref
->node
), je16_to_cpu(rr
.magic
), JFFS2_MAGIC_BITMASK
,
492 je16_to_cpu(rr
.nodetype
), JFFS2_NODETYPE_XREF
,
493 je32_to_cpu(rr
.totlen
), PAD(sizeof(rr
)));
496 ref
->ino
= je32_to_cpu(rr
.ino
);
497 ref
->xid
= je32_to_cpu(rr
.xid
);
499 /* fixup superblock/eraseblock info */
500 jeb
= &c
->blocks
[ref_offset(ref
->node
) / c
->sector_size
];
501 totlen
= PAD(sizeof(rr
));
503 spin_lock(&c
->erase_completion_lock
);
504 c
->unchecked_size
-= totlen
; c
->used_size
+= totlen
;
505 jeb
->unchecked_size
-= totlen
; jeb
->used_size
+= totlen
;
506 ref
->node
->flash_offset
= ref_offset(ref
->node
) | REF_PRISTINE
;
507 spin_unlock(&c
->erase_completion_lock
);
509 dbg_xattr("success on verifying xref (ino=%u, xid=%u) at %#08x\n",
510 ref
->ino
, ref
->xid
, ref_offset(ref
->node
));
514 static void delete_xattr_ref_node(struct jffs2_sb_info
*c
, struct jffs2_xattr_ref
*ref
)
516 struct jffs2_raw_xref rr
;
520 if (jffs2_sum_active()) {
521 memset(&rr
, 0xff, sizeof(rr
));
522 rc
= jffs2_flash_read(c
, ref_offset(ref
->node
),
523 sizeof(struct jffs2_unknown_node
),
524 &length
, (char *)&rr
);
525 if (rc
|| length
!= sizeof(struct jffs2_unknown_node
)) {
526 JFFS2_ERROR("jffs2_flash_read()=%d, req=%u, read=%u at %#08x\n",
527 rc
, sizeof(struct jffs2_unknown_node
),
528 length
, ref_offset(ref
->node
));
530 rc
= jffs2_flash_write(c
, ref_offset(ref
->node
), sizeof(rr
),
531 &length
, (char *)&rr
);
532 if (rc
|| length
!= sizeof(struct jffs2_raw_xref
)) {
533 JFFS2_ERROR("jffs2_flash_write()=%d, req=%u, wrote=%u at %#08x\n",
534 rc
, sizeof(rr
), length
, ref_offset(ref
->node
));
537 spin_lock(&c
->erase_completion_lock
);
538 ref
->node
->next_in_ino
= NULL
;
539 spin_unlock(&c
->erase_completion_lock
);
540 jffs2_mark_node_obsolete(c
, ref
->node
);
544 static void delete_xattr_ref(struct jffs2_sb_info
*c
, struct jffs2_xattr_ref
*ref
)
546 /* must be called under down_write(xattr_sem) */
547 struct jffs2_xattr_datum
*xd
;
550 delete_xattr_ref_node(c
, ref
);
555 delete_xattr_datum(c
, xd
);
556 jffs2_free_xattr_ref(ref
);
559 static int save_xattr_ref(struct jffs2_sb_info
*c
, struct jffs2_xattr_ref
*ref
, uint32_t phys_ofs
)
561 /* must be called under down_write(xattr_sem) */
562 struct jffs2_raw_node_ref
*raw
;
563 struct jffs2_raw_xref rr
;
567 raw
= jffs2_alloc_raw_node_ref();
570 raw
->flash_offset
= phys_ofs
;
571 raw
->__totlen
= PAD(sizeof(rr
));
572 raw
->next_phys
= NULL
;
573 raw
->next_in_ino
= (void *)ref
;
575 rr
.magic
= cpu_to_je16(JFFS2_MAGIC_BITMASK
);
576 rr
.nodetype
= cpu_to_je16(JFFS2_NODETYPE_XREF
);
577 rr
.totlen
= cpu_to_je32(PAD(sizeof(rr
)));
578 rr
.hdr_crc
= cpu_to_je32(crc32(0, &rr
, sizeof(struct jffs2_unknown_node
) - 4));
580 rr
.ino
= cpu_to_je32(ref
->ic
->ino
);
581 rr
.xid
= cpu_to_je32(ref
->xd
->xid
);
582 rr
.node_crc
= cpu_to_je32(crc32(0, &rr
, sizeof(rr
) - 4));
584 ret
= jffs2_flash_write(c
, phys_ofs
, sizeof(rr
), &length
, (char *)&rr
);
585 if (ret
|| sizeof(rr
) != length
) {
586 JFFS2_WARNING("jffs2_flash_write() returned %d, request=%u, retlen=%u, at %#08x\n",
587 ret
, sizeof(rr
), length
, phys_ofs
);
588 ret
= ret
? ret
: -EIO
;
590 raw
->flash_offset
|= REF_OBSOLETE
;
591 raw
->next_in_ino
= NULL
;
592 jffs2_add_physical_node_ref(c
, raw
);
593 jffs2_mark_node_obsolete(c
, raw
);
595 jffs2_free_raw_node_ref(raw
);
599 raw
->flash_offset
|= REF_PRISTINE
;
601 jffs2_add_physical_node_ref(c
, raw
);
603 delete_xattr_ref_node(c
, ref
);
606 dbg_xattr("success on saving xref (ino=%u, xid=%u)\n", ref
->ic
->ino
, ref
->xd
->xid
);
611 static struct jffs2_xattr_ref
*create_xattr_ref(struct jffs2_sb_info
*c
, struct jffs2_inode_cache
*ic
,
612 struct jffs2_xattr_datum
*xd
, uint32_t phys_ofs
)
614 /* must be called under down_write(xattr_sem) */
615 struct jffs2_xattr_ref
*ref
;
618 ref
= jffs2_alloc_xattr_ref();
620 return ERR_PTR(-ENOMEM
);
624 ret
= save_xattr_ref(c
, ref
, phys_ofs
);
626 jffs2_free_xattr_ref(ref
);
631 ref
->next
= ic
->xref
;
634 return ref
; /* success */
637 void jffs2_xattr_delete_inode(struct jffs2_sb_info
*c
, struct jffs2_inode_cache
*ic
)
639 /* It's called from jffs2_clear_inode() on inode removing.
640 When an inode with XATTR is removed, those XATTRs must be removed. */
641 struct jffs2_xattr_ref
*ref
, *_ref
;
643 if (!ic
|| ic
->nlink
> 0)
646 down_write(&c
->xattr_sem
);
647 for (ref
= ic
->xref
; ref
; ref
= _ref
) {
649 delete_xattr_ref(c
, ref
);
652 up_write(&c
->xattr_sem
);
655 void jffs2_xattr_free_inode(struct jffs2_sb_info
*c
, struct jffs2_inode_cache
*ic
)
657 /* It's called from jffs2_free_ino_caches() until unmounting FS. */
658 struct jffs2_xattr_datum
*xd
;
659 struct jffs2_xattr_ref
*ref
, *_ref
;
661 down_write(&c
->xattr_sem
);
662 for (ref
= ic
->xref
; ref
; ref
= _ref
) {
667 unload_xattr_datum(c
, xd
);
668 jffs2_free_xattr_datum(xd
);
670 jffs2_free_xattr_ref(ref
);
673 up_write(&c
->xattr_sem
);
676 static int check_xattr_ref_inode(struct jffs2_sb_info
*c
, struct jffs2_inode_cache
*ic
)
678 /* success of check_xattr_ref_inode() means taht inode (ic) dose not have
679 * duplicate name/value pairs. If duplicate name/value pair would be found,
680 * one will be removed.
682 struct jffs2_xattr_ref
*ref
, *cmp
, **pref
;
685 if (likely(ic
->flags
& INO_FLAGS_XATTR_CHECKED
))
687 down_write(&c
->xattr_sem
);
690 for (ref
=ic
->xref
, pref
=&ic
->xref
; ref
; pref
=&ref
->next
, ref
=ref
->next
) {
691 if (!ref
->xd
->xname
) {
692 rc
= load_xattr_datum(c
, ref
->xd
);
693 if (unlikely(rc
> 0)) {
695 delete_xattr_ref(c
, ref
);
697 } else if (unlikely(rc
< 0))
700 for (cmp
=ref
->next
, pref
=&ref
->next
; cmp
; pref
=&cmp
->next
, cmp
=cmp
->next
) {
701 if (!cmp
->xd
->xname
) {
702 ref
->xd
->flags
|= JFFS2_XFLAGS_BIND
;
703 rc
= load_xattr_datum(c
, cmp
->xd
);
704 ref
->xd
->flags
&= ~JFFS2_XFLAGS_BIND
;
705 if (unlikely(rc
> 0)) {
707 delete_xattr_ref(c
, cmp
);
709 } else if (unlikely(rc
< 0))
712 if (ref
->xd
->xprefix
== cmp
->xd
->xprefix
713 && !strcmp(ref
->xd
->xname
, cmp
->xd
->xname
)) {
715 delete_xattr_ref(c
, cmp
);
720 ic
->flags
|= INO_FLAGS_XATTR_CHECKED
;
722 up_write(&c
->xattr_sem
);
727 /* -------- xattr subsystem functions ---------------
728 * jffs2_init_xattr_subsystem(c)
729 * is used to initialize semaphore and list_head, and some variables.
730 * jffs2_find_xattr_datum(c, xid)
731 * is used to lookup xdatum while scanning process.
732 * jffs2_clear_xattr_subsystem(c)
733 * is used to release any xattr related objects.
734 * jffs2_build_xattr_subsystem(c)
735 * is used to associate xdatum and xref while super block building process.
736 * jffs2_setup_xattr_datum(c, xid, version)
737 * is used to insert xdatum while scanning process.
738 * -------------------------------------------------- */
739 void jffs2_init_xattr_subsystem(struct jffs2_sb_info
*c
)
743 for (i
=0; i
< XATTRINDEX_HASHSIZE
; i
++)
744 INIT_LIST_HEAD(&c
->xattrindex
[i
]);
745 INIT_LIST_HEAD(&c
->xattr_unchecked
);
748 init_rwsem(&c
->xattr_sem
);
749 c
->xdatum_mem_usage
= 0;
750 c
->xdatum_mem_threshold
= 32 * 1024; /* Default 32KB */
753 static struct jffs2_xattr_datum
*jffs2_find_xattr_datum(struct jffs2_sb_info
*c
, uint32_t xid
)
755 struct jffs2_xattr_datum
*xd
;
756 int i
= xid
% XATTRINDEX_HASHSIZE
;
758 /* It's only used in scanning/building process. */
759 BUG_ON(!(c
->flags
& (JFFS2_SB_FLAG_SCANNING
|JFFS2_SB_FLAG_BUILDING
)));
761 list_for_each_entry(xd
, &c
->xattrindex
[i
], xindex
) {
768 void jffs2_clear_xattr_subsystem(struct jffs2_sb_info
*c
)
770 struct jffs2_xattr_datum
*xd
, *_xd
;
771 struct jffs2_xattr_ref
*ref
, *_ref
;
774 for (ref
=c
->xref_temp
; ref
; ref
= _ref
) {
776 jffs2_free_xattr_ref(ref
);
780 for (i
=0; i
< XATTRINDEX_HASHSIZE
; i
++) {
781 list_for_each_entry_safe(xd
, _xd
, &c
->xattrindex
[i
], xindex
) {
782 list_del(&xd
->xindex
);
785 jffs2_free_xattr_datum(xd
);
790 void jffs2_build_xattr_subsystem(struct jffs2_sb_info
*c
)
792 struct jffs2_xattr_ref
*ref
, *_ref
;
793 struct jffs2_xattr_datum
*xd
, *_xd
;
794 struct jffs2_inode_cache
*ic
;
795 int i
, xdatum_count
=0, xdatum_unchecked_count
= 0, xref_count
= 0;
797 BUG_ON(!(c
->flags
& JFFS2_SB_FLAG_BUILDING
));
800 for (ref
=c
->xref_temp
; ref
; ref
=_ref
) {
802 /* checking REF_UNCHECKED nodes */
803 if (ref_flags(ref
->node
) != REF_PRISTINE
) {
804 if (verify_xattr_ref(c
, ref
)) {
805 delete_xattr_ref_node(c
, ref
);
806 jffs2_free_xattr_ref(ref
);
810 /* At this point, ref->xid and ref->ino contain XID and inode number.
811 ref->xd and ref->ic are not valid yet. */
812 xd
= jffs2_find_xattr_datum(c
, ref
->xid
);
813 ic
= jffs2_get_ino_cache(c
, ref
->ino
);
815 if (ref_flags(ref
->node
) != REF_UNCHECKED
)
816 JFFS2_WARNING("xref(ino=%u, xid=%u) is orphan. \n",
818 delete_xattr_ref_node(c
, ref
);
819 jffs2_free_xattr_ref(ref
);
825 ref
->next
= ic
->xref
;
830 /* After this, ref->xid/ino are NEVER used. */
833 for (i
=0; i
< XATTRINDEX_HASHSIZE
; i
++) {
834 list_for_each_entry_safe(xd
, _xd
, &c
->xattrindex
[i
], xindex
) {
835 list_del_init(&xd
->xindex
);
837 if (ref_flags(xd
->node
) != REF_UNCHECKED
)
838 JFFS2_WARNING("orphan xdatum(xid=%u, version=%u) at %#08x\n",
839 xd
->xid
, xd
->version
, ref_offset(xd
->node
));
840 delete_xattr_datum(c
, xd
);
843 if (ref_flags(xd
->node
) != REF_PRISTINE
) {
844 dbg_xattr("unchecked xdatum(xid=%u) at %#08x\n",
845 xd
->xid
, ref_offset(xd
->node
));
846 list_add(&xd
->xindex
, &c
->xattr_unchecked
);
847 xdatum_unchecked_count
++;
853 JFFS2_NOTICE("complete building xattr subsystem, %u of xdatum (%u unchecked) and "
854 "%u of xref found.\n", xdatum_count
, xdatum_unchecked_count
, xref_count
);
857 struct jffs2_xattr_datum
*jffs2_setup_xattr_datum(struct jffs2_sb_info
*c
,
858 uint32_t xid
, uint32_t version
)
860 struct jffs2_xattr_datum
*xd
, *_xd
;
862 _xd
= jffs2_find_xattr_datum(c
, xid
);
864 dbg_xattr("duplicate xdatum (xid=%u, version=%u/%u) at %#08x\n",
865 xid
, version
, _xd
->version
, ref_offset(_xd
->node
));
866 if (version
< _xd
->version
)
867 return ERR_PTR(-EEXIST
);
869 xd
= jffs2_alloc_xattr_datum();
871 return ERR_PTR(-ENOMEM
);
873 xd
->version
= version
;
874 if (xd
->xid
> c
->highest_xid
)
875 c
->highest_xid
= xd
->xid
;
876 list_add_tail(&xd
->xindex
, &c
->xattrindex
[xid
% XATTRINDEX_HASHSIZE
]);
879 list_del_init(&_xd
->xindex
);
880 delete_xattr_datum_node(c
, _xd
);
881 jffs2_free_xattr_datum(_xd
);
886 /* -------- xattr subsystem functions ---------------
887 * xprefix_to_handler(xprefix)
888 * is used to translate xprefix into xattr_handler.
889 * jffs2_listxattr(dentry, buffer, size)
890 * is an implementation of listxattr handler on jffs2.
891 * do_jffs2_getxattr(inode, xprefix, xname, buffer, size)
892 * is an implementation of getxattr handler on jffs2.
893 * do_jffs2_setxattr(inode, xprefix, xname, buffer, size, flags)
894 * is an implementation of setxattr handler on jffs2.
895 * -------------------------------------------------- */
896 struct xattr_handler
*jffs2_xattr_handlers
[] = {
897 &jffs2_user_xattr_handler
,
898 #ifdef CONFIG_JFFS2_FS_SECURITY
899 &jffs2_security_xattr_handler
,
901 #ifdef CONFIG_JFFS2_FS_POSIX_ACL
902 &jffs2_acl_access_xattr_handler
,
903 &jffs2_acl_default_xattr_handler
,
905 &jffs2_trusted_xattr_handler
,
909 static struct xattr_handler
*xprefix_to_handler(int xprefix
) {
910 struct xattr_handler
*ret
;
913 case JFFS2_XPREFIX_USER
:
914 ret
= &jffs2_user_xattr_handler
;
916 #ifdef CONFIG_JFFS2_FS_SECURITY
917 case JFFS2_XPREFIX_SECURITY
:
918 ret
= &jffs2_security_xattr_handler
;
921 #ifdef CONFIG_JFFS2_FS_POSIX_ACL
922 case JFFS2_XPREFIX_ACL_ACCESS
:
923 ret
= &jffs2_acl_access_xattr_handler
;
925 case JFFS2_XPREFIX_ACL_DEFAULT
:
926 ret
= &jffs2_acl_default_xattr_handler
;
929 case JFFS2_XPREFIX_TRUSTED
:
930 ret
= &jffs2_trusted_xattr_handler
;
939 ssize_t
jffs2_listxattr(struct dentry
*dentry
, char *buffer
, size_t size
)
941 struct inode
*inode
= dentry
->d_inode
;
942 struct jffs2_inode_info
*f
= JFFS2_INODE_INFO(inode
);
943 struct jffs2_sb_info
*c
= JFFS2_SB_INFO(inode
->i_sb
);
944 struct jffs2_inode_cache
*ic
= f
->inocache
;
945 struct jffs2_xattr_ref
*ref
, **pref
;
946 struct jffs2_xattr_datum
*xd
;
947 struct xattr_handler
*xhandle
;
951 rc
= check_xattr_ref_inode(c
, ic
);
955 down_read(&c
->xattr_sem
);
958 for (ref
=ic
->xref
, pref
=&ic
->xref
; ref
; pref
=&ref
->next
, ref
=ref
->next
) {
959 BUG_ON(ref
->ic
!= ic
);
962 /* xdatum is unchached */
965 up_read(&c
->xattr_sem
);
966 down_write(&c
->xattr_sem
);
969 rc
= load_xattr_datum(c
, xd
);
970 if (unlikely(rc
> 0)) {
972 delete_xattr_ref(c
, ref
);
974 } else if (unlikely(rc
< 0))
978 xhandle
= xprefix_to_handler(xd
->xprefix
);
982 rc
= xhandle
->list(inode
, buffer
+len
, size
-len
, xd
->xname
, xd
->name_len
);
984 rc
= xhandle
->list(inode
, NULL
, 0, xd
->xname
, xd
->name_len
);
993 up_read(&c
->xattr_sem
);
995 up_write(&c
->xattr_sem
);
1000 int do_jffs2_getxattr(struct inode
*inode
, int xprefix
, const char *xname
,
1001 char *buffer
, size_t size
)
1003 struct jffs2_inode_info
*f
= JFFS2_INODE_INFO(inode
);
1004 struct jffs2_sb_info
*c
= JFFS2_SB_INFO(inode
->i_sb
);
1005 struct jffs2_inode_cache
*ic
= f
->inocache
;
1006 struct jffs2_xattr_datum
*xd
;
1007 struct jffs2_xattr_ref
*ref
, **pref
;
1010 rc
= check_xattr_ref_inode(c
, ic
);
1014 down_read(&c
->xattr_sem
);
1016 for (ref
=ic
->xref
, pref
=&ic
->xref
; ref
; pref
=&ref
->next
, ref
=ref
->next
) {
1017 BUG_ON(ref
->ic
!=ic
);
1020 if (xd
->xprefix
!= xprefix
)
1023 /* xdatum is unchached */
1026 up_read(&c
->xattr_sem
);
1027 down_write(&c
->xattr_sem
);
1030 rc
= load_xattr_datum(c
, xd
);
1031 if (unlikely(rc
> 0)) {
1033 delete_xattr_ref(c
, ref
);
1035 } else if (unlikely(rc
< 0)) {
1040 if (!strcmp(xname
, xd
->xname
)) {
1046 memcpy(buffer
, xd
->xvalue
, rc
);
1055 up_read(&c
->xattr_sem
);
1057 up_write(&c
->xattr_sem
);
1062 int do_jffs2_setxattr(struct inode
*inode
, int xprefix
, const char *xname
,
1063 const char *buffer
, size_t size
, int flags
)
1065 struct jffs2_inode_info
*f
= JFFS2_INODE_INFO(inode
);
1066 struct jffs2_sb_info
*c
= JFFS2_SB_INFO(inode
->i_sb
);
1067 struct jffs2_inode_cache
*ic
= f
->inocache
;
1068 struct jffs2_xattr_datum
*xd
;
1069 struct jffs2_xattr_ref
*ref
, *newref
, **pref
;
1070 uint32_t phys_ofs
, length
, request
;
1073 rc
= check_xattr_ref_inode(c
, ic
);
1077 request
= PAD(sizeof(struct jffs2_raw_xattr
) + strlen(xname
) + 1 + size
);
1078 rc
= jffs2_reserve_space(c
, request
, &phys_ofs
, &length
,
1079 ALLOC_NORMAL
, JFFS2_SUMMARY_XATTR_SIZE
);
1081 JFFS2_WARNING("jffs2_reserve_space()=%d, request=%u\n", rc
, request
);
1085 /* Find existing xattr */
1086 down_write(&c
->xattr_sem
);
1088 for (ref
=ic
->xref
, pref
=&ic
->xref
; ref
; pref
=&ref
->next
, ref
=ref
->next
) {
1090 if (xd
->xprefix
!= xprefix
)
1093 rc
= load_xattr_datum(c
, xd
);
1094 if (unlikely(rc
> 0)) {
1096 delete_xattr_ref(c
, ref
);
1098 } else if (unlikely(rc
< 0))
1101 if (!strcmp(xd
->xname
, xname
)) {
1102 if (flags
& XATTR_CREATE
) {
1108 delete_xattr_ref(c
, ref
);
1116 if (flags
& XATTR_REPLACE
) {
1125 xd
= create_xattr_datum(c
, xprefix
, xname
, buffer
, size
, phys_ofs
);
1130 up_write(&c
->xattr_sem
);
1131 jffs2_complete_reservation(c
);
1133 /* create xattr_ref */
1134 request
= PAD(sizeof(struct jffs2_raw_xref
));
1135 rc
= jffs2_reserve_space(c
, request
, &phys_ofs
, &length
,
1136 ALLOC_NORMAL
, JFFS2_SUMMARY_XREF_SIZE
);
1138 JFFS2_WARNING("jffs2_reserve_space()=%d, request=%u\n", rc
, request
);
1139 down_write(&c
->xattr_sem
);
1142 delete_xattr_datum(c
, xd
);
1143 up_write(&c
->xattr_sem
);
1146 down_write(&c
->xattr_sem
);
1149 newref
= create_xattr_ref(c
, ic
, xd
, phys_ofs
);
1150 if (IS_ERR(newref
)) {
1152 ref
->next
= ic
->xref
;
1155 rc
= PTR_ERR(newref
);
1158 delete_xattr_datum(c
, xd
);
1160 delete_xattr_ref(c
, ref
);
1163 up_write(&c
->xattr_sem
);
1164 jffs2_complete_reservation(c
);
1168 /* -------- garbage collector functions -------------
1169 * jffs2_garbage_collect_xattr_datum(c, xd)
1170 * is used to move xdatum into new node.
1171 * jffs2_garbage_collect_xattr_ref(c, ref)
1172 * is used to move xref into new node.
1173 * jffs2_garbage_collect_xattr(c, ic)
1174 * is used to call appropriate garbage collector function, if argument
1175 * pointer (ic) is the reference of xdatum/xref.
1176 * jffs2_verify_xattr(c)
1177 * is used to call do_verify_xattr_datum() before garbage collecting.
1178 * -------------------------------------------------- */
1179 static int jffs2_garbage_collect_xattr_datum(struct jffs2_sb_info
*c
,
1180 struct jffs2_xattr_datum
*xd
)
1182 /* must be called under down_write(xattr_sem), and called from GC thread */
1183 uint32_t phys_ofs
, totlen
, length
, old_ofs
;
1188 old_ofs
= ref_offset(xd
->node
);
1189 totlen
= ref_totlen(c
, c
->gcblock
, xd
->node
);
1190 if (totlen
< sizeof(struct jffs2_raw_xattr
))
1194 rc
= load_xattr_datum(c
, xd
);
1195 if (unlikely(rc
> 0)) {
1196 delete_xattr_datum_node(c
, xd
);
1198 } else if (unlikely(rc
< 0))
1201 rc
= jffs2_reserve_space_gc(c
, totlen
, &phys_ofs
, &length
, JFFS2_SUMMARY_XATTR_SIZE
);
1202 if (rc
|| length
< totlen
) {
1203 JFFS2_WARNING("jffs2_reserve_space()=%d, request=%u\n", rc
, totlen
);
1204 return rc
? rc
: -EBADFD
;
1206 rc
= save_xattr_datum(c
, xd
, phys_ofs
);
1208 dbg_xattr("xdatum (xid=%u, version=%u) GC'ed from %#08x to %08x\n",
1209 xd
->xid
, xd
->version
, old_ofs
, ref_offset(xd
->node
));
1214 static int jffs2_garbage_collect_xattr_ref(struct jffs2_sb_info
*c
,
1215 struct jffs2_xattr_ref
*ref
)
1217 /* must be called under down(alloc_sem) */
1218 uint32_t phys_ofs
, totlen
, length
, old_ofs
;
1223 old_ofs
= ref_offset(ref
->node
);
1224 totlen
= ref_totlen(c
, c
->gcblock
, ref
->node
);
1225 if (totlen
!= sizeof(struct jffs2_raw_xref
))
1227 rc
= jffs2_reserve_space_gc(c
, totlen
, &phys_ofs
, &length
, JFFS2_SUMMARY_XREF_SIZE
);
1228 if (rc
|| length
< totlen
) {
1229 JFFS2_WARNING("%s: jffs2_reserve_space() = %d, request = %u\n",
1230 __FUNCTION__
, rc
, totlen
);
1231 return rc
? rc
: -EBADFD
;
1233 rc
= save_xattr_ref(c
, ref
, phys_ofs
);
1235 dbg_xattr("xref (ino=%u, xid=%u) GC'ed from %#08x to %08x\n",
1236 ref
->ic
->ino
, ref
->xd
->xid
, old_ofs
, ref_offset(ref
->node
));
1240 int jffs2_garbage_collect_xattr(struct jffs2_sb_info
*c
, struct jffs2_inode_cache
*ic
)
1242 struct jffs2_xattr_datum
*xd
;
1243 struct jffs2_xattr_ref
*ref
;
1246 switch (ic
->class) {
1247 case RAWNODE_CLASS_XATTR_DATUM
:
1248 spin_unlock(&c
->erase_completion_lock
);
1250 down_write(&c
->xattr_sem
);
1251 xd
= (struct jffs2_xattr_datum
*)ic
;
1252 ret
= xd
? jffs2_garbage_collect_xattr_datum(c
, xd
) : 0;
1253 up_write(&c
->xattr_sem
);
1255 case RAWNODE_CLASS_XATTR_REF
:
1256 spin_unlock(&c
->erase_completion_lock
);
1258 down_write(&c
->xattr_sem
);
1259 ref
= (struct jffs2_xattr_ref
*)ic
;
1260 ret
= ref
? jffs2_garbage_collect_xattr_ref(c
, ref
) : 0;
1261 up_write(&c
->xattr_sem
);
1264 /* This node is not xattr_datum/xattr_ref */
1271 int jffs2_verify_xattr(struct jffs2_sb_info
*c
)
1273 struct jffs2_xattr_datum
*xd
, *_xd
;
1276 down_write(&c
->xattr_sem
);
1277 list_for_each_entry_safe(xd
, _xd
, &c
->xattr_unchecked
, xindex
) {
1278 rc
= do_verify_xattr_datum(c
, xd
);
1280 list_del_init(&xd
->xindex
);
1282 } else if (rc
> 0) {
1283 list_del_init(&xd
->xindex
);
1284 delete_xattr_datum_node(c
, xd
);
1287 up_write(&c
->xattr_sem
);
1289 return list_empty(&c
->xattr_unchecked
) ? 1 : 0;