GNU Linux-libre 4.4.284-gnu1
[releases.git] / fs / ubifs / io.c
1 /*
2  * This file is part of UBIFS.
3  *
4  * Copyright (C) 2006-2008 Nokia Corporation.
5  * Copyright (C) 2006, 2007 University of Szeged, Hungary
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program; if not, write to the Free Software Foundation, Inc., 51
18  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  * Authors: Artem Bityutskiy (Битюцкий Артём)
21  *          Adrian Hunter
22  *          Zoltan Sogor
23  */
24
25 /*
26  * This file implements UBIFS I/O subsystem which provides various I/O-related
27  * helper functions (reading/writing/checking/validating nodes) and implements
28  * write-buffering support. Write buffers help to save space which otherwise
29  * would have been wasted for padding to the nearest minimal I/O unit boundary.
30  * Instead, data first goes to the write-buffer and is flushed when the
31  * buffer is full or when it is not used for some time (by timer). This is
32  * similar to the mechanism is used by JFFS2.
33  *
34  * UBIFS distinguishes between minimum write size (@c->min_io_size) and maximum
35  * write size (@c->max_write_size). The latter is the maximum amount of bytes
36  * the underlying flash is able to program at a time, and writing in
37  * @c->max_write_size units should presumably be faster. Obviously,
38  * @c->min_io_size <= @c->max_write_size. Write-buffers are of
39  * @c->max_write_size bytes in size for maximum performance. However, when a
40  * write-buffer is flushed, only the portion of it (aligned to @c->min_io_size
41  * boundary) which contains data is written, not the whole write-buffer,
42  * because this is more space-efficient.
43  *
44  * This optimization adds few complications to the code. Indeed, on the one
45  * hand, we want to write in optimal @c->max_write_size bytes chunks, which
46  * also means aligning writes at the @c->max_write_size bytes offsets. On the
47  * other hand, we do not want to waste space when synchronizing the write
48  * buffer, so during synchronization we writes in smaller chunks. And this makes
49  * the next write offset to be not aligned to @c->max_write_size bytes. So the
50  * have to make sure that the write-buffer offset (@wbuf->offs) becomes aligned
51  * to @c->max_write_size bytes again. We do this by temporarily shrinking
52  * write-buffer size (@wbuf->size).
53  *
54  * Write-buffers are defined by 'struct ubifs_wbuf' objects and protected by
55  * mutexes defined inside these objects. Since sometimes upper-level code
56  * has to lock the write-buffer (e.g. journal space reservation code), many
57  * functions related to write-buffers have "nolock" suffix which means that the
58  * caller has to lock the write-buffer before calling this function.
59  *
60  * UBIFS stores nodes at 64 bit-aligned addresses. If the node length is not
61  * aligned, UBIFS starts the next node from the aligned address, and the padded
62  * bytes may contain any rubbish. In other words, UBIFS does not put padding
63  * bytes in those small gaps. Common headers of nodes store real node lengths,
64  * not aligned lengths. Indexing nodes also store real lengths in branches.
65  *
66  * UBIFS uses padding when it pads to the next min. I/O unit. In this case it
67  * uses padding nodes or padding bytes, if the padding node does not fit.
68  *
69  * All UBIFS nodes are protected by CRC checksums and UBIFS checks CRC when
70  * they are read from the flash media.
71  */
72
73 #include <linux/crc32.h>
74 #include <linux/slab.h>
75 #include "ubifs.h"
76
77 /**
78  * ubifs_ro_mode - switch UBIFS to read read-only mode.
79  * @c: UBIFS file-system description object
80  * @err: error code which is the reason of switching to R/O mode
81  */
82 void ubifs_ro_mode(struct ubifs_info *c, int err)
83 {
84         if (!c->ro_error) {
85                 c->ro_error = 1;
86                 c->no_chk_data_crc = 0;
87                 c->vfs_sb->s_flags |= MS_RDONLY;
88                 ubifs_warn(c, "switched to read-only mode, error %d", err);
89                 dump_stack();
90         }
91 }
92
93 /*
94  * Below are simple wrappers over UBI I/O functions which include some
95  * additional checks and UBIFS debugging stuff. See corresponding UBI function
96  * for more information.
97  */
98
99 int ubifs_leb_read(const struct ubifs_info *c, int lnum, void *buf, int offs,
100                    int len, int even_ebadmsg)
101 {
102         int err;
103
104         err = ubi_read(c->ubi, lnum, buf, offs, len);
105         /*
106          * In case of %-EBADMSG print the error message only if the
107          * @even_ebadmsg is true.
108          */
109         if (err && (err != -EBADMSG || even_ebadmsg)) {
110                 ubifs_err(c, "reading %d bytes from LEB %d:%d failed, error %d",
111                           len, lnum, offs, err);
112                 dump_stack();
113         }
114         return err;
115 }
116
117 int ubifs_leb_write(struct ubifs_info *c, int lnum, const void *buf, int offs,
118                     int len)
119 {
120         int err;
121
122         ubifs_assert(!c->ro_media && !c->ro_mount);
123         if (c->ro_error)
124                 return -EROFS;
125         if (!dbg_is_tst_rcvry(c))
126                 err = ubi_leb_write(c->ubi, lnum, buf, offs, len);
127         else
128                 err = dbg_leb_write(c, lnum, buf, offs, len);
129         if (err) {
130                 ubifs_err(c, "writing %d bytes to LEB %d:%d failed, error %d",
131                           len, lnum, offs, err);
132                 ubifs_ro_mode(c, err);
133                 dump_stack();
134         }
135         return err;
136 }
137
138 int ubifs_leb_change(struct ubifs_info *c, int lnum, const void *buf, int len)
139 {
140         int err;
141
142         ubifs_assert(!c->ro_media && !c->ro_mount);
143         if (c->ro_error)
144                 return -EROFS;
145         if (!dbg_is_tst_rcvry(c))
146                 err = ubi_leb_change(c->ubi, lnum, buf, len);
147         else
148                 err = dbg_leb_change(c, lnum, buf, len);
149         if (err) {
150                 ubifs_err(c, "changing %d bytes in LEB %d failed, error %d",
151                           len, lnum, err);
152                 ubifs_ro_mode(c, err);
153                 dump_stack();
154         }
155         return err;
156 }
157
158 int ubifs_leb_unmap(struct ubifs_info *c, int lnum)
159 {
160         int err;
161
162         ubifs_assert(!c->ro_media && !c->ro_mount);
163         if (c->ro_error)
164                 return -EROFS;
165         if (!dbg_is_tst_rcvry(c))
166                 err = ubi_leb_unmap(c->ubi, lnum);
167         else
168                 err = dbg_leb_unmap(c, lnum);
169         if (err) {
170                 ubifs_err(c, "unmap LEB %d failed, error %d", lnum, err);
171                 ubifs_ro_mode(c, err);
172                 dump_stack();
173         }
174         return err;
175 }
176
177 int ubifs_leb_map(struct ubifs_info *c, int lnum)
178 {
179         int err;
180
181         ubifs_assert(!c->ro_media && !c->ro_mount);
182         if (c->ro_error)
183                 return -EROFS;
184         if (!dbg_is_tst_rcvry(c))
185                 err = ubi_leb_map(c->ubi, lnum);
186         else
187                 err = dbg_leb_map(c, lnum);
188         if (err) {
189                 ubifs_err(c, "mapping LEB %d failed, error %d", lnum, err);
190                 ubifs_ro_mode(c, err);
191                 dump_stack();
192         }
193         return err;
194 }
195
196 int ubifs_is_mapped(const struct ubifs_info *c, int lnum)
197 {
198         int err;
199
200         err = ubi_is_mapped(c->ubi, lnum);
201         if (err < 0) {
202                 ubifs_err(c, "ubi_is_mapped failed for LEB %d, error %d",
203                           lnum, err);
204                 dump_stack();
205         }
206         return err;
207 }
208
209 /**
210  * ubifs_check_node - check node.
211  * @c: UBIFS file-system description object
212  * @buf: node to check
213  * @lnum: logical eraseblock number
214  * @offs: offset within the logical eraseblock
215  * @quiet: print no messages
216  * @must_chk_crc: indicates whether to always check the CRC
217  *
218  * This function checks node magic number and CRC checksum. This function also
219  * validates node length to prevent UBIFS from becoming crazy when an attacker
220  * feeds it a file-system image with incorrect nodes. For example, too large
221  * node length in the common header could cause UBIFS to read memory outside of
222  * allocated buffer when checking the CRC checksum.
223  *
224  * This function may skip data nodes CRC checking if @c->no_chk_data_crc is
225  * true, which is controlled by corresponding UBIFS mount option. However, if
226  * @must_chk_crc is true, then @c->no_chk_data_crc is ignored and CRC is
227  * checked. Similarly, if @c->mounting or @c->remounting_rw is true (we are
228  * mounting or re-mounting to R/W mode), @c->no_chk_data_crc is ignored and CRC
229  * is checked. This is because during mounting or re-mounting from R/O mode to
230  * R/W mode we may read journal nodes (when replying the journal or doing the
231  * recovery) and the journal nodes may potentially be corrupted, so checking is
232  * required.
233  *
234  * This function returns zero in case of success and %-EUCLEAN in case of bad
235  * CRC or magic.
236  */
237 int ubifs_check_node(const struct ubifs_info *c, const void *buf, int lnum,
238                      int offs, int quiet, int must_chk_crc)
239 {
240         int err = -EINVAL, type, node_len, dump_node = 1;
241         uint32_t crc, node_crc, magic;
242         const struct ubifs_ch *ch = buf;
243
244         ubifs_assert(lnum >= 0 && lnum < c->leb_cnt && offs >= 0);
245         ubifs_assert(!(offs & 7) && offs < c->leb_size);
246
247         magic = le32_to_cpu(ch->magic);
248         if (magic != UBIFS_NODE_MAGIC) {
249                 if (!quiet)
250                         ubifs_err(c, "bad magic %#08x, expected %#08x",
251                                   magic, UBIFS_NODE_MAGIC);
252                 err = -EUCLEAN;
253                 goto out;
254         }
255
256         type = ch->node_type;
257         if (type < 0 || type >= UBIFS_NODE_TYPES_CNT) {
258                 if (!quiet)
259                         ubifs_err(c, "bad node type %d", type);
260                 goto out;
261         }
262
263         node_len = le32_to_cpu(ch->len);
264         if (node_len + offs > c->leb_size)
265                 goto out_len;
266
267         if (c->ranges[type].max_len == 0) {
268                 if (node_len != c->ranges[type].len)
269                         goto out_len;
270         } else if (node_len < c->ranges[type].min_len ||
271                    node_len > c->ranges[type].max_len)
272                 goto out_len;
273
274         if (!must_chk_crc && type == UBIFS_DATA_NODE && !c->mounting &&
275             !c->remounting_rw && c->no_chk_data_crc)
276                 return 0;
277
278         crc = crc32(UBIFS_CRC32_INIT, buf + 8, node_len - 8);
279         node_crc = le32_to_cpu(ch->crc);
280         if (crc != node_crc) {
281                 if (!quiet)
282                         ubifs_err(c, "bad CRC: calculated %#08x, read %#08x",
283                                   crc, node_crc);
284                 err = -EUCLEAN;
285                 goto out;
286         }
287
288         return 0;
289
290 out_len:
291         if (!quiet)
292                 ubifs_err(c, "bad node length %d", node_len);
293         if (type == UBIFS_DATA_NODE && node_len > UBIFS_DATA_NODE_SZ)
294                 dump_node = 0;
295 out:
296         if (!quiet) {
297                 ubifs_err(c, "bad node at LEB %d:%d", lnum, offs);
298                 if (dump_node) {
299                         ubifs_dump_node(c, buf);
300                 } else {
301                         int safe_len = min3(node_len, c->leb_size - offs,
302                                 (int)UBIFS_MAX_DATA_NODE_SZ);
303                         pr_err("\tprevent out-of-bounds memory access\n");
304                         pr_err("\ttruncated data node length      %d\n", safe_len);
305                         pr_err("\tcorrupted data node:\n");
306                         print_hex_dump(KERN_ERR, "\t", DUMP_PREFIX_OFFSET, 32, 1,
307                                         buf, safe_len, 0);
308                 }
309                 dump_stack();
310         }
311         return err;
312 }
313
314 /**
315  * ubifs_pad - pad flash space.
316  * @c: UBIFS file-system description object
317  * @buf: buffer to put padding to
318  * @pad: how many bytes to pad
319  *
320  * The flash media obliges us to write only in chunks of %c->min_io_size and
321  * when we have to write less data we add padding node to the write-buffer and
322  * pad it to the next minimal I/O unit's boundary. Padding nodes help when the
323  * media is being scanned. If the amount of wasted space is not enough to fit a
324  * padding node which takes %UBIFS_PAD_NODE_SZ bytes, we write padding bytes
325  * pattern (%UBIFS_PADDING_BYTE).
326  *
327  * Padding nodes are also used to fill gaps when the "commit-in-gaps" method is
328  * used.
329  */
330 void ubifs_pad(const struct ubifs_info *c, void *buf, int pad)
331 {
332         uint32_t crc;
333
334         ubifs_assert(pad >= 0);
335
336         if (pad >= UBIFS_PAD_NODE_SZ) {
337                 struct ubifs_ch *ch = buf;
338                 struct ubifs_pad_node *pad_node = buf;
339
340                 ch->magic = cpu_to_le32(UBIFS_NODE_MAGIC);
341                 ch->node_type = UBIFS_PAD_NODE;
342                 ch->group_type = UBIFS_NO_NODE_GROUP;
343                 ch->padding[0] = ch->padding[1] = 0;
344                 ch->sqnum = 0;
345                 ch->len = cpu_to_le32(UBIFS_PAD_NODE_SZ);
346                 pad -= UBIFS_PAD_NODE_SZ;
347                 pad_node->pad_len = cpu_to_le32(pad);
348                 crc = crc32(UBIFS_CRC32_INIT, buf + 8, UBIFS_PAD_NODE_SZ - 8);
349                 ch->crc = cpu_to_le32(crc);
350                 memset(buf + UBIFS_PAD_NODE_SZ, 0, pad);
351         } else if (pad > 0)
352                 /* Too little space, padding node won't fit */
353                 memset(buf, UBIFS_PADDING_BYTE, pad);
354 }
355
356 /**
357  * next_sqnum - get next sequence number.
358  * @c: UBIFS file-system description object
359  */
360 static unsigned long long next_sqnum(struct ubifs_info *c)
361 {
362         unsigned long long sqnum;
363
364         spin_lock(&c->cnt_lock);
365         sqnum = ++c->max_sqnum;
366         spin_unlock(&c->cnt_lock);
367
368         if (unlikely(sqnum >= SQNUM_WARN_WATERMARK)) {
369                 if (sqnum >= SQNUM_WATERMARK) {
370                         ubifs_err(c, "sequence number overflow %llu, end of life",
371                                   sqnum);
372                         ubifs_ro_mode(c, -EINVAL);
373                 }
374                 ubifs_warn(c, "running out of sequence numbers, end of life soon");
375         }
376
377         return sqnum;
378 }
379
380 /**
381  * ubifs_prepare_node - prepare node to be written to flash.
382  * @c: UBIFS file-system description object
383  * @node: the node to pad
384  * @len: node length
385  * @pad: if the buffer has to be padded
386  *
387  * This function prepares node at @node to be written to the media - it
388  * calculates node CRC, fills the common header, and adds proper padding up to
389  * the next minimum I/O unit if @pad is not zero.
390  */
391 void ubifs_prepare_node(struct ubifs_info *c, void *node, int len, int pad)
392 {
393         uint32_t crc;
394         struct ubifs_ch *ch = node;
395         unsigned long long sqnum = next_sqnum(c);
396
397         ubifs_assert(len >= UBIFS_CH_SZ);
398
399         ch->magic = cpu_to_le32(UBIFS_NODE_MAGIC);
400         ch->len = cpu_to_le32(len);
401         ch->group_type = UBIFS_NO_NODE_GROUP;
402         ch->sqnum = cpu_to_le64(sqnum);
403         ch->padding[0] = ch->padding[1] = 0;
404         crc = crc32(UBIFS_CRC32_INIT, node + 8, len - 8);
405         ch->crc = cpu_to_le32(crc);
406
407         if (pad) {
408                 len = ALIGN(len, 8);
409                 pad = ALIGN(len, c->min_io_size) - len;
410                 ubifs_pad(c, node + len, pad);
411         }
412 }
413
414 /**
415  * ubifs_prep_grp_node - prepare node of a group to be written to flash.
416  * @c: UBIFS file-system description object
417  * @node: the node to pad
418  * @len: node length
419  * @last: indicates the last node of the group
420  *
421  * This function prepares node at @node to be written to the media - it
422  * calculates node CRC and fills the common header.
423  */
424 void ubifs_prep_grp_node(struct ubifs_info *c, void *node, int len, int last)
425 {
426         uint32_t crc;
427         struct ubifs_ch *ch = node;
428         unsigned long long sqnum = next_sqnum(c);
429
430         ubifs_assert(len >= UBIFS_CH_SZ);
431
432         ch->magic = cpu_to_le32(UBIFS_NODE_MAGIC);
433         ch->len = cpu_to_le32(len);
434         if (last)
435                 ch->group_type = UBIFS_LAST_OF_NODE_GROUP;
436         else
437                 ch->group_type = UBIFS_IN_NODE_GROUP;
438         ch->sqnum = cpu_to_le64(sqnum);
439         ch->padding[0] = ch->padding[1] = 0;
440         crc = crc32(UBIFS_CRC32_INIT, node + 8, len - 8);
441         ch->crc = cpu_to_le32(crc);
442 }
443
444 /**
445  * wbuf_timer_callback - write-buffer timer callback function.
446  * @timer: timer data (write-buffer descriptor)
447  *
448  * This function is called when the write-buffer timer expires.
449  */
450 static enum hrtimer_restart wbuf_timer_callback_nolock(struct hrtimer *timer)
451 {
452         struct ubifs_wbuf *wbuf = container_of(timer, struct ubifs_wbuf, timer);
453
454         dbg_io("jhead %s", dbg_jhead(wbuf->jhead));
455         wbuf->need_sync = 1;
456         wbuf->c->need_wbuf_sync = 1;
457         ubifs_wake_up_bgt(wbuf->c);
458         return HRTIMER_NORESTART;
459 }
460
461 /**
462  * new_wbuf_timer - start new write-buffer timer.
463  * @wbuf: write-buffer descriptor
464  */
465 static void new_wbuf_timer_nolock(struct ubifs_wbuf *wbuf)
466 {
467         ubifs_assert(!hrtimer_active(&wbuf->timer));
468
469         if (wbuf->no_timer)
470                 return;
471         dbg_io("set timer for jhead %s, %llu-%llu millisecs",
472                dbg_jhead(wbuf->jhead),
473                div_u64(ktime_to_ns(wbuf->softlimit), USEC_PER_SEC),
474                div_u64(ktime_to_ns(wbuf->softlimit) + wbuf->delta,
475                        USEC_PER_SEC));
476         hrtimer_start_range_ns(&wbuf->timer, wbuf->softlimit, wbuf->delta,
477                                HRTIMER_MODE_REL);
478 }
479
480 /**
481  * cancel_wbuf_timer - cancel write-buffer timer.
482  * @wbuf: write-buffer descriptor
483  */
484 static void cancel_wbuf_timer_nolock(struct ubifs_wbuf *wbuf)
485 {
486         if (wbuf->no_timer)
487                 return;
488         wbuf->need_sync = 0;
489         hrtimer_cancel(&wbuf->timer);
490 }
491
492 /**
493  * ubifs_wbuf_sync_nolock - synchronize write-buffer.
494  * @wbuf: write-buffer to synchronize
495  *
496  * This function synchronizes write-buffer @buf and returns zero in case of
497  * success or a negative error code in case of failure.
498  *
499  * Note, although write-buffers are of @c->max_write_size, this function does
500  * not necessarily writes all @c->max_write_size bytes to the flash. Instead,
501  * if the write-buffer is only partially filled with data, only the used part
502  * of the write-buffer (aligned on @c->min_io_size boundary) is synchronized.
503  * This way we waste less space.
504  */
505 int ubifs_wbuf_sync_nolock(struct ubifs_wbuf *wbuf)
506 {
507         struct ubifs_info *c = wbuf->c;
508         int err, dirt, sync_len;
509
510         cancel_wbuf_timer_nolock(wbuf);
511         if (!wbuf->used || wbuf->lnum == -1)
512                 /* Write-buffer is empty or not seeked */
513                 return 0;
514
515         dbg_io("LEB %d:%d, %d bytes, jhead %s",
516                wbuf->lnum, wbuf->offs, wbuf->used, dbg_jhead(wbuf->jhead));
517         ubifs_assert(!(wbuf->avail & 7));
518         ubifs_assert(wbuf->offs + wbuf->size <= c->leb_size);
519         ubifs_assert(wbuf->size >= c->min_io_size);
520         ubifs_assert(wbuf->size <= c->max_write_size);
521         ubifs_assert(wbuf->size % c->min_io_size == 0);
522         ubifs_assert(!c->ro_media && !c->ro_mount);
523         if (c->leb_size - wbuf->offs >= c->max_write_size)
524                 ubifs_assert(!((wbuf->offs + wbuf->size) % c->max_write_size));
525
526         if (c->ro_error)
527                 return -EROFS;
528
529         /*
530          * Do not write whole write buffer but write only the minimum necessary
531          * amount of min. I/O units.
532          */
533         sync_len = ALIGN(wbuf->used, c->min_io_size);
534         dirt = sync_len - wbuf->used;
535         if (dirt)
536                 ubifs_pad(c, wbuf->buf + wbuf->used, dirt);
537         err = ubifs_leb_write(c, wbuf->lnum, wbuf->buf, wbuf->offs, sync_len);
538         if (err)
539                 return err;
540
541         spin_lock(&wbuf->lock);
542         wbuf->offs += sync_len;
543         /*
544          * Now @wbuf->offs is not necessarily aligned to @c->max_write_size.
545          * But our goal is to optimize writes and make sure we write in
546          * @c->max_write_size chunks and to @c->max_write_size-aligned offset.
547          * Thus, if @wbuf->offs is not aligned to @c->max_write_size now, make
548          * sure that @wbuf->offs + @wbuf->size is aligned to
549          * @c->max_write_size. This way we make sure that after next
550          * write-buffer flush we are again at the optimal offset (aligned to
551          * @c->max_write_size).
552          */
553         if (c->leb_size - wbuf->offs < c->max_write_size)
554                 wbuf->size = c->leb_size - wbuf->offs;
555         else if (wbuf->offs & (c->max_write_size - 1))
556                 wbuf->size = ALIGN(wbuf->offs, c->max_write_size) - wbuf->offs;
557         else
558                 wbuf->size = c->max_write_size;
559         wbuf->avail = wbuf->size;
560         wbuf->used = 0;
561         wbuf->next_ino = 0;
562         spin_unlock(&wbuf->lock);
563
564         if (wbuf->sync_callback)
565                 err = wbuf->sync_callback(c, wbuf->lnum,
566                                           c->leb_size - wbuf->offs, dirt);
567         return err;
568 }
569
570 /**
571  * ubifs_wbuf_seek_nolock - seek write-buffer.
572  * @wbuf: write-buffer
573  * @lnum: logical eraseblock number to seek to
574  * @offs: logical eraseblock offset to seek to
575  *
576  * This function targets the write-buffer to logical eraseblock @lnum:@offs.
577  * The write-buffer has to be empty. Returns zero in case of success and a
578  * negative error code in case of failure.
579  */
580 int ubifs_wbuf_seek_nolock(struct ubifs_wbuf *wbuf, int lnum, int offs)
581 {
582         const struct ubifs_info *c = wbuf->c;
583
584         dbg_io("LEB %d:%d, jhead %s", lnum, offs, dbg_jhead(wbuf->jhead));
585         ubifs_assert(lnum >= 0 && lnum < c->leb_cnt);
586         ubifs_assert(offs >= 0 && offs <= c->leb_size);
587         ubifs_assert(offs % c->min_io_size == 0 && !(offs & 7));
588         ubifs_assert(lnum != wbuf->lnum);
589         ubifs_assert(wbuf->used == 0);
590
591         spin_lock(&wbuf->lock);
592         wbuf->lnum = lnum;
593         wbuf->offs = offs;
594         if (c->leb_size - wbuf->offs < c->max_write_size)
595                 wbuf->size = c->leb_size - wbuf->offs;
596         else if (wbuf->offs & (c->max_write_size - 1))
597                 wbuf->size = ALIGN(wbuf->offs, c->max_write_size) - wbuf->offs;
598         else
599                 wbuf->size = c->max_write_size;
600         wbuf->avail = wbuf->size;
601         wbuf->used = 0;
602         spin_unlock(&wbuf->lock);
603
604         return 0;
605 }
606
607 /**
608  * ubifs_bg_wbufs_sync - synchronize write-buffers.
609  * @c: UBIFS file-system description object
610  *
611  * This function is called by background thread to synchronize write-buffers.
612  * Returns zero in case of success and a negative error code in case of
613  * failure.
614  */
615 int ubifs_bg_wbufs_sync(struct ubifs_info *c)
616 {
617         int err, i;
618
619         ubifs_assert(!c->ro_media && !c->ro_mount);
620         if (!c->need_wbuf_sync)
621                 return 0;
622         c->need_wbuf_sync = 0;
623
624         if (c->ro_error) {
625                 err = -EROFS;
626                 goto out_timers;
627         }
628
629         dbg_io("synchronize");
630         for (i = 0; i < c->jhead_cnt; i++) {
631                 struct ubifs_wbuf *wbuf = &c->jheads[i].wbuf;
632
633                 cond_resched();
634
635                 /*
636                  * If the mutex is locked then wbuf is being changed, so
637                  * synchronization is not necessary.
638                  */
639                 if (mutex_is_locked(&wbuf->io_mutex))
640                         continue;
641
642                 mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
643                 if (!wbuf->need_sync) {
644                         mutex_unlock(&wbuf->io_mutex);
645                         continue;
646                 }
647
648                 err = ubifs_wbuf_sync_nolock(wbuf);
649                 mutex_unlock(&wbuf->io_mutex);
650                 if (err) {
651                         ubifs_err(c, "cannot sync write-buffer, error %d", err);
652                         ubifs_ro_mode(c, err);
653                         goto out_timers;
654                 }
655         }
656
657         return 0;
658
659 out_timers:
660         /* Cancel all timers to prevent repeated errors */
661         for (i = 0; i < c->jhead_cnt; i++) {
662                 struct ubifs_wbuf *wbuf = &c->jheads[i].wbuf;
663
664                 mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
665                 cancel_wbuf_timer_nolock(wbuf);
666                 mutex_unlock(&wbuf->io_mutex);
667         }
668         return err;
669 }
670
671 /**
672  * ubifs_wbuf_write_nolock - write data to flash via write-buffer.
673  * @wbuf: write-buffer
674  * @buf: node to write
675  * @len: node length
676  *
677  * This function writes data to flash via write-buffer @wbuf. This means that
678  * the last piece of the node won't reach the flash media immediately if it
679  * does not take whole max. write unit (@c->max_write_size). Instead, the node
680  * will sit in RAM until the write-buffer is synchronized (e.g., by timer, or
681  * because more data are appended to the write-buffer).
682  *
683  * This function returns zero in case of success and a negative error code in
684  * case of failure. If the node cannot be written because there is no more
685  * space in this logical eraseblock, %-ENOSPC is returned.
686  */
687 int ubifs_wbuf_write_nolock(struct ubifs_wbuf *wbuf, void *buf, int len)
688 {
689         struct ubifs_info *c = wbuf->c;
690         int err, written, n, aligned_len = ALIGN(len, 8);
691
692         dbg_io("%d bytes (%s) to jhead %s wbuf at LEB %d:%d", len,
693                dbg_ntype(((struct ubifs_ch *)buf)->node_type),
694                dbg_jhead(wbuf->jhead), wbuf->lnum, wbuf->offs + wbuf->used);
695         ubifs_assert(len > 0 && wbuf->lnum >= 0 && wbuf->lnum < c->leb_cnt);
696         ubifs_assert(wbuf->offs >= 0 && wbuf->offs % c->min_io_size == 0);
697         ubifs_assert(!(wbuf->offs & 7) && wbuf->offs <= c->leb_size);
698         ubifs_assert(wbuf->avail > 0 && wbuf->avail <= wbuf->size);
699         ubifs_assert(wbuf->size >= c->min_io_size);
700         ubifs_assert(wbuf->size <= c->max_write_size);
701         ubifs_assert(wbuf->size % c->min_io_size == 0);
702         ubifs_assert(mutex_is_locked(&wbuf->io_mutex));
703         ubifs_assert(!c->ro_media && !c->ro_mount);
704         ubifs_assert(!c->space_fixup);
705         if (c->leb_size - wbuf->offs >= c->max_write_size)
706                 ubifs_assert(!((wbuf->offs + wbuf->size) % c->max_write_size));
707
708         if (c->leb_size - wbuf->offs - wbuf->used < aligned_len) {
709                 err = -ENOSPC;
710                 goto out;
711         }
712
713         cancel_wbuf_timer_nolock(wbuf);
714
715         if (c->ro_error)
716                 return -EROFS;
717
718         if (aligned_len <= wbuf->avail) {
719                 /*
720                  * The node is not very large and fits entirely within
721                  * write-buffer.
722                  */
723                 memcpy(wbuf->buf + wbuf->used, buf, len);
724                 if (aligned_len > len) {
725                         ubifs_assert(aligned_len - len < 8);
726                         ubifs_pad(c, wbuf->buf + wbuf->used + len, aligned_len - len);
727                 }
728
729                 if (aligned_len == wbuf->avail) {
730                         dbg_io("flush jhead %s wbuf to LEB %d:%d",
731                                dbg_jhead(wbuf->jhead), wbuf->lnum, wbuf->offs);
732                         err = ubifs_leb_write(c, wbuf->lnum, wbuf->buf,
733                                               wbuf->offs, wbuf->size);
734                         if (err)
735                                 goto out;
736
737                         spin_lock(&wbuf->lock);
738                         wbuf->offs += wbuf->size;
739                         if (c->leb_size - wbuf->offs >= c->max_write_size)
740                                 wbuf->size = c->max_write_size;
741                         else
742                                 wbuf->size = c->leb_size - wbuf->offs;
743                         wbuf->avail = wbuf->size;
744                         wbuf->used = 0;
745                         wbuf->next_ino = 0;
746                         spin_unlock(&wbuf->lock);
747                 } else {
748                         spin_lock(&wbuf->lock);
749                         wbuf->avail -= aligned_len;
750                         wbuf->used += aligned_len;
751                         spin_unlock(&wbuf->lock);
752                 }
753
754                 goto exit;
755         }
756
757         written = 0;
758
759         if (wbuf->used) {
760                 /*
761                  * The node is large enough and does not fit entirely within
762                  * current available space. We have to fill and flush
763                  * write-buffer and switch to the next max. write unit.
764                  */
765                 dbg_io("flush jhead %s wbuf to LEB %d:%d",
766                        dbg_jhead(wbuf->jhead), wbuf->lnum, wbuf->offs);
767                 memcpy(wbuf->buf + wbuf->used, buf, wbuf->avail);
768                 err = ubifs_leb_write(c, wbuf->lnum, wbuf->buf, wbuf->offs,
769                                       wbuf->size);
770                 if (err)
771                         goto out;
772
773                 wbuf->offs += wbuf->size;
774                 len -= wbuf->avail;
775                 aligned_len -= wbuf->avail;
776                 written += wbuf->avail;
777         } else if (wbuf->offs & (c->max_write_size - 1)) {
778                 /*
779                  * The write-buffer offset is not aligned to
780                  * @c->max_write_size and @wbuf->size is less than
781                  * @c->max_write_size. Write @wbuf->size bytes to make sure the
782                  * following writes are done in optimal @c->max_write_size
783                  * chunks.
784                  */
785                 dbg_io("write %d bytes to LEB %d:%d",
786                        wbuf->size, wbuf->lnum, wbuf->offs);
787                 err = ubifs_leb_write(c, wbuf->lnum, buf, wbuf->offs,
788                                       wbuf->size);
789                 if (err)
790                         goto out;
791
792                 wbuf->offs += wbuf->size;
793                 len -= wbuf->size;
794                 aligned_len -= wbuf->size;
795                 written += wbuf->size;
796         }
797
798         /*
799          * The remaining data may take more whole max. write units, so write the
800          * remains multiple to max. write unit size directly to the flash media.
801          * We align node length to 8-byte boundary because we anyway flash wbuf
802          * if the remaining space is less than 8 bytes.
803          */
804         n = aligned_len >> c->max_write_shift;
805         if (n) {
806                 n <<= c->max_write_shift;
807                 dbg_io("write %d bytes to LEB %d:%d", n, wbuf->lnum,
808                        wbuf->offs);
809                 err = ubifs_leb_write(c, wbuf->lnum, buf + written,
810                                       wbuf->offs, n);
811                 if (err)
812                         goto out;
813                 wbuf->offs += n;
814                 aligned_len -= n;
815                 len -= n;
816                 written += n;
817         }
818
819         spin_lock(&wbuf->lock);
820         if (aligned_len) {
821                 /*
822                  * And now we have what's left and what does not take whole
823                  * max. write unit, so write it to the write-buffer and we are
824                  * done.
825                  */
826                 memcpy(wbuf->buf, buf + written, len);
827                 if (aligned_len > len) {
828                         ubifs_assert(aligned_len - len < 8);
829                         ubifs_pad(c, wbuf->buf + len, aligned_len - len);
830                 }
831         }
832
833         if (c->leb_size - wbuf->offs >= c->max_write_size)
834                 wbuf->size = c->max_write_size;
835         else
836                 wbuf->size = c->leb_size - wbuf->offs;
837         wbuf->avail = wbuf->size - aligned_len;
838         wbuf->used = aligned_len;
839         wbuf->next_ino = 0;
840         spin_unlock(&wbuf->lock);
841
842 exit:
843         if (wbuf->sync_callback) {
844                 int free = c->leb_size - wbuf->offs - wbuf->used;
845
846                 err = wbuf->sync_callback(c, wbuf->lnum, free, 0);
847                 if (err)
848                         goto out;
849         }
850
851         if (wbuf->used)
852                 new_wbuf_timer_nolock(wbuf);
853
854         return 0;
855
856 out:
857         ubifs_err(c, "cannot write %d bytes to LEB %d:%d, error %d",
858                   len, wbuf->lnum, wbuf->offs, err);
859         ubifs_dump_node(c, buf);
860         dump_stack();
861         ubifs_dump_leb(c, wbuf->lnum);
862         return err;
863 }
864
865 /**
866  * ubifs_write_node - write node to the media.
867  * @c: UBIFS file-system description object
868  * @buf: the node to write
869  * @len: node length
870  * @lnum: logical eraseblock number
871  * @offs: offset within the logical eraseblock
872  *
873  * This function automatically fills node magic number, assigns sequence
874  * number, and calculates node CRC checksum. The length of the @buf buffer has
875  * to be aligned to the minimal I/O unit size. This function automatically
876  * appends padding node and padding bytes if needed. Returns zero in case of
877  * success and a negative error code in case of failure.
878  */
879 int ubifs_write_node(struct ubifs_info *c, void *buf, int len, int lnum,
880                      int offs)
881 {
882         int err, buf_len = ALIGN(len, c->min_io_size);
883
884         dbg_io("LEB %d:%d, %s, length %d (aligned %d)",
885                lnum, offs, dbg_ntype(((struct ubifs_ch *)buf)->node_type), len,
886                buf_len);
887         ubifs_assert(lnum >= 0 && lnum < c->leb_cnt && offs >= 0);
888         ubifs_assert(offs % c->min_io_size == 0 && offs < c->leb_size);
889         ubifs_assert(!c->ro_media && !c->ro_mount);
890         ubifs_assert(!c->space_fixup);
891
892         if (c->ro_error)
893                 return -EROFS;
894
895         ubifs_prepare_node(c, buf, len, 1);
896         err = ubifs_leb_write(c, lnum, buf, offs, buf_len);
897         if (err)
898                 ubifs_dump_node(c, buf);
899
900         return err;
901 }
902
903 /**
904  * ubifs_read_node_wbuf - read node from the media or write-buffer.
905  * @wbuf: wbuf to check for un-written data
906  * @buf: buffer to read to
907  * @type: node type
908  * @len: node length
909  * @lnum: logical eraseblock number
910  * @offs: offset within the logical eraseblock
911  *
912  * This function reads a node of known type and length, checks it and stores
913  * in @buf. If the node partially or fully sits in the write-buffer, this
914  * function takes data from the buffer, otherwise it reads the flash media.
915  * Returns zero in case of success, %-EUCLEAN if CRC mismatched and a negative
916  * error code in case of failure.
917  */
918 int ubifs_read_node_wbuf(struct ubifs_wbuf *wbuf, void *buf, int type, int len,
919                          int lnum, int offs)
920 {
921         const struct ubifs_info *c = wbuf->c;
922         int err, rlen, overlap;
923         struct ubifs_ch *ch = buf;
924
925         dbg_io("LEB %d:%d, %s, length %d, jhead %s", lnum, offs,
926                dbg_ntype(type), len, dbg_jhead(wbuf->jhead));
927         ubifs_assert(wbuf && lnum >= 0 && lnum < c->leb_cnt && offs >= 0);
928         ubifs_assert(!(offs & 7) && offs < c->leb_size);
929         ubifs_assert(type >= 0 && type < UBIFS_NODE_TYPES_CNT);
930
931         spin_lock(&wbuf->lock);
932         overlap = (lnum == wbuf->lnum && offs + len > wbuf->offs);
933         if (!overlap) {
934                 /* We may safely unlock the write-buffer and read the data */
935                 spin_unlock(&wbuf->lock);
936                 return ubifs_read_node(c, buf, type, len, lnum, offs);
937         }
938
939         /* Don't read under wbuf */
940         rlen = wbuf->offs - offs;
941         if (rlen < 0)
942                 rlen = 0;
943
944         /* Copy the rest from the write-buffer */
945         memcpy(buf + rlen, wbuf->buf + offs + rlen - wbuf->offs, len - rlen);
946         spin_unlock(&wbuf->lock);
947
948         if (rlen > 0) {
949                 /* Read everything that goes before write-buffer */
950                 err = ubifs_leb_read(c, lnum, buf, offs, rlen, 0);
951                 if (err && err != -EBADMSG)
952                         return err;
953         }
954
955         if (type != ch->node_type) {
956                 ubifs_err(c, "bad node type (%d but expected %d)",
957                           ch->node_type, type);
958                 goto out;
959         }
960
961         err = ubifs_check_node(c, buf, lnum, offs, 0, 0);
962         if (err) {
963                 ubifs_err(c, "expected node type %d", type);
964                 return err;
965         }
966
967         rlen = le32_to_cpu(ch->len);
968         if (rlen != len) {
969                 ubifs_err(c, "bad node length %d, expected %d", rlen, len);
970                 goto out;
971         }
972
973         return 0;
974
975 out:
976         ubifs_err(c, "bad node at LEB %d:%d", lnum, offs);
977         ubifs_dump_node(c, buf);
978         dump_stack();
979         return -EINVAL;
980 }
981
982 /**
983  * ubifs_read_node - read node.
984  * @c: UBIFS file-system description object
985  * @buf: buffer to read to
986  * @type: node type
987  * @len: node length (not aligned)
988  * @lnum: logical eraseblock number
989  * @offs: offset within the logical eraseblock
990  *
991  * This function reads a node of known type and and length, checks it and
992  * stores in @buf. Returns zero in case of success, %-EUCLEAN if CRC mismatched
993  * and a negative error code in case of failure.
994  */
995 int ubifs_read_node(const struct ubifs_info *c, void *buf, int type, int len,
996                     int lnum, int offs)
997 {
998         int err, l;
999         struct ubifs_ch *ch = buf;
1000
1001         dbg_io("LEB %d:%d, %s, length %d", lnum, offs, dbg_ntype(type), len);
1002         ubifs_assert(lnum >= 0 && lnum < c->leb_cnt && offs >= 0);
1003         ubifs_assert(len >= UBIFS_CH_SZ && offs + len <= c->leb_size);
1004         ubifs_assert(!(offs & 7) && offs < c->leb_size);
1005         ubifs_assert(type >= 0 && type < UBIFS_NODE_TYPES_CNT);
1006
1007         err = ubifs_leb_read(c, lnum, buf, offs, len, 0);
1008         if (err && err != -EBADMSG)
1009                 return err;
1010
1011         if (type != ch->node_type) {
1012                 ubifs_errc(c, "bad node type (%d but expected %d)",
1013                            ch->node_type, type);
1014                 goto out;
1015         }
1016
1017         err = ubifs_check_node(c, buf, lnum, offs, 0, 0);
1018         if (err) {
1019                 ubifs_errc(c, "expected node type %d", type);
1020                 return err;
1021         }
1022
1023         l = le32_to_cpu(ch->len);
1024         if (l != len) {
1025                 ubifs_errc(c, "bad node length %d, expected %d", l, len);
1026                 goto out;
1027         }
1028
1029         return 0;
1030
1031 out:
1032         ubifs_errc(c, "bad node at LEB %d:%d, LEB mapping status %d", lnum,
1033                    offs, ubi_is_mapped(c->ubi, lnum));
1034         if (!c->probing) {
1035                 ubifs_dump_node(c, buf);
1036                 dump_stack();
1037         }
1038         return -EINVAL;
1039 }
1040
1041 /**
1042  * ubifs_wbuf_init - initialize write-buffer.
1043  * @c: UBIFS file-system description object
1044  * @wbuf: write-buffer to initialize
1045  *
1046  * This function initializes write-buffer. Returns zero in case of success
1047  * %-ENOMEM in case of failure.
1048  */
1049 int ubifs_wbuf_init(struct ubifs_info *c, struct ubifs_wbuf *wbuf)
1050 {
1051         size_t size;
1052
1053         wbuf->buf = kmalloc(c->max_write_size, GFP_KERNEL);
1054         if (!wbuf->buf)
1055                 return -ENOMEM;
1056
1057         size = (c->max_write_size / UBIFS_CH_SZ + 1) * sizeof(ino_t);
1058         wbuf->inodes = kmalloc(size, GFP_KERNEL);
1059         if (!wbuf->inodes) {
1060                 kfree(wbuf->buf);
1061                 wbuf->buf = NULL;
1062                 return -ENOMEM;
1063         }
1064
1065         wbuf->used = 0;
1066         wbuf->lnum = wbuf->offs = -1;
1067         /*
1068          * If the LEB starts at the max. write size aligned address, then
1069          * write-buffer size has to be set to @c->max_write_size. Otherwise,
1070          * set it to something smaller so that it ends at the closest max.
1071          * write size boundary.
1072          */
1073         size = c->max_write_size - (c->leb_start % c->max_write_size);
1074         wbuf->avail = wbuf->size = size;
1075         wbuf->sync_callback = NULL;
1076         mutex_init(&wbuf->io_mutex);
1077         spin_lock_init(&wbuf->lock);
1078         wbuf->c = c;
1079         wbuf->next_ino = 0;
1080
1081         hrtimer_init(&wbuf->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1082         wbuf->timer.function = wbuf_timer_callback_nolock;
1083         wbuf->softlimit = ktime_set(WBUF_TIMEOUT_SOFTLIMIT, 0);
1084         wbuf->delta = WBUF_TIMEOUT_HARDLIMIT - WBUF_TIMEOUT_SOFTLIMIT;
1085         wbuf->delta *= 1000000000ULL;
1086         ubifs_assert(wbuf->delta <= ULONG_MAX);
1087         return 0;
1088 }
1089
1090 /**
1091  * ubifs_wbuf_add_ino_nolock - add an inode number into the wbuf inode array.
1092  * @wbuf: the write-buffer where to add
1093  * @inum: the inode number
1094  *
1095  * This function adds an inode number to the inode array of the write-buffer.
1096  */
1097 void ubifs_wbuf_add_ino_nolock(struct ubifs_wbuf *wbuf, ino_t inum)
1098 {
1099         if (!wbuf->buf)
1100                 /* NOR flash or something similar */
1101                 return;
1102
1103         spin_lock(&wbuf->lock);
1104         if (wbuf->used)
1105                 wbuf->inodes[wbuf->next_ino++] = inum;
1106         spin_unlock(&wbuf->lock);
1107 }
1108
1109 /**
1110  * wbuf_has_ino - returns if the wbuf contains data from the inode.
1111  * @wbuf: the write-buffer
1112  * @inum: the inode number
1113  *
1114  * This function returns with %1 if the write-buffer contains some data from the
1115  * given inode otherwise it returns with %0.
1116  */
1117 static int wbuf_has_ino(struct ubifs_wbuf *wbuf, ino_t inum)
1118 {
1119         int i, ret = 0;
1120
1121         spin_lock(&wbuf->lock);
1122         for (i = 0; i < wbuf->next_ino; i++)
1123                 if (inum == wbuf->inodes[i]) {
1124                         ret = 1;
1125                         break;
1126                 }
1127         spin_unlock(&wbuf->lock);
1128
1129         return ret;
1130 }
1131
1132 /**
1133  * ubifs_sync_wbufs_by_inode - synchronize write-buffers for an inode.
1134  * @c: UBIFS file-system description object
1135  * @inode: inode to synchronize
1136  *
1137  * This function synchronizes write-buffers which contain nodes belonging to
1138  * @inode. Returns zero in case of success and a negative error code in case of
1139  * failure.
1140  */
1141 int ubifs_sync_wbufs_by_inode(struct ubifs_info *c, struct inode *inode)
1142 {
1143         int i, err = 0;
1144
1145         for (i = 0; i < c->jhead_cnt; i++) {
1146                 struct ubifs_wbuf *wbuf = &c->jheads[i].wbuf;
1147
1148                 if (i == GCHD)
1149                         /*
1150                          * GC head is special, do not look at it. Even if the
1151                          * head contains something related to this inode, it is
1152                          * a _copy_ of corresponding on-flash node which sits
1153                          * somewhere else.
1154                          */
1155                         continue;
1156
1157                 if (!wbuf_has_ino(wbuf, inode->i_ino))
1158                         continue;
1159
1160                 mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
1161                 if (wbuf_has_ino(wbuf, inode->i_ino))
1162                         err = ubifs_wbuf_sync_nolock(wbuf);
1163                 mutex_unlock(&wbuf->io_mutex);
1164
1165                 if (err) {
1166                         ubifs_ro_mode(c, err);
1167                         return err;
1168                 }
1169         }
1170         return 0;
1171 }