1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * This file is part of UBIFS.
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2006-2008 Nokia Corporation.
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * Authors: Artem Bityutskiy (Битюцкий Артём)
9*4882a593Smuzhiyun * Adrian Hunter
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun /*
13*4882a593Smuzhiyun * This file implements UBIFS superblock. The superblock is stored at the first
14*4882a593Smuzhiyun * LEB of the volume and is never changed by UBIFS. Only user-space tools may
15*4882a593Smuzhiyun * change it. The superblock node mostly contains geometry information.
16*4882a593Smuzhiyun */
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun #include "ubifs.h"
19*4882a593Smuzhiyun #ifndef __UBOOT__
20*4882a593Smuzhiyun #include <linux/slab.h>
21*4882a593Smuzhiyun #include <linux/random.h>
22*4882a593Smuzhiyun #include <linux/math64.h>
23*4882a593Smuzhiyun #else
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun #include <linux/compat.h>
26*4882a593Smuzhiyun #include <linux/err.h>
27*4882a593Smuzhiyun #include <ubi_uboot.h>
28*4882a593Smuzhiyun #include <linux/stat.h>
29*4882a593Smuzhiyun #endif
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /*
32*4882a593Smuzhiyun * Default journal size in logical eraseblocks as a percent of total
33*4882a593Smuzhiyun * flash size.
34*4882a593Smuzhiyun */
35*4882a593Smuzhiyun #define DEFAULT_JNL_PERCENT 5
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun /* Default maximum journal size in bytes */
38*4882a593Smuzhiyun #define DEFAULT_MAX_JNL (32*1024*1024)
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun /* Default indexing tree fanout */
41*4882a593Smuzhiyun #define DEFAULT_FANOUT 8
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /* Default number of data journal heads */
44*4882a593Smuzhiyun #define DEFAULT_JHEADS_CNT 1
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun /* Default positions of different LEBs in the main area */
47*4882a593Smuzhiyun #define DEFAULT_IDX_LEB 0
48*4882a593Smuzhiyun #define DEFAULT_DATA_LEB 1
49*4882a593Smuzhiyun #define DEFAULT_GC_LEB 2
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun /* Default number of LEB numbers in LPT's save table */
52*4882a593Smuzhiyun #define DEFAULT_LSAVE_CNT 256
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun /* Default reserved pool size as a percent of maximum free space */
55*4882a593Smuzhiyun #define DEFAULT_RP_PERCENT 5
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun /* The default maximum size of reserved pool in bytes */
58*4882a593Smuzhiyun #define DEFAULT_MAX_RP_SIZE (5*1024*1024)
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun /* Default time granularity in nanoseconds */
61*4882a593Smuzhiyun #define DEFAULT_TIME_GRAN 1000000000
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun #ifndef __UBOOT__
64*4882a593Smuzhiyun /**
65*4882a593Smuzhiyun * create_default_filesystem - format empty UBI volume.
66*4882a593Smuzhiyun * @c: UBIFS file-system description object
67*4882a593Smuzhiyun *
68*4882a593Smuzhiyun * This function creates default empty file-system. Returns zero in case of
69*4882a593Smuzhiyun * success and a negative error code in case of failure.
70*4882a593Smuzhiyun */
create_default_filesystem(struct ubifs_info * c)71*4882a593Smuzhiyun static int create_default_filesystem(struct ubifs_info *c)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun struct ubifs_sb_node *sup;
74*4882a593Smuzhiyun struct ubifs_mst_node *mst;
75*4882a593Smuzhiyun struct ubifs_idx_node *idx;
76*4882a593Smuzhiyun struct ubifs_branch *br;
77*4882a593Smuzhiyun struct ubifs_ino_node *ino;
78*4882a593Smuzhiyun struct ubifs_cs_node *cs;
79*4882a593Smuzhiyun union ubifs_key key;
80*4882a593Smuzhiyun int err, tmp, jnl_lebs, log_lebs, max_buds, main_lebs, main_first;
81*4882a593Smuzhiyun int lpt_lebs, lpt_first, orph_lebs, big_lpt, ino_waste, sup_flags = 0;
82*4882a593Smuzhiyun int min_leb_cnt = UBIFS_MIN_LEB_CNT;
83*4882a593Smuzhiyun long long tmp64, main_bytes;
84*4882a593Smuzhiyun __le64 tmp_le64;
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun /* Some functions called from here depend on the @c->key_len filed */
87*4882a593Smuzhiyun c->key_len = UBIFS_SK_LEN;
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun /*
90*4882a593Smuzhiyun * First of all, we have to calculate default file-system geometry -
91*4882a593Smuzhiyun * log size, journal size, etc.
92*4882a593Smuzhiyun */
93*4882a593Smuzhiyun if (c->leb_cnt < 0x7FFFFFFF / DEFAULT_JNL_PERCENT)
94*4882a593Smuzhiyun /* We can first multiply then divide and have no overflow */
95*4882a593Smuzhiyun jnl_lebs = c->leb_cnt * DEFAULT_JNL_PERCENT / 100;
96*4882a593Smuzhiyun else
97*4882a593Smuzhiyun jnl_lebs = (c->leb_cnt / 100) * DEFAULT_JNL_PERCENT;
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun if (jnl_lebs < UBIFS_MIN_JNL_LEBS)
100*4882a593Smuzhiyun jnl_lebs = UBIFS_MIN_JNL_LEBS;
101*4882a593Smuzhiyun if (jnl_lebs * c->leb_size > DEFAULT_MAX_JNL)
102*4882a593Smuzhiyun jnl_lebs = DEFAULT_MAX_JNL / c->leb_size;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun /*
105*4882a593Smuzhiyun * The log should be large enough to fit reference nodes for all bud
106*4882a593Smuzhiyun * LEBs. Because buds do not have to start from the beginning of LEBs
107*4882a593Smuzhiyun * (half of the LEB may contain committed data), the log should
108*4882a593Smuzhiyun * generally be larger, make it twice as large.
109*4882a593Smuzhiyun */
110*4882a593Smuzhiyun tmp = 2 * (c->ref_node_alsz * jnl_lebs) + c->leb_size - 1;
111*4882a593Smuzhiyun log_lebs = tmp / c->leb_size;
112*4882a593Smuzhiyun /* Plus one LEB reserved for commit */
113*4882a593Smuzhiyun log_lebs += 1;
114*4882a593Smuzhiyun if (c->leb_cnt - min_leb_cnt > 8) {
115*4882a593Smuzhiyun /* And some extra space to allow writes while committing */
116*4882a593Smuzhiyun log_lebs += 1;
117*4882a593Smuzhiyun min_leb_cnt += 1;
118*4882a593Smuzhiyun }
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun max_buds = jnl_lebs - log_lebs;
121*4882a593Smuzhiyun if (max_buds < UBIFS_MIN_BUD_LEBS)
122*4882a593Smuzhiyun max_buds = UBIFS_MIN_BUD_LEBS;
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun /*
125*4882a593Smuzhiyun * Orphan nodes are stored in a separate area. One node can store a lot
126*4882a593Smuzhiyun * of orphan inode numbers, but when new orphan comes we just add a new
127*4882a593Smuzhiyun * orphan node. At some point the nodes are consolidated into one
128*4882a593Smuzhiyun * orphan node.
129*4882a593Smuzhiyun */
130*4882a593Smuzhiyun orph_lebs = UBIFS_MIN_ORPH_LEBS;
131*4882a593Smuzhiyun if (c->leb_cnt - min_leb_cnt > 1)
132*4882a593Smuzhiyun /*
133*4882a593Smuzhiyun * For debugging purposes it is better to have at least 2
134*4882a593Smuzhiyun * orphan LEBs, because the orphan subsystem would need to do
135*4882a593Smuzhiyun * consolidations and would be stressed more.
136*4882a593Smuzhiyun */
137*4882a593Smuzhiyun orph_lebs += 1;
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun main_lebs = c->leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS - log_lebs;
140*4882a593Smuzhiyun main_lebs -= orph_lebs;
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun lpt_first = UBIFS_LOG_LNUM + log_lebs;
143*4882a593Smuzhiyun c->lsave_cnt = DEFAULT_LSAVE_CNT;
144*4882a593Smuzhiyun c->max_leb_cnt = c->leb_cnt;
145*4882a593Smuzhiyun err = ubifs_create_dflt_lpt(c, &main_lebs, lpt_first, &lpt_lebs,
146*4882a593Smuzhiyun &big_lpt);
147*4882a593Smuzhiyun if (err)
148*4882a593Smuzhiyun return err;
149*4882a593Smuzhiyun
150*4882a593Smuzhiyun dbg_gen("LEB Properties Tree created (LEBs %d-%d)", lpt_first,
151*4882a593Smuzhiyun lpt_first + lpt_lebs - 1);
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun main_first = c->leb_cnt - main_lebs;
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun /* Create default superblock */
156*4882a593Smuzhiyun tmp = ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size);
157*4882a593Smuzhiyun sup = kzalloc(tmp, GFP_KERNEL);
158*4882a593Smuzhiyun if (!sup)
159*4882a593Smuzhiyun return -ENOMEM;
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun tmp64 = (long long)max_buds * c->leb_size;
162*4882a593Smuzhiyun if (big_lpt)
163*4882a593Smuzhiyun sup_flags |= UBIFS_FLG_BIGLPT;
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun sup->ch.node_type = UBIFS_SB_NODE;
166*4882a593Smuzhiyun sup->key_hash = UBIFS_KEY_HASH_R5;
167*4882a593Smuzhiyun sup->flags = cpu_to_le32(sup_flags);
168*4882a593Smuzhiyun sup->min_io_size = cpu_to_le32(c->min_io_size);
169*4882a593Smuzhiyun sup->leb_size = cpu_to_le32(c->leb_size);
170*4882a593Smuzhiyun sup->leb_cnt = cpu_to_le32(c->leb_cnt);
171*4882a593Smuzhiyun sup->max_leb_cnt = cpu_to_le32(c->max_leb_cnt);
172*4882a593Smuzhiyun sup->max_bud_bytes = cpu_to_le64(tmp64);
173*4882a593Smuzhiyun sup->log_lebs = cpu_to_le32(log_lebs);
174*4882a593Smuzhiyun sup->lpt_lebs = cpu_to_le32(lpt_lebs);
175*4882a593Smuzhiyun sup->orph_lebs = cpu_to_le32(orph_lebs);
176*4882a593Smuzhiyun sup->jhead_cnt = cpu_to_le32(DEFAULT_JHEADS_CNT);
177*4882a593Smuzhiyun sup->fanout = cpu_to_le32(DEFAULT_FANOUT);
178*4882a593Smuzhiyun sup->lsave_cnt = cpu_to_le32(c->lsave_cnt);
179*4882a593Smuzhiyun sup->fmt_version = cpu_to_le32(UBIFS_FORMAT_VERSION);
180*4882a593Smuzhiyun sup->time_gran = cpu_to_le32(DEFAULT_TIME_GRAN);
181*4882a593Smuzhiyun if (c->mount_opts.override_compr)
182*4882a593Smuzhiyun sup->default_compr = cpu_to_le16(c->mount_opts.compr_type);
183*4882a593Smuzhiyun else
184*4882a593Smuzhiyun sup->default_compr = cpu_to_le16(UBIFS_COMPR_LZO);
185*4882a593Smuzhiyun
186*4882a593Smuzhiyun generate_random_uuid(sup->uuid);
187*4882a593Smuzhiyun
188*4882a593Smuzhiyun main_bytes = (long long)main_lebs * c->leb_size;
189*4882a593Smuzhiyun tmp64 = div_u64(main_bytes * DEFAULT_RP_PERCENT, 100);
190*4882a593Smuzhiyun if (tmp64 > DEFAULT_MAX_RP_SIZE)
191*4882a593Smuzhiyun tmp64 = DEFAULT_MAX_RP_SIZE;
192*4882a593Smuzhiyun sup->rp_size = cpu_to_le64(tmp64);
193*4882a593Smuzhiyun sup->ro_compat_version = cpu_to_le32(UBIFS_RO_COMPAT_VERSION);
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun err = ubifs_write_node(c, sup, UBIFS_SB_NODE_SZ, 0, 0);
196*4882a593Smuzhiyun kfree(sup);
197*4882a593Smuzhiyun if (err)
198*4882a593Smuzhiyun return err;
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun dbg_gen("default superblock created at LEB 0:0");
201*4882a593Smuzhiyun
202*4882a593Smuzhiyun /* Create default master node */
203*4882a593Smuzhiyun mst = kzalloc(c->mst_node_alsz, GFP_KERNEL);
204*4882a593Smuzhiyun if (!mst)
205*4882a593Smuzhiyun return -ENOMEM;
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun mst->ch.node_type = UBIFS_MST_NODE;
208*4882a593Smuzhiyun mst->log_lnum = cpu_to_le32(UBIFS_LOG_LNUM);
209*4882a593Smuzhiyun mst->highest_inum = cpu_to_le64(UBIFS_FIRST_INO);
210*4882a593Smuzhiyun mst->cmt_no = 0;
211*4882a593Smuzhiyun mst->root_lnum = cpu_to_le32(main_first + DEFAULT_IDX_LEB);
212*4882a593Smuzhiyun mst->root_offs = 0;
213*4882a593Smuzhiyun tmp = ubifs_idx_node_sz(c, 1);
214*4882a593Smuzhiyun mst->root_len = cpu_to_le32(tmp);
215*4882a593Smuzhiyun mst->gc_lnum = cpu_to_le32(main_first + DEFAULT_GC_LEB);
216*4882a593Smuzhiyun mst->ihead_lnum = cpu_to_le32(main_first + DEFAULT_IDX_LEB);
217*4882a593Smuzhiyun mst->ihead_offs = cpu_to_le32(ALIGN(tmp, c->min_io_size));
218*4882a593Smuzhiyun mst->index_size = cpu_to_le64(ALIGN(tmp, 8));
219*4882a593Smuzhiyun mst->lpt_lnum = cpu_to_le32(c->lpt_lnum);
220*4882a593Smuzhiyun mst->lpt_offs = cpu_to_le32(c->lpt_offs);
221*4882a593Smuzhiyun mst->nhead_lnum = cpu_to_le32(c->nhead_lnum);
222*4882a593Smuzhiyun mst->nhead_offs = cpu_to_le32(c->nhead_offs);
223*4882a593Smuzhiyun mst->ltab_lnum = cpu_to_le32(c->ltab_lnum);
224*4882a593Smuzhiyun mst->ltab_offs = cpu_to_le32(c->ltab_offs);
225*4882a593Smuzhiyun mst->lsave_lnum = cpu_to_le32(c->lsave_lnum);
226*4882a593Smuzhiyun mst->lsave_offs = cpu_to_le32(c->lsave_offs);
227*4882a593Smuzhiyun mst->lscan_lnum = cpu_to_le32(main_first);
228*4882a593Smuzhiyun mst->empty_lebs = cpu_to_le32(main_lebs - 2);
229*4882a593Smuzhiyun mst->idx_lebs = cpu_to_le32(1);
230*4882a593Smuzhiyun mst->leb_cnt = cpu_to_le32(c->leb_cnt);
231*4882a593Smuzhiyun
232*4882a593Smuzhiyun /* Calculate lprops statistics */
233*4882a593Smuzhiyun tmp64 = main_bytes;
234*4882a593Smuzhiyun tmp64 -= ALIGN(ubifs_idx_node_sz(c, 1), c->min_io_size);
235*4882a593Smuzhiyun tmp64 -= ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size);
236*4882a593Smuzhiyun mst->total_free = cpu_to_le64(tmp64);
237*4882a593Smuzhiyun
238*4882a593Smuzhiyun tmp64 = ALIGN(ubifs_idx_node_sz(c, 1), c->min_io_size);
239*4882a593Smuzhiyun ino_waste = ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size) -
240*4882a593Smuzhiyun UBIFS_INO_NODE_SZ;
241*4882a593Smuzhiyun tmp64 += ino_waste;
242*4882a593Smuzhiyun tmp64 -= ALIGN(ubifs_idx_node_sz(c, 1), 8);
243*4882a593Smuzhiyun mst->total_dirty = cpu_to_le64(tmp64);
244*4882a593Smuzhiyun
245*4882a593Smuzhiyun /* The indexing LEB does not contribute to dark space */
246*4882a593Smuzhiyun tmp64 = ((long long)(c->main_lebs - 1) * c->dark_wm);
247*4882a593Smuzhiyun mst->total_dark = cpu_to_le64(tmp64);
248*4882a593Smuzhiyun
249*4882a593Smuzhiyun mst->total_used = cpu_to_le64(UBIFS_INO_NODE_SZ);
250*4882a593Smuzhiyun
251*4882a593Smuzhiyun err = ubifs_write_node(c, mst, UBIFS_MST_NODE_SZ, UBIFS_MST_LNUM, 0);
252*4882a593Smuzhiyun if (err) {
253*4882a593Smuzhiyun kfree(mst);
254*4882a593Smuzhiyun return err;
255*4882a593Smuzhiyun }
256*4882a593Smuzhiyun err = ubifs_write_node(c, mst, UBIFS_MST_NODE_SZ, UBIFS_MST_LNUM + 1,
257*4882a593Smuzhiyun 0);
258*4882a593Smuzhiyun kfree(mst);
259*4882a593Smuzhiyun if (err)
260*4882a593Smuzhiyun return err;
261*4882a593Smuzhiyun
262*4882a593Smuzhiyun dbg_gen("default master node created at LEB %d:0", UBIFS_MST_LNUM);
263*4882a593Smuzhiyun
264*4882a593Smuzhiyun /* Create the root indexing node */
265*4882a593Smuzhiyun tmp = ubifs_idx_node_sz(c, 1);
266*4882a593Smuzhiyun idx = kzalloc(ALIGN(tmp, c->min_io_size), GFP_KERNEL);
267*4882a593Smuzhiyun if (!idx)
268*4882a593Smuzhiyun return -ENOMEM;
269*4882a593Smuzhiyun
270*4882a593Smuzhiyun c->key_fmt = UBIFS_SIMPLE_KEY_FMT;
271*4882a593Smuzhiyun c->key_hash = key_r5_hash;
272*4882a593Smuzhiyun
273*4882a593Smuzhiyun idx->ch.node_type = UBIFS_IDX_NODE;
274*4882a593Smuzhiyun idx->child_cnt = cpu_to_le16(1);
275*4882a593Smuzhiyun ino_key_init(c, &key, UBIFS_ROOT_INO);
276*4882a593Smuzhiyun br = ubifs_idx_branch(c, idx, 0);
277*4882a593Smuzhiyun key_write_idx(c, &key, &br->key);
278*4882a593Smuzhiyun br->lnum = cpu_to_le32(main_first + DEFAULT_DATA_LEB);
279*4882a593Smuzhiyun br->len = cpu_to_le32(UBIFS_INO_NODE_SZ);
280*4882a593Smuzhiyun err = ubifs_write_node(c, idx, tmp, main_first + DEFAULT_IDX_LEB, 0);
281*4882a593Smuzhiyun kfree(idx);
282*4882a593Smuzhiyun if (err)
283*4882a593Smuzhiyun return err;
284*4882a593Smuzhiyun
285*4882a593Smuzhiyun dbg_gen("default root indexing node created LEB %d:0",
286*4882a593Smuzhiyun main_first + DEFAULT_IDX_LEB);
287*4882a593Smuzhiyun
288*4882a593Smuzhiyun /* Create default root inode */
289*4882a593Smuzhiyun tmp = ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size);
290*4882a593Smuzhiyun ino = kzalloc(tmp, GFP_KERNEL);
291*4882a593Smuzhiyun if (!ino)
292*4882a593Smuzhiyun return -ENOMEM;
293*4882a593Smuzhiyun
294*4882a593Smuzhiyun ino_key_init_flash(c, &ino->key, UBIFS_ROOT_INO);
295*4882a593Smuzhiyun ino->ch.node_type = UBIFS_INO_NODE;
296*4882a593Smuzhiyun ino->creat_sqnum = cpu_to_le64(++c->max_sqnum);
297*4882a593Smuzhiyun ino->nlink = cpu_to_le32(2);
298*4882a593Smuzhiyun tmp_le64 = cpu_to_le64(CURRENT_TIME_SEC.tv_sec);
299*4882a593Smuzhiyun ino->atime_sec = tmp_le64;
300*4882a593Smuzhiyun ino->ctime_sec = tmp_le64;
301*4882a593Smuzhiyun ino->mtime_sec = tmp_le64;
302*4882a593Smuzhiyun ino->atime_nsec = 0;
303*4882a593Smuzhiyun ino->ctime_nsec = 0;
304*4882a593Smuzhiyun ino->mtime_nsec = 0;
305*4882a593Smuzhiyun ino->mode = cpu_to_le32(S_IFDIR | S_IRUGO | S_IWUSR | S_IXUGO);
306*4882a593Smuzhiyun ino->size = cpu_to_le64(UBIFS_INO_NODE_SZ);
307*4882a593Smuzhiyun
308*4882a593Smuzhiyun /* Set compression enabled by default */
309*4882a593Smuzhiyun ino->flags = cpu_to_le32(UBIFS_COMPR_FL);
310*4882a593Smuzhiyun
311*4882a593Smuzhiyun err = ubifs_write_node(c, ino, UBIFS_INO_NODE_SZ,
312*4882a593Smuzhiyun main_first + DEFAULT_DATA_LEB, 0);
313*4882a593Smuzhiyun kfree(ino);
314*4882a593Smuzhiyun if (err)
315*4882a593Smuzhiyun return err;
316*4882a593Smuzhiyun
317*4882a593Smuzhiyun dbg_gen("root inode created at LEB %d:0",
318*4882a593Smuzhiyun main_first + DEFAULT_DATA_LEB);
319*4882a593Smuzhiyun
320*4882a593Smuzhiyun /*
321*4882a593Smuzhiyun * The first node in the log has to be the commit start node. This is
322*4882a593Smuzhiyun * always the case during normal file-system operation. Write a fake
323*4882a593Smuzhiyun * commit start node to the log.
324*4882a593Smuzhiyun */
325*4882a593Smuzhiyun tmp = ALIGN(UBIFS_CS_NODE_SZ, c->min_io_size);
326*4882a593Smuzhiyun cs = kzalloc(tmp, GFP_KERNEL);
327*4882a593Smuzhiyun if (!cs)
328*4882a593Smuzhiyun return -ENOMEM;
329*4882a593Smuzhiyun
330*4882a593Smuzhiyun cs->ch.node_type = UBIFS_CS_NODE;
331*4882a593Smuzhiyun err = ubifs_write_node(c, cs, UBIFS_CS_NODE_SZ, UBIFS_LOG_LNUM, 0);
332*4882a593Smuzhiyun kfree(cs);
333*4882a593Smuzhiyun if (err)
334*4882a593Smuzhiyun return err;
335*4882a593Smuzhiyun
336*4882a593Smuzhiyun ubifs_msg(c, "default file-system created");
337*4882a593Smuzhiyun return 0;
338*4882a593Smuzhiyun }
339*4882a593Smuzhiyun #endif
340*4882a593Smuzhiyun
341*4882a593Smuzhiyun /**
342*4882a593Smuzhiyun * validate_sb - validate superblock node.
343*4882a593Smuzhiyun * @c: UBIFS file-system description object
344*4882a593Smuzhiyun * @sup: superblock node
345*4882a593Smuzhiyun *
346*4882a593Smuzhiyun * This function validates superblock node @sup. Since most of data was read
347*4882a593Smuzhiyun * from the superblock and stored in @c, the function validates fields in @c
348*4882a593Smuzhiyun * instead. Returns zero in case of success and %-EINVAL in case of validation
349*4882a593Smuzhiyun * failure.
350*4882a593Smuzhiyun */
validate_sb(struct ubifs_info * c,struct ubifs_sb_node * sup)351*4882a593Smuzhiyun static int validate_sb(struct ubifs_info *c, struct ubifs_sb_node *sup)
352*4882a593Smuzhiyun {
353*4882a593Smuzhiyun long long max_bytes;
354*4882a593Smuzhiyun int err = 1, min_leb_cnt;
355*4882a593Smuzhiyun
356*4882a593Smuzhiyun if (!c->key_hash) {
357*4882a593Smuzhiyun err = 2;
358*4882a593Smuzhiyun goto failed;
359*4882a593Smuzhiyun }
360*4882a593Smuzhiyun
361*4882a593Smuzhiyun if (sup->key_fmt != UBIFS_SIMPLE_KEY_FMT) {
362*4882a593Smuzhiyun err = 3;
363*4882a593Smuzhiyun goto failed;
364*4882a593Smuzhiyun }
365*4882a593Smuzhiyun
366*4882a593Smuzhiyun if (le32_to_cpu(sup->min_io_size) != c->min_io_size) {
367*4882a593Smuzhiyun ubifs_err(c, "min. I/O unit mismatch: %d in superblock, %d real",
368*4882a593Smuzhiyun le32_to_cpu(sup->min_io_size), c->min_io_size);
369*4882a593Smuzhiyun goto failed;
370*4882a593Smuzhiyun }
371*4882a593Smuzhiyun
372*4882a593Smuzhiyun if (le32_to_cpu(sup->leb_size) != c->leb_size) {
373*4882a593Smuzhiyun ubifs_err(c, "LEB size mismatch: %d in superblock, %d real",
374*4882a593Smuzhiyun le32_to_cpu(sup->leb_size), c->leb_size);
375*4882a593Smuzhiyun goto failed;
376*4882a593Smuzhiyun }
377*4882a593Smuzhiyun
378*4882a593Smuzhiyun if (c->log_lebs < UBIFS_MIN_LOG_LEBS ||
379*4882a593Smuzhiyun c->lpt_lebs < UBIFS_MIN_LPT_LEBS ||
380*4882a593Smuzhiyun c->orph_lebs < UBIFS_MIN_ORPH_LEBS ||
381*4882a593Smuzhiyun c->main_lebs < UBIFS_MIN_MAIN_LEBS) {
382*4882a593Smuzhiyun err = 4;
383*4882a593Smuzhiyun goto failed;
384*4882a593Smuzhiyun }
385*4882a593Smuzhiyun
386*4882a593Smuzhiyun /*
387*4882a593Smuzhiyun * Calculate minimum allowed amount of main area LEBs. This is very
388*4882a593Smuzhiyun * similar to %UBIFS_MIN_LEB_CNT, but we take into account real what we
389*4882a593Smuzhiyun * have just read from the superblock.
390*4882a593Smuzhiyun */
391*4882a593Smuzhiyun min_leb_cnt = UBIFS_SB_LEBS + UBIFS_MST_LEBS + c->log_lebs;
392*4882a593Smuzhiyun min_leb_cnt += c->lpt_lebs + c->orph_lebs + c->jhead_cnt + 6;
393*4882a593Smuzhiyun
394*4882a593Smuzhiyun if (c->leb_cnt < min_leb_cnt || c->leb_cnt > c->vi.size) {
395*4882a593Smuzhiyun ubifs_err(c, "bad LEB count: %d in superblock, %d on UBI volume, %d minimum required",
396*4882a593Smuzhiyun c->leb_cnt, c->vi.size, min_leb_cnt);
397*4882a593Smuzhiyun goto failed;
398*4882a593Smuzhiyun }
399*4882a593Smuzhiyun
400*4882a593Smuzhiyun if (c->max_leb_cnt < c->leb_cnt) {
401*4882a593Smuzhiyun ubifs_err(c, "max. LEB count %d less than LEB count %d",
402*4882a593Smuzhiyun c->max_leb_cnt, c->leb_cnt);
403*4882a593Smuzhiyun goto failed;
404*4882a593Smuzhiyun }
405*4882a593Smuzhiyun
406*4882a593Smuzhiyun if (c->main_lebs < UBIFS_MIN_MAIN_LEBS) {
407*4882a593Smuzhiyun ubifs_err(c, "too few main LEBs count %d, must be at least %d",
408*4882a593Smuzhiyun c->main_lebs, UBIFS_MIN_MAIN_LEBS);
409*4882a593Smuzhiyun goto failed;
410*4882a593Smuzhiyun }
411*4882a593Smuzhiyun
412*4882a593Smuzhiyun max_bytes = (long long)c->leb_size * UBIFS_MIN_BUD_LEBS;
413*4882a593Smuzhiyun if (c->max_bud_bytes < max_bytes) {
414*4882a593Smuzhiyun ubifs_err(c, "too small journal (%lld bytes), must be at least %lld bytes",
415*4882a593Smuzhiyun c->max_bud_bytes, max_bytes);
416*4882a593Smuzhiyun goto failed;
417*4882a593Smuzhiyun }
418*4882a593Smuzhiyun
419*4882a593Smuzhiyun max_bytes = (long long)c->leb_size * c->main_lebs;
420*4882a593Smuzhiyun if (c->max_bud_bytes > max_bytes) {
421*4882a593Smuzhiyun ubifs_err(c, "too large journal size (%lld bytes), only %lld bytes available in the main area",
422*4882a593Smuzhiyun c->max_bud_bytes, max_bytes);
423*4882a593Smuzhiyun goto failed;
424*4882a593Smuzhiyun }
425*4882a593Smuzhiyun
426*4882a593Smuzhiyun if (c->jhead_cnt < NONDATA_JHEADS_CNT + 1 ||
427*4882a593Smuzhiyun c->jhead_cnt > NONDATA_JHEADS_CNT + UBIFS_MAX_JHEADS) {
428*4882a593Smuzhiyun err = 9;
429*4882a593Smuzhiyun goto failed;
430*4882a593Smuzhiyun }
431*4882a593Smuzhiyun
432*4882a593Smuzhiyun if (c->fanout < UBIFS_MIN_FANOUT ||
433*4882a593Smuzhiyun ubifs_idx_node_sz(c, c->fanout) > c->leb_size) {
434*4882a593Smuzhiyun err = 10;
435*4882a593Smuzhiyun goto failed;
436*4882a593Smuzhiyun }
437*4882a593Smuzhiyun
438*4882a593Smuzhiyun if (c->lsave_cnt < 0 || (c->lsave_cnt > DEFAULT_LSAVE_CNT &&
439*4882a593Smuzhiyun c->lsave_cnt > c->max_leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS -
440*4882a593Smuzhiyun c->log_lebs - c->lpt_lebs - c->orph_lebs)) {
441*4882a593Smuzhiyun err = 11;
442*4882a593Smuzhiyun goto failed;
443*4882a593Smuzhiyun }
444*4882a593Smuzhiyun
445*4882a593Smuzhiyun if (UBIFS_SB_LEBS + UBIFS_MST_LEBS + c->log_lebs + c->lpt_lebs +
446*4882a593Smuzhiyun c->orph_lebs + c->main_lebs != c->leb_cnt) {
447*4882a593Smuzhiyun err = 12;
448*4882a593Smuzhiyun goto failed;
449*4882a593Smuzhiyun }
450*4882a593Smuzhiyun
451*4882a593Smuzhiyun if (c->default_compr >= UBIFS_COMPR_TYPES_CNT) {
452*4882a593Smuzhiyun err = 13;
453*4882a593Smuzhiyun goto failed;
454*4882a593Smuzhiyun }
455*4882a593Smuzhiyun
456*4882a593Smuzhiyun if (c->rp_size < 0 || max_bytes < c->rp_size) {
457*4882a593Smuzhiyun err = 14;
458*4882a593Smuzhiyun goto failed;
459*4882a593Smuzhiyun }
460*4882a593Smuzhiyun
461*4882a593Smuzhiyun if (le32_to_cpu(sup->time_gran) > 1000000000 ||
462*4882a593Smuzhiyun le32_to_cpu(sup->time_gran) < 1) {
463*4882a593Smuzhiyun err = 15;
464*4882a593Smuzhiyun goto failed;
465*4882a593Smuzhiyun }
466*4882a593Smuzhiyun
467*4882a593Smuzhiyun return 0;
468*4882a593Smuzhiyun
469*4882a593Smuzhiyun failed:
470*4882a593Smuzhiyun ubifs_err(c, "bad superblock, error %d", err);
471*4882a593Smuzhiyun ubifs_dump_node(c, sup);
472*4882a593Smuzhiyun return -EINVAL;
473*4882a593Smuzhiyun }
474*4882a593Smuzhiyun
475*4882a593Smuzhiyun /**
476*4882a593Smuzhiyun * ubifs_read_sb_node - read superblock node.
477*4882a593Smuzhiyun * @c: UBIFS file-system description object
478*4882a593Smuzhiyun *
479*4882a593Smuzhiyun * This function returns a pointer to the superblock node or a negative error
480*4882a593Smuzhiyun * code. Note, the user of this function is responsible of kfree()'ing the
481*4882a593Smuzhiyun * returned superblock buffer.
482*4882a593Smuzhiyun */
ubifs_read_sb_node(struct ubifs_info * c)483*4882a593Smuzhiyun struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c)
484*4882a593Smuzhiyun {
485*4882a593Smuzhiyun struct ubifs_sb_node *sup;
486*4882a593Smuzhiyun int err;
487*4882a593Smuzhiyun
488*4882a593Smuzhiyun sup = kmalloc(ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size), GFP_NOFS);
489*4882a593Smuzhiyun if (!sup)
490*4882a593Smuzhiyun return ERR_PTR(-ENOMEM);
491*4882a593Smuzhiyun
492*4882a593Smuzhiyun err = ubifs_read_node(c, sup, UBIFS_SB_NODE, UBIFS_SB_NODE_SZ,
493*4882a593Smuzhiyun UBIFS_SB_LNUM, 0);
494*4882a593Smuzhiyun if (err) {
495*4882a593Smuzhiyun kfree(sup);
496*4882a593Smuzhiyun return ERR_PTR(err);
497*4882a593Smuzhiyun }
498*4882a593Smuzhiyun
499*4882a593Smuzhiyun return sup;
500*4882a593Smuzhiyun }
501*4882a593Smuzhiyun
502*4882a593Smuzhiyun /**
503*4882a593Smuzhiyun * ubifs_write_sb_node - write superblock node.
504*4882a593Smuzhiyun * @c: UBIFS file-system description object
505*4882a593Smuzhiyun * @sup: superblock node read with 'ubifs_read_sb_node()'
506*4882a593Smuzhiyun *
507*4882a593Smuzhiyun * This function returns %0 on success and a negative error code on failure.
508*4882a593Smuzhiyun */
ubifs_write_sb_node(struct ubifs_info * c,struct ubifs_sb_node * sup)509*4882a593Smuzhiyun int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup)
510*4882a593Smuzhiyun {
511*4882a593Smuzhiyun int len = ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size);
512*4882a593Smuzhiyun
513*4882a593Smuzhiyun ubifs_prepare_node(c, sup, UBIFS_SB_NODE_SZ, 1);
514*4882a593Smuzhiyun return ubifs_leb_change(c, UBIFS_SB_LNUM, sup, len);
515*4882a593Smuzhiyun }
516*4882a593Smuzhiyun
517*4882a593Smuzhiyun /**
518*4882a593Smuzhiyun * ubifs_read_superblock - read superblock.
519*4882a593Smuzhiyun * @c: UBIFS file-system description object
520*4882a593Smuzhiyun *
521*4882a593Smuzhiyun * This function finds, reads and checks the superblock. If an empty UBI volume
522*4882a593Smuzhiyun * is being mounted, this function creates default superblock. Returns zero in
523*4882a593Smuzhiyun * case of success, and a negative error code in case of failure.
524*4882a593Smuzhiyun */
ubifs_read_superblock(struct ubifs_info * c)525*4882a593Smuzhiyun int ubifs_read_superblock(struct ubifs_info *c)
526*4882a593Smuzhiyun {
527*4882a593Smuzhiyun int err, sup_flags;
528*4882a593Smuzhiyun struct ubifs_sb_node *sup;
529*4882a593Smuzhiyun
530*4882a593Smuzhiyun if (c->empty) {
531*4882a593Smuzhiyun #ifndef __UBOOT__
532*4882a593Smuzhiyun err = create_default_filesystem(c);
533*4882a593Smuzhiyun if (err)
534*4882a593Smuzhiyun return err;
535*4882a593Smuzhiyun #else
536*4882a593Smuzhiyun printf("No UBIFS filesystem found!\n");
537*4882a593Smuzhiyun return -1;
538*4882a593Smuzhiyun #endif
539*4882a593Smuzhiyun }
540*4882a593Smuzhiyun
541*4882a593Smuzhiyun sup = ubifs_read_sb_node(c);
542*4882a593Smuzhiyun if (IS_ERR(sup))
543*4882a593Smuzhiyun return PTR_ERR(sup);
544*4882a593Smuzhiyun
545*4882a593Smuzhiyun c->fmt_version = le32_to_cpu(sup->fmt_version);
546*4882a593Smuzhiyun c->ro_compat_version = le32_to_cpu(sup->ro_compat_version);
547*4882a593Smuzhiyun
548*4882a593Smuzhiyun /*
549*4882a593Smuzhiyun * The software supports all previous versions but not future versions,
550*4882a593Smuzhiyun * due to the unavailability of time-travelling equipment.
551*4882a593Smuzhiyun */
552*4882a593Smuzhiyun if (c->fmt_version > UBIFS_FORMAT_VERSION) {
553*4882a593Smuzhiyun ubifs_assert(!c->ro_media || c->ro_mount);
554*4882a593Smuzhiyun if (!c->ro_mount ||
555*4882a593Smuzhiyun c->ro_compat_version > UBIFS_RO_COMPAT_VERSION) {
556*4882a593Smuzhiyun ubifs_err(c, "on-flash format version is w%d/r%d, but software only supports up to version w%d/r%d",
557*4882a593Smuzhiyun c->fmt_version, c->ro_compat_version,
558*4882a593Smuzhiyun UBIFS_FORMAT_VERSION,
559*4882a593Smuzhiyun UBIFS_RO_COMPAT_VERSION);
560*4882a593Smuzhiyun if (c->ro_compat_version <= UBIFS_RO_COMPAT_VERSION) {
561*4882a593Smuzhiyun ubifs_msg(c, "only R/O mounting is possible");
562*4882a593Smuzhiyun err = -EROFS;
563*4882a593Smuzhiyun } else
564*4882a593Smuzhiyun err = -EINVAL;
565*4882a593Smuzhiyun goto out;
566*4882a593Smuzhiyun }
567*4882a593Smuzhiyun
568*4882a593Smuzhiyun /*
569*4882a593Smuzhiyun * The FS is mounted R/O, and the media format is
570*4882a593Smuzhiyun * R/O-compatible with the UBIFS implementation, so we can
571*4882a593Smuzhiyun * mount.
572*4882a593Smuzhiyun */
573*4882a593Smuzhiyun c->rw_incompat = 1;
574*4882a593Smuzhiyun }
575*4882a593Smuzhiyun
576*4882a593Smuzhiyun if (c->fmt_version < 3) {
577*4882a593Smuzhiyun ubifs_err(c, "on-flash format version %d is not supported",
578*4882a593Smuzhiyun c->fmt_version);
579*4882a593Smuzhiyun err = -EINVAL;
580*4882a593Smuzhiyun goto out;
581*4882a593Smuzhiyun }
582*4882a593Smuzhiyun
583*4882a593Smuzhiyun switch (sup->key_hash) {
584*4882a593Smuzhiyun case UBIFS_KEY_HASH_R5:
585*4882a593Smuzhiyun c->key_hash = key_r5_hash;
586*4882a593Smuzhiyun c->key_hash_type = UBIFS_KEY_HASH_R5;
587*4882a593Smuzhiyun break;
588*4882a593Smuzhiyun
589*4882a593Smuzhiyun case UBIFS_KEY_HASH_TEST:
590*4882a593Smuzhiyun c->key_hash = key_test_hash;
591*4882a593Smuzhiyun c->key_hash_type = UBIFS_KEY_HASH_TEST;
592*4882a593Smuzhiyun break;
593*4882a593Smuzhiyun };
594*4882a593Smuzhiyun
595*4882a593Smuzhiyun c->key_fmt = sup->key_fmt;
596*4882a593Smuzhiyun
597*4882a593Smuzhiyun switch (c->key_fmt) {
598*4882a593Smuzhiyun case UBIFS_SIMPLE_KEY_FMT:
599*4882a593Smuzhiyun c->key_len = UBIFS_SK_LEN;
600*4882a593Smuzhiyun break;
601*4882a593Smuzhiyun default:
602*4882a593Smuzhiyun ubifs_err(c, "unsupported key format");
603*4882a593Smuzhiyun err = -EINVAL;
604*4882a593Smuzhiyun goto out;
605*4882a593Smuzhiyun }
606*4882a593Smuzhiyun
607*4882a593Smuzhiyun c->leb_cnt = le32_to_cpu(sup->leb_cnt);
608*4882a593Smuzhiyun c->max_leb_cnt = le32_to_cpu(sup->max_leb_cnt);
609*4882a593Smuzhiyun c->max_bud_bytes = le64_to_cpu(sup->max_bud_bytes);
610*4882a593Smuzhiyun c->log_lebs = le32_to_cpu(sup->log_lebs);
611*4882a593Smuzhiyun c->lpt_lebs = le32_to_cpu(sup->lpt_lebs);
612*4882a593Smuzhiyun c->orph_lebs = le32_to_cpu(sup->orph_lebs);
613*4882a593Smuzhiyun c->jhead_cnt = le32_to_cpu(sup->jhead_cnt) + NONDATA_JHEADS_CNT;
614*4882a593Smuzhiyun c->fanout = le32_to_cpu(sup->fanout);
615*4882a593Smuzhiyun c->lsave_cnt = le32_to_cpu(sup->lsave_cnt);
616*4882a593Smuzhiyun c->rp_size = le64_to_cpu(sup->rp_size);
617*4882a593Smuzhiyun #ifndef __UBOOT__
618*4882a593Smuzhiyun c->rp_uid = make_kuid(&init_user_ns, le32_to_cpu(sup->rp_uid));
619*4882a593Smuzhiyun c->rp_gid = make_kgid(&init_user_ns, le32_to_cpu(sup->rp_gid));
620*4882a593Smuzhiyun #else
621*4882a593Smuzhiyun c->rp_uid.val = le32_to_cpu(sup->rp_uid);
622*4882a593Smuzhiyun c->rp_gid.val = le32_to_cpu(sup->rp_gid);
623*4882a593Smuzhiyun #endif
624*4882a593Smuzhiyun sup_flags = le32_to_cpu(sup->flags);
625*4882a593Smuzhiyun if (!c->mount_opts.override_compr)
626*4882a593Smuzhiyun c->default_compr = le16_to_cpu(sup->default_compr);
627*4882a593Smuzhiyun
628*4882a593Smuzhiyun c->vfs_sb->s_time_gran = le32_to_cpu(sup->time_gran);
629*4882a593Smuzhiyun memcpy(&c->uuid, &sup->uuid, 16);
630*4882a593Smuzhiyun c->big_lpt = !!(sup_flags & UBIFS_FLG_BIGLPT);
631*4882a593Smuzhiyun c->space_fixup = !!(sup_flags & UBIFS_FLG_SPACE_FIXUP);
632*4882a593Smuzhiyun
633*4882a593Smuzhiyun /* Automatically increase file system size to the maximum size */
634*4882a593Smuzhiyun c->old_leb_cnt = c->leb_cnt;
635*4882a593Smuzhiyun if (c->leb_cnt < c->vi.size && c->leb_cnt < c->max_leb_cnt) {
636*4882a593Smuzhiyun c->leb_cnt = min_t(int, c->max_leb_cnt, c->vi.size);
637*4882a593Smuzhiyun if (c->ro_mount)
638*4882a593Smuzhiyun dbg_mnt("Auto resizing (ro) from %d LEBs to %d LEBs",
639*4882a593Smuzhiyun c->old_leb_cnt, c->leb_cnt);
640*4882a593Smuzhiyun #ifndef __UBOOT__
641*4882a593Smuzhiyun else {
642*4882a593Smuzhiyun dbg_mnt("Auto resizing (sb) from %d LEBs to %d LEBs",
643*4882a593Smuzhiyun c->old_leb_cnt, c->leb_cnt);
644*4882a593Smuzhiyun sup->leb_cnt = cpu_to_le32(c->leb_cnt);
645*4882a593Smuzhiyun err = ubifs_write_sb_node(c, sup);
646*4882a593Smuzhiyun if (err)
647*4882a593Smuzhiyun goto out;
648*4882a593Smuzhiyun c->old_leb_cnt = c->leb_cnt;
649*4882a593Smuzhiyun }
650*4882a593Smuzhiyun #endif
651*4882a593Smuzhiyun }
652*4882a593Smuzhiyun
653*4882a593Smuzhiyun c->log_bytes = (long long)c->log_lebs * c->leb_size;
654*4882a593Smuzhiyun c->log_last = UBIFS_LOG_LNUM + c->log_lebs - 1;
655*4882a593Smuzhiyun c->lpt_first = UBIFS_LOG_LNUM + c->log_lebs;
656*4882a593Smuzhiyun c->lpt_last = c->lpt_first + c->lpt_lebs - 1;
657*4882a593Smuzhiyun c->orph_first = c->lpt_last + 1;
658*4882a593Smuzhiyun c->orph_last = c->orph_first + c->orph_lebs - 1;
659*4882a593Smuzhiyun c->main_lebs = c->leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS;
660*4882a593Smuzhiyun c->main_lebs -= c->log_lebs + c->lpt_lebs + c->orph_lebs;
661*4882a593Smuzhiyun c->main_first = c->leb_cnt - c->main_lebs;
662*4882a593Smuzhiyun
663*4882a593Smuzhiyun err = validate_sb(c, sup);
664*4882a593Smuzhiyun out:
665*4882a593Smuzhiyun kfree(sup);
666*4882a593Smuzhiyun return err;
667*4882a593Smuzhiyun }
668*4882a593Smuzhiyun
669*4882a593Smuzhiyun /**
670*4882a593Smuzhiyun * fixup_leb - fixup/unmap an LEB containing free space.
671*4882a593Smuzhiyun * @c: UBIFS file-system description object
672*4882a593Smuzhiyun * @lnum: the LEB number to fix up
673*4882a593Smuzhiyun * @len: number of used bytes in LEB (starting at offset 0)
674*4882a593Smuzhiyun *
675*4882a593Smuzhiyun * This function reads the contents of the given LEB number @lnum, then fixes
676*4882a593Smuzhiyun * it up, so that empty min. I/O units in the end of LEB are actually erased on
677*4882a593Smuzhiyun * flash (rather than being just all-0xff real data). If the LEB is completely
678*4882a593Smuzhiyun * empty, it is simply unmapped.
679*4882a593Smuzhiyun */
fixup_leb(struct ubifs_info * c,int lnum,int len)680*4882a593Smuzhiyun static int fixup_leb(struct ubifs_info *c, int lnum, int len)
681*4882a593Smuzhiyun {
682*4882a593Smuzhiyun int err;
683*4882a593Smuzhiyun
684*4882a593Smuzhiyun ubifs_assert(len >= 0);
685*4882a593Smuzhiyun ubifs_assert(len % c->min_io_size == 0);
686*4882a593Smuzhiyun ubifs_assert(len < c->leb_size);
687*4882a593Smuzhiyun
688*4882a593Smuzhiyun if (len == 0) {
689*4882a593Smuzhiyun dbg_mnt("unmap empty LEB %d", lnum);
690*4882a593Smuzhiyun return ubifs_leb_unmap(c, lnum);
691*4882a593Smuzhiyun }
692*4882a593Smuzhiyun
693*4882a593Smuzhiyun dbg_mnt("fixup LEB %d, data len %d", lnum, len);
694*4882a593Smuzhiyun err = ubifs_leb_read(c, lnum, c->sbuf, 0, len, 1);
695*4882a593Smuzhiyun if (err)
696*4882a593Smuzhiyun return err;
697*4882a593Smuzhiyun
698*4882a593Smuzhiyun return ubifs_leb_change(c, lnum, c->sbuf, len);
699*4882a593Smuzhiyun }
700*4882a593Smuzhiyun
701*4882a593Smuzhiyun /**
702*4882a593Smuzhiyun * fixup_free_space - find & remap all LEBs containing free space.
703*4882a593Smuzhiyun * @c: UBIFS file-system description object
704*4882a593Smuzhiyun *
705*4882a593Smuzhiyun * This function walks through all LEBs in the filesystem and fiexes up those
706*4882a593Smuzhiyun * containing free/empty space.
707*4882a593Smuzhiyun */
fixup_free_space(struct ubifs_info * c)708*4882a593Smuzhiyun static int fixup_free_space(struct ubifs_info *c)
709*4882a593Smuzhiyun {
710*4882a593Smuzhiyun int lnum, err = 0;
711*4882a593Smuzhiyun struct ubifs_lprops *lprops;
712*4882a593Smuzhiyun
713*4882a593Smuzhiyun ubifs_get_lprops(c);
714*4882a593Smuzhiyun
715*4882a593Smuzhiyun /* Fixup LEBs in the master area */
716*4882a593Smuzhiyun for (lnum = UBIFS_MST_LNUM; lnum < UBIFS_LOG_LNUM; lnum++) {
717*4882a593Smuzhiyun err = fixup_leb(c, lnum, c->mst_offs + c->mst_node_alsz);
718*4882a593Smuzhiyun if (err)
719*4882a593Smuzhiyun goto out;
720*4882a593Smuzhiyun }
721*4882a593Smuzhiyun
722*4882a593Smuzhiyun /* Unmap unused log LEBs */
723*4882a593Smuzhiyun lnum = ubifs_next_log_lnum(c, c->lhead_lnum);
724*4882a593Smuzhiyun while (lnum != c->ltail_lnum) {
725*4882a593Smuzhiyun err = fixup_leb(c, lnum, 0);
726*4882a593Smuzhiyun if (err)
727*4882a593Smuzhiyun goto out;
728*4882a593Smuzhiyun lnum = ubifs_next_log_lnum(c, lnum);
729*4882a593Smuzhiyun }
730*4882a593Smuzhiyun
731*4882a593Smuzhiyun /*
732*4882a593Smuzhiyun * Fixup the log head which contains the only a CS node at the
733*4882a593Smuzhiyun * beginning.
734*4882a593Smuzhiyun */
735*4882a593Smuzhiyun err = fixup_leb(c, c->lhead_lnum,
736*4882a593Smuzhiyun ALIGN(UBIFS_CS_NODE_SZ, c->min_io_size));
737*4882a593Smuzhiyun if (err)
738*4882a593Smuzhiyun goto out;
739*4882a593Smuzhiyun
740*4882a593Smuzhiyun /* Fixup LEBs in the LPT area */
741*4882a593Smuzhiyun for (lnum = c->lpt_first; lnum <= c->lpt_last; lnum++) {
742*4882a593Smuzhiyun int free = c->ltab[lnum - c->lpt_first].free;
743*4882a593Smuzhiyun
744*4882a593Smuzhiyun if (free > 0) {
745*4882a593Smuzhiyun err = fixup_leb(c, lnum, c->leb_size - free);
746*4882a593Smuzhiyun if (err)
747*4882a593Smuzhiyun goto out;
748*4882a593Smuzhiyun }
749*4882a593Smuzhiyun }
750*4882a593Smuzhiyun
751*4882a593Smuzhiyun /* Unmap LEBs in the orphans area */
752*4882a593Smuzhiyun for (lnum = c->orph_first; lnum <= c->orph_last; lnum++) {
753*4882a593Smuzhiyun err = fixup_leb(c, lnum, 0);
754*4882a593Smuzhiyun if (err)
755*4882a593Smuzhiyun goto out;
756*4882a593Smuzhiyun }
757*4882a593Smuzhiyun
758*4882a593Smuzhiyun /* Fixup LEBs in the main area */
759*4882a593Smuzhiyun for (lnum = c->main_first; lnum < c->leb_cnt; lnum++) {
760*4882a593Smuzhiyun lprops = ubifs_lpt_lookup(c, lnum);
761*4882a593Smuzhiyun if (IS_ERR(lprops)) {
762*4882a593Smuzhiyun err = PTR_ERR(lprops);
763*4882a593Smuzhiyun goto out;
764*4882a593Smuzhiyun }
765*4882a593Smuzhiyun
766*4882a593Smuzhiyun if (lprops->free > 0) {
767*4882a593Smuzhiyun err = fixup_leb(c, lnum, c->leb_size - lprops->free);
768*4882a593Smuzhiyun if (err)
769*4882a593Smuzhiyun goto out;
770*4882a593Smuzhiyun }
771*4882a593Smuzhiyun }
772*4882a593Smuzhiyun
773*4882a593Smuzhiyun out:
774*4882a593Smuzhiyun ubifs_release_lprops(c);
775*4882a593Smuzhiyun return err;
776*4882a593Smuzhiyun }
777*4882a593Smuzhiyun
778*4882a593Smuzhiyun /**
779*4882a593Smuzhiyun * ubifs_fixup_free_space - find & fix all LEBs with free space.
780*4882a593Smuzhiyun * @c: UBIFS file-system description object
781*4882a593Smuzhiyun *
782*4882a593Smuzhiyun * This function fixes up LEBs containing free space on first mount, if the
783*4882a593Smuzhiyun * appropriate flag was set when the FS was created. Each LEB with one or more
784*4882a593Smuzhiyun * empty min. I/O unit (i.e. free-space-count > 0) is re-written, to make sure
785*4882a593Smuzhiyun * the free space is actually erased. E.g., this is necessary for some NAND
786*4882a593Smuzhiyun * chips, since the free space may have been programmed like real "0xff" data
787*4882a593Smuzhiyun * (generating a non-0xff ECC), causing future writes to the not-really-erased
788*4882a593Smuzhiyun * NAND pages to behave badly. After the space is fixed up, the superblock flag
789*4882a593Smuzhiyun * is cleared, so that this is skipped for all future mounts.
790*4882a593Smuzhiyun */
ubifs_fixup_free_space(struct ubifs_info * c)791*4882a593Smuzhiyun int ubifs_fixup_free_space(struct ubifs_info *c)
792*4882a593Smuzhiyun {
793*4882a593Smuzhiyun int err;
794*4882a593Smuzhiyun struct ubifs_sb_node *sup;
795*4882a593Smuzhiyun
796*4882a593Smuzhiyun ubifs_assert(c->space_fixup);
797*4882a593Smuzhiyun ubifs_assert(!c->ro_mount);
798*4882a593Smuzhiyun
799*4882a593Smuzhiyun ubifs_msg(c, "start fixing up free space");
800*4882a593Smuzhiyun
801*4882a593Smuzhiyun err = fixup_free_space(c);
802*4882a593Smuzhiyun if (err)
803*4882a593Smuzhiyun return err;
804*4882a593Smuzhiyun
805*4882a593Smuzhiyun sup = ubifs_read_sb_node(c);
806*4882a593Smuzhiyun if (IS_ERR(sup))
807*4882a593Smuzhiyun return PTR_ERR(sup);
808*4882a593Smuzhiyun
809*4882a593Smuzhiyun /* Free-space fixup is no longer required */
810*4882a593Smuzhiyun c->space_fixup = 0;
811*4882a593Smuzhiyun sup->flags &= cpu_to_le32(~UBIFS_FLG_SPACE_FIXUP);
812*4882a593Smuzhiyun
813*4882a593Smuzhiyun err = ubifs_write_sb_node(c, sup);
814*4882a593Smuzhiyun kfree(sup);
815*4882a593Smuzhiyun if (err)
816*4882a593Smuzhiyun return err;
817*4882a593Smuzhiyun
818*4882a593Smuzhiyun ubifs_msg(c, "free space fixup complete");
819*4882a593Smuzhiyun return err;
820*4882a593Smuzhiyun }
821