19eefe2a2SStefan Roese /*
29eefe2a2SStefan Roese * This file is part of UBIFS.
39eefe2a2SStefan Roese *
49eefe2a2SStefan Roese * Copyright (C) 2006-2008 Nokia Corporation.
59eefe2a2SStefan Roese *
6ff94bc40SHeiko Schocher * SPDX-License-Identifier: GPL-2.0+
79eefe2a2SStefan Roese *
89eefe2a2SStefan Roese * Authors: Artem Bityutskiy (Битюцкий Артём)
99eefe2a2SStefan Roese * Adrian Hunter
109eefe2a2SStefan Roese */
119eefe2a2SStefan Roese
129eefe2a2SStefan Roese /*
139eefe2a2SStefan Roese * This file implements UBIFS superblock. The superblock is stored at the first
149eefe2a2SStefan Roese * LEB of the volume and is never changed by UBIFS. Only user-space tools may
159eefe2a2SStefan Roese * change it. The superblock node mostly contains geometry information.
169eefe2a2SStefan Roese */
179eefe2a2SStefan Roese
189eefe2a2SStefan Roese #include "ubifs.h"
19ff94bc40SHeiko Schocher #ifndef __UBOOT__
20ff94bc40SHeiko Schocher #include <linux/slab.h>
21ff94bc40SHeiko Schocher #include <linux/random.h>
22ff94bc40SHeiko Schocher #include <linux/math64.h>
23ff94bc40SHeiko Schocher #else
24ff94bc40SHeiko Schocher
25ff94bc40SHeiko Schocher #include <linux/compat.h>
26ff94bc40SHeiko Schocher #include <linux/err.h>
27ff94bc40SHeiko Schocher #include <ubi_uboot.h>
28ff94bc40SHeiko Schocher #include <linux/stat.h>
29ff94bc40SHeiko Schocher #endif
309eefe2a2SStefan Roese
319eefe2a2SStefan Roese /*
329eefe2a2SStefan Roese * Default journal size in logical eraseblocks as a percent of total
339eefe2a2SStefan Roese * flash size.
349eefe2a2SStefan Roese */
359eefe2a2SStefan Roese #define DEFAULT_JNL_PERCENT 5
369eefe2a2SStefan Roese
379eefe2a2SStefan Roese /* Default maximum journal size in bytes */
389eefe2a2SStefan Roese #define DEFAULT_MAX_JNL (32*1024*1024)
399eefe2a2SStefan Roese
409eefe2a2SStefan Roese /* Default indexing tree fanout */
419eefe2a2SStefan Roese #define DEFAULT_FANOUT 8
429eefe2a2SStefan Roese
439eefe2a2SStefan Roese /* Default number of data journal heads */
449eefe2a2SStefan Roese #define DEFAULT_JHEADS_CNT 1
459eefe2a2SStefan Roese
469eefe2a2SStefan Roese /* Default positions of different LEBs in the main area */
479eefe2a2SStefan Roese #define DEFAULT_IDX_LEB 0
489eefe2a2SStefan Roese #define DEFAULT_DATA_LEB 1
499eefe2a2SStefan Roese #define DEFAULT_GC_LEB 2
509eefe2a2SStefan Roese
519eefe2a2SStefan Roese /* Default number of LEB numbers in LPT's save table */
529eefe2a2SStefan Roese #define DEFAULT_LSAVE_CNT 256
539eefe2a2SStefan Roese
549eefe2a2SStefan Roese /* Default reserved pool size as a percent of maximum free space */
559eefe2a2SStefan Roese #define DEFAULT_RP_PERCENT 5
569eefe2a2SStefan Roese
579eefe2a2SStefan Roese /* The default maximum size of reserved pool in bytes */
589eefe2a2SStefan Roese #define DEFAULT_MAX_RP_SIZE (5*1024*1024)
599eefe2a2SStefan Roese
609eefe2a2SStefan Roese /* Default time granularity in nanoseconds */
619eefe2a2SStefan Roese #define DEFAULT_TIME_GRAN 1000000000
629eefe2a2SStefan Roese
63ff94bc40SHeiko Schocher #ifndef __UBOOT__
64ff94bc40SHeiko Schocher /**
65ff94bc40SHeiko Schocher * create_default_filesystem - format empty UBI volume.
66ff94bc40SHeiko Schocher * @c: UBIFS file-system description object
67ff94bc40SHeiko Schocher *
68ff94bc40SHeiko Schocher * This function creates default empty file-system. Returns zero in case of
69ff94bc40SHeiko Schocher * success and a negative error code in case of failure.
70ff94bc40SHeiko Schocher */
create_default_filesystem(struct ubifs_info * c)71ff94bc40SHeiko Schocher static int create_default_filesystem(struct ubifs_info *c)
72ff94bc40SHeiko Schocher {
73ff94bc40SHeiko Schocher struct ubifs_sb_node *sup;
74ff94bc40SHeiko Schocher struct ubifs_mst_node *mst;
75ff94bc40SHeiko Schocher struct ubifs_idx_node *idx;
76ff94bc40SHeiko Schocher struct ubifs_branch *br;
77ff94bc40SHeiko Schocher struct ubifs_ino_node *ino;
78ff94bc40SHeiko Schocher struct ubifs_cs_node *cs;
79ff94bc40SHeiko Schocher union ubifs_key key;
80ff94bc40SHeiko Schocher int err, tmp, jnl_lebs, log_lebs, max_buds, main_lebs, main_first;
81ff94bc40SHeiko Schocher int lpt_lebs, lpt_first, orph_lebs, big_lpt, ino_waste, sup_flags = 0;
82ff94bc40SHeiko Schocher int min_leb_cnt = UBIFS_MIN_LEB_CNT;
83ff94bc40SHeiko Schocher long long tmp64, main_bytes;
84ff94bc40SHeiko Schocher __le64 tmp_le64;
85ff94bc40SHeiko Schocher
86ff94bc40SHeiko Schocher /* Some functions called from here depend on the @c->key_len filed */
87ff94bc40SHeiko Schocher c->key_len = UBIFS_SK_LEN;
88ff94bc40SHeiko Schocher
89ff94bc40SHeiko Schocher /*
90ff94bc40SHeiko Schocher * First of all, we have to calculate default file-system geometry -
91ff94bc40SHeiko Schocher * log size, journal size, etc.
92ff94bc40SHeiko Schocher */
93ff94bc40SHeiko Schocher if (c->leb_cnt < 0x7FFFFFFF / DEFAULT_JNL_PERCENT)
94ff94bc40SHeiko Schocher /* We can first multiply then divide and have no overflow */
95ff94bc40SHeiko Schocher jnl_lebs = c->leb_cnt * DEFAULT_JNL_PERCENT / 100;
96ff94bc40SHeiko Schocher else
97ff94bc40SHeiko Schocher jnl_lebs = (c->leb_cnt / 100) * DEFAULT_JNL_PERCENT;
98ff94bc40SHeiko Schocher
99ff94bc40SHeiko Schocher if (jnl_lebs < UBIFS_MIN_JNL_LEBS)
100ff94bc40SHeiko Schocher jnl_lebs = UBIFS_MIN_JNL_LEBS;
101ff94bc40SHeiko Schocher if (jnl_lebs * c->leb_size > DEFAULT_MAX_JNL)
102ff94bc40SHeiko Schocher jnl_lebs = DEFAULT_MAX_JNL / c->leb_size;
103ff94bc40SHeiko Schocher
104ff94bc40SHeiko Schocher /*
105ff94bc40SHeiko Schocher * The log should be large enough to fit reference nodes for all bud
106ff94bc40SHeiko Schocher * LEBs. Because buds do not have to start from the beginning of LEBs
107ff94bc40SHeiko Schocher * (half of the LEB may contain committed data), the log should
108ff94bc40SHeiko Schocher * generally be larger, make it twice as large.
109ff94bc40SHeiko Schocher */
110ff94bc40SHeiko Schocher tmp = 2 * (c->ref_node_alsz * jnl_lebs) + c->leb_size - 1;
111ff94bc40SHeiko Schocher log_lebs = tmp / c->leb_size;
112ff94bc40SHeiko Schocher /* Plus one LEB reserved for commit */
113ff94bc40SHeiko Schocher log_lebs += 1;
114ff94bc40SHeiko Schocher if (c->leb_cnt - min_leb_cnt > 8) {
115ff94bc40SHeiko Schocher /* And some extra space to allow writes while committing */
116ff94bc40SHeiko Schocher log_lebs += 1;
117ff94bc40SHeiko Schocher min_leb_cnt += 1;
118ff94bc40SHeiko Schocher }
119ff94bc40SHeiko Schocher
120ff94bc40SHeiko Schocher max_buds = jnl_lebs - log_lebs;
121ff94bc40SHeiko Schocher if (max_buds < UBIFS_MIN_BUD_LEBS)
122ff94bc40SHeiko Schocher max_buds = UBIFS_MIN_BUD_LEBS;
123ff94bc40SHeiko Schocher
124ff94bc40SHeiko Schocher /*
125ff94bc40SHeiko Schocher * Orphan nodes are stored in a separate area. One node can store a lot
126ff94bc40SHeiko Schocher * of orphan inode numbers, but when new orphan comes we just add a new
127ff94bc40SHeiko Schocher * orphan node. At some point the nodes are consolidated into one
128ff94bc40SHeiko Schocher * orphan node.
129ff94bc40SHeiko Schocher */
130ff94bc40SHeiko Schocher orph_lebs = UBIFS_MIN_ORPH_LEBS;
131ff94bc40SHeiko Schocher if (c->leb_cnt - min_leb_cnt > 1)
132ff94bc40SHeiko Schocher /*
133ff94bc40SHeiko Schocher * For debugging purposes it is better to have at least 2
134ff94bc40SHeiko Schocher * orphan LEBs, because the orphan subsystem would need to do
135ff94bc40SHeiko Schocher * consolidations and would be stressed more.
136ff94bc40SHeiko Schocher */
137ff94bc40SHeiko Schocher orph_lebs += 1;
138ff94bc40SHeiko Schocher
139ff94bc40SHeiko Schocher main_lebs = c->leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS - log_lebs;
140ff94bc40SHeiko Schocher main_lebs -= orph_lebs;
141ff94bc40SHeiko Schocher
142ff94bc40SHeiko Schocher lpt_first = UBIFS_LOG_LNUM + log_lebs;
143ff94bc40SHeiko Schocher c->lsave_cnt = DEFAULT_LSAVE_CNT;
144ff94bc40SHeiko Schocher c->max_leb_cnt = c->leb_cnt;
145ff94bc40SHeiko Schocher err = ubifs_create_dflt_lpt(c, &main_lebs, lpt_first, &lpt_lebs,
146ff94bc40SHeiko Schocher &big_lpt);
147ff94bc40SHeiko Schocher if (err)
148ff94bc40SHeiko Schocher return err;
149ff94bc40SHeiko Schocher
150ff94bc40SHeiko Schocher dbg_gen("LEB Properties Tree created (LEBs %d-%d)", lpt_first,
151ff94bc40SHeiko Schocher lpt_first + lpt_lebs - 1);
152ff94bc40SHeiko Schocher
153ff94bc40SHeiko Schocher main_first = c->leb_cnt - main_lebs;
154ff94bc40SHeiko Schocher
155ff94bc40SHeiko Schocher /* Create default superblock */
156ff94bc40SHeiko Schocher tmp = ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size);
157ff94bc40SHeiko Schocher sup = kzalloc(tmp, GFP_KERNEL);
158ff94bc40SHeiko Schocher if (!sup)
159ff94bc40SHeiko Schocher return -ENOMEM;
160ff94bc40SHeiko Schocher
161ff94bc40SHeiko Schocher tmp64 = (long long)max_buds * c->leb_size;
162ff94bc40SHeiko Schocher if (big_lpt)
163ff94bc40SHeiko Schocher sup_flags |= UBIFS_FLG_BIGLPT;
164ff94bc40SHeiko Schocher
165ff94bc40SHeiko Schocher sup->ch.node_type = UBIFS_SB_NODE;
166ff94bc40SHeiko Schocher sup->key_hash = UBIFS_KEY_HASH_R5;
167ff94bc40SHeiko Schocher sup->flags = cpu_to_le32(sup_flags);
168ff94bc40SHeiko Schocher sup->min_io_size = cpu_to_le32(c->min_io_size);
169ff94bc40SHeiko Schocher sup->leb_size = cpu_to_le32(c->leb_size);
170ff94bc40SHeiko Schocher sup->leb_cnt = cpu_to_le32(c->leb_cnt);
171ff94bc40SHeiko Schocher sup->max_leb_cnt = cpu_to_le32(c->max_leb_cnt);
172ff94bc40SHeiko Schocher sup->max_bud_bytes = cpu_to_le64(tmp64);
173ff94bc40SHeiko Schocher sup->log_lebs = cpu_to_le32(log_lebs);
174ff94bc40SHeiko Schocher sup->lpt_lebs = cpu_to_le32(lpt_lebs);
175ff94bc40SHeiko Schocher sup->orph_lebs = cpu_to_le32(orph_lebs);
176ff94bc40SHeiko Schocher sup->jhead_cnt = cpu_to_le32(DEFAULT_JHEADS_CNT);
177ff94bc40SHeiko Schocher sup->fanout = cpu_to_le32(DEFAULT_FANOUT);
178ff94bc40SHeiko Schocher sup->lsave_cnt = cpu_to_le32(c->lsave_cnt);
179ff94bc40SHeiko Schocher sup->fmt_version = cpu_to_le32(UBIFS_FORMAT_VERSION);
180ff94bc40SHeiko Schocher sup->time_gran = cpu_to_le32(DEFAULT_TIME_GRAN);
181ff94bc40SHeiko Schocher if (c->mount_opts.override_compr)
182ff94bc40SHeiko Schocher sup->default_compr = cpu_to_le16(c->mount_opts.compr_type);
183ff94bc40SHeiko Schocher else
184ff94bc40SHeiko Schocher sup->default_compr = cpu_to_le16(UBIFS_COMPR_LZO);
185ff94bc40SHeiko Schocher
186ff94bc40SHeiko Schocher generate_random_uuid(sup->uuid);
187ff94bc40SHeiko Schocher
188ff94bc40SHeiko Schocher main_bytes = (long long)main_lebs * c->leb_size;
189ff94bc40SHeiko Schocher tmp64 = div_u64(main_bytes * DEFAULT_RP_PERCENT, 100);
190ff94bc40SHeiko Schocher if (tmp64 > DEFAULT_MAX_RP_SIZE)
191ff94bc40SHeiko Schocher tmp64 = DEFAULT_MAX_RP_SIZE;
192ff94bc40SHeiko Schocher sup->rp_size = cpu_to_le64(tmp64);
193ff94bc40SHeiko Schocher sup->ro_compat_version = cpu_to_le32(UBIFS_RO_COMPAT_VERSION);
194ff94bc40SHeiko Schocher
195ff94bc40SHeiko Schocher err = ubifs_write_node(c, sup, UBIFS_SB_NODE_SZ, 0, 0);
196ff94bc40SHeiko Schocher kfree(sup);
197ff94bc40SHeiko Schocher if (err)
198ff94bc40SHeiko Schocher return err;
199ff94bc40SHeiko Schocher
200ff94bc40SHeiko Schocher dbg_gen("default superblock created at LEB 0:0");
201ff94bc40SHeiko Schocher
202ff94bc40SHeiko Schocher /* Create default master node */
203ff94bc40SHeiko Schocher mst = kzalloc(c->mst_node_alsz, GFP_KERNEL);
204ff94bc40SHeiko Schocher if (!mst)
205ff94bc40SHeiko Schocher return -ENOMEM;
206ff94bc40SHeiko Schocher
207ff94bc40SHeiko Schocher mst->ch.node_type = UBIFS_MST_NODE;
208ff94bc40SHeiko Schocher mst->log_lnum = cpu_to_le32(UBIFS_LOG_LNUM);
209ff94bc40SHeiko Schocher mst->highest_inum = cpu_to_le64(UBIFS_FIRST_INO);
210ff94bc40SHeiko Schocher mst->cmt_no = 0;
211ff94bc40SHeiko Schocher mst->root_lnum = cpu_to_le32(main_first + DEFAULT_IDX_LEB);
212ff94bc40SHeiko Schocher mst->root_offs = 0;
213ff94bc40SHeiko Schocher tmp = ubifs_idx_node_sz(c, 1);
214ff94bc40SHeiko Schocher mst->root_len = cpu_to_le32(tmp);
215ff94bc40SHeiko Schocher mst->gc_lnum = cpu_to_le32(main_first + DEFAULT_GC_LEB);
216ff94bc40SHeiko Schocher mst->ihead_lnum = cpu_to_le32(main_first + DEFAULT_IDX_LEB);
217ff94bc40SHeiko Schocher mst->ihead_offs = cpu_to_le32(ALIGN(tmp, c->min_io_size));
218ff94bc40SHeiko Schocher mst->index_size = cpu_to_le64(ALIGN(tmp, 8));
219ff94bc40SHeiko Schocher mst->lpt_lnum = cpu_to_le32(c->lpt_lnum);
220ff94bc40SHeiko Schocher mst->lpt_offs = cpu_to_le32(c->lpt_offs);
221ff94bc40SHeiko Schocher mst->nhead_lnum = cpu_to_le32(c->nhead_lnum);
222ff94bc40SHeiko Schocher mst->nhead_offs = cpu_to_le32(c->nhead_offs);
223ff94bc40SHeiko Schocher mst->ltab_lnum = cpu_to_le32(c->ltab_lnum);
224ff94bc40SHeiko Schocher mst->ltab_offs = cpu_to_le32(c->ltab_offs);
225ff94bc40SHeiko Schocher mst->lsave_lnum = cpu_to_le32(c->lsave_lnum);
226ff94bc40SHeiko Schocher mst->lsave_offs = cpu_to_le32(c->lsave_offs);
227ff94bc40SHeiko Schocher mst->lscan_lnum = cpu_to_le32(main_first);
228ff94bc40SHeiko Schocher mst->empty_lebs = cpu_to_le32(main_lebs - 2);
229ff94bc40SHeiko Schocher mst->idx_lebs = cpu_to_le32(1);
230ff94bc40SHeiko Schocher mst->leb_cnt = cpu_to_le32(c->leb_cnt);
231ff94bc40SHeiko Schocher
232ff94bc40SHeiko Schocher /* Calculate lprops statistics */
233ff94bc40SHeiko Schocher tmp64 = main_bytes;
234ff94bc40SHeiko Schocher tmp64 -= ALIGN(ubifs_idx_node_sz(c, 1), c->min_io_size);
235ff94bc40SHeiko Schocher tmp64 -= ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size);
236ff94bc40SHeiko Schocher mst->total_free = cpu_to_le64(tmp64);
237ff94bc40SHeiko Schocher
238ff94bc40SHeiko Schocher tmp64 = ALIGN(ubifs_idx_node_sz(c, 1), c->min_io_size);
239ff94bc40SHeiko Schocher ino_waste = ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size) -
240ff94bc40SHeiko Schocher UBIFS_INO_NODE_SZ;
241ff94bc40SHeiko Schocher tmp64 += ino_waste;
242ff94bc40SHeiko Schocher tmp64 -= ALIGN(ubifs_idx_node_sz(c, 1), 8);
243ff94bc40SHeiko Schocher mst->total_dirty = cpu_to_le64(tmp64);
244ff94bc40SHeiko Schocher
245ff94bc40SHeiko Schocher /* The indexing LEB does not contribute to dark space */
246ff94bc40SHeiko Schocher tmp64 = ((long long)(c->main_lebs - 1) * c->dark_wm);
247ff94bc40SHeiko Schocher mst->total_dark = cpu_to_le64(tmp64);
248ff94bc40SHeiko Schocher
249ff94bc40SHeiko Schocher mst->total_used = cpu_to_le64(UBIFS_INO_NODE_SZ);
250ff94bc40SHeiko Schocher
251ff94bc40SHeiko Schocher err = ubifs_write_node(c, mst, UBIFS_MST_NODE_SZ, UBIFS_MST_LNUM, 0);
252ff94bc40SHeiko Schocher if (err) {
253ff94bc40SHeiko Schocher kfree(mst);
254ff94bc40SHeiko Schocher return err;
255ff94bc40SHeiko Schocher }
256ff94bc40SHeiko Schocher err = ubifs_write_node(c, mst, UBIFS_MST_NODE_SZ, UBIFS_MST_LNUM + 1,
257ff94bc40SHeiko Schocher 0);
258ff94bc40SHeiko Schocher kfree(mst);
259ff94bc40SHeiko Schocher if (err)
260ff94bc40SHeiko Schocher return err;
261ff94bc40SHeiko Schocher
262ff94bc40SHeiko Schocher dbg_gen("default master node created at LEB %d:0", UBIFS_MST_LNUM);
263ff94bc40SHeiko Schocher
264ff94bc40SHeiko Schocher /* Create the root indexing node */
265ff94bc40SHeiko Schocher tmp = ubifs_idx_node_sz(c, 1);
266ff94bc40SHeiko Schocher idx = kzalloc(ALIGN(tmp, c->min_io_size), GFP_KERNEL);
267ff94bc40SHeiko Schocher if (!idx)
268ff94bc40SHeiko Schocher return -ENOMEM;
269ff94bc40SHeiko Schocher
270ff94bc40SHeiko Schocher c->key_fmt = UBIFS_SIMPLE_KEY_FMT;
271ff94bc40SHeiko Schocher c->key_hash = key_r5_hash;
272ff94bc40SHeiko Schocher
273ff94bc40SHeiko Schocher idx->ch.node_type = UBIFS_IDX_NODE;
274ff94bc40SHeiko Schocher idx->child_cnt = cpu_to_le16(1);
275ff94bc40SHeiko Schocher ino_key_init(c, &key, UBIFS_ROOT_INO);
276ff94bc40SHeiko Schocher br = ubifs_idx_branch(c, idx, 0);
277ff94bc40SHeiko Schocher key_write_idx(c, &key, &br->key);
278ff94bc40SHeiko Schocher br->lnum = cpu_to_le32(main_first + DEFAULT_DATA_LEB);
279ff94bc40SHeiko Schocher br->len = cpu_to_le32(UBIFS_INO_NODE_SZ);
280ff94bc40SHeiko Schocher err = ubifs_write_node(c, idx, tmp, main_first + DEFAULT_IDX_LEB, 0);
281ff94bc40SHeiko Schocher kfree(idx);
282ff94bc40SHeiko Schocher if (err)
283ff94bc40SHeiko Schocher return err;
284ff94bc40SHeiko Schocher
285ff94bc40SHeiko Schocher dbg_gen("default root indexing node created LEB %d:0",
286ff94bc40SHeiko Schocher main_first + DEFAULT_IDX_LEB);
287ff94bc40SHeiko Schocher
288ff94bc40SHeiko Schocher /* Create default root inode */
289ff94bc40SHeiko Schocher tmp = ALIGN(UBIFS_INO_NODE_SZ, c->min_io_size);
290ff94bc40SHeiko Schocher ino = kzalloc(tmp, GFP_KERNEL);
291ff94bc40SHeiko Schocher if (!ino)
292ff94bc40SHeiko Schocher return -ENOMEM;
293ff94bc40SHeiko Schocher
294ff94bc40SHeiko Schocher ino_key_init_flash(c, &ino->key, UBIFS_ROOT_INO);
295ff94bc40SHeiko Schocher ino->ch.node_type = UBIFS_INO_NODE;
296ff94bc40SHeiko Schocher ino->creat_sqnum = cpu_to_le64(++c->max_sqnum);
297ff94bc40SHeiko Schocher ino->nlink = cpu_to_le32(2);
298ff94bc40SHeiko Schocher tmp_le64 = cpu_to_le64(CURRENT_TIME_SEC.tv_sec);
299ff94bc40SHeiko Schocher ino->atime_sec = tmp_le64;
300ff94bc40SHeiko Schocher ino->ctime_sec = tmp_le64;
301ff94bc40SHeiko Schocher ino->mtime_sec = tmp_le64;
302ff94bc40SHeiko Schocher ino->atime_nsec = 0;
303ff94bc40SHeiko Schocher ino->ctime_nsec = 0;
304ff94bc40SHeiko Schocher ino->mtime_nsec = 0;
305ff94bc40SHeiko Schocher ino->mode = cpu_to_le32(S_IFDIR | S_IRUGO | S_IWUSR | S_IXUGO);
306ff94bc40SHeiko Schocher ino->size = cpu_to_le64(UBIFS_INO_NODE_SZ);
307ff94bc40SHeiko Schocher
308ff94bc40SHeiko Schocher /* Set compression enabled by default */
309ff94bc40SHeiko Schocher ino->flags = cpu_to_le32(UBIFS_COMPR_FL);
310ff94bc40SHeiko Schocher
311ff94bc40SHeiko Schocher err = ubifs_write_node(c, ino, UBIFS_INO_NODE_SZ,
312ff94bc40SHeiko Schocher main_first + DEFAULT_DATA_LEB, 0);
313ff94bc40SHeiko Schocher kfree(ino);
314ff94bc40SHeiko Schocher if (err)
315ff94bc40SHeiko Schocher return err;
316ff94bc40SHeiko Schocher
317ff94bc40SHeiko Schocher dbg_gen("root inode created at LEB %d:0",
318ff94bc40SHeiko Schocher main_first + DEFAULT_DATA_LEB);
319ff94bc40SHeiko Schocher
320ff94bc40SHeiko Schocher /*
321ff94bc40SHeiko Schocher * The first node in the log has to be the commit start node. This is
322ff94bc40SHeiko Schocher * always the case during normal file-system operation. Write a fake
323ff94bc40SHeiko Schocher * commit start node to the log.
324ff94bc40SHeiko Schocher */
325ff94bc40SHeiko Schocher tmp = ALIGN(UBIFS_CS_NODE_SZ, c->min_io_size);
326ff94bc40SHeiko Schocher cs = kzalloc(tmp, GFP_KERNEL);
327ff94bc40SHeiko Schocher if (!cs)
328ff94bc40SHeiko Schocher return -ENOMEM;
329ff94bc40SHeiko Schocher
330ff94bc40SHeiko Schocher cs->ch.node_type = UBIFS_CS_NODE;
331ff94bc40SHeiko Schocher err = ubifs_write_node(c, cs, UBIFS_CS_NODE_SZ, UBIFS_LOG_LNUM, 0);
332ff94bc40SHeiko Schocher kfree(cs);
333*0195a7bbSHeiko Schocher if (err)
334*0195a7bbSHeiko Schocher return err;
335ff94bc40SHeiko Schocher
336*0195a7bbSHeiko Schocher ubifs_msg(c, "default file-system created");
337ff94bc40SHeiko Schocher return 0;
338ff94bc40SHeiko Schocher }
339ff94bc40SHeiko Schocher #endif
340ff94bc40SHeiko Schocher
3419eefe2a2SStefan Roese /**
3429eefe2a2SStefan Roese * validate_sb - validate superblock node.
3439eefe2a2SStefan Roese * @c: UBIFS file-system description object
3449eefe2a2SStefan Roese * @sup: superblock node
3459eefe2a2SStefan Roese *
3469eefe2a2SStefan Roese * This function validates superblock node @sup. Since most of data was read
3479eefe2a2SStefan Roese * from the superblock and stored in @c, the function validates fields in @c
3489eefe2a2SStefan Roese * instead. Returns zero in case of success and %-EINVAL in case of validation
3499eefe2a2SStefan Roese * failure.
3509eefe2a2SStefan Roese */
validate_sb(struct ubifs_info * c,struct ubifs_sb_node * sup)3519eefe2a2SStefan Roese static int validate_sb(struct ubifs_info *c, struct ubifs_sb_node *sup)
3529eefe2a2SStefan Roese {
3539eefe2a2SStefan Roese long long max_bytes;
3549eefe2a2SStefan Roese int err = 1, min_leb_cnt;
3559eefe2a2SStefan Roese
3569eefe2a2SStefan Roese if (!c->key_hash) {
3579eefe2a2SStefan Roese err = 2;
3589eefe2a2SStefan Roese goto failed;
3599eefe2a2SStefan Roese }
3609eefe2a2SStefan Roese
3619eefe2a2SStefan Roese if (sup->key_fmt != UBIFS_SIMPLE_KEY_FMT) {
3629eefe2a2SStefan Roese err = 3;
3639eefe2a2SStefan Roese goto failed;
3649eefe2a2SStefan Roese }
3659eefe2a2SStefan Roese
3669eefe2a2SStefan Roese if (le32_to_cpu(sup->min_io_size) != c->min_io_size) {
367*0195a7bbSHeiko Schocher ubifs_err(c, "min. I/O unit mismatch: %d in superblock, %d real",
3689eefe2a2SStefan Roese le32_to_cpu(sup->min_io_size), c->min_io_size);
3699eefe2a2SStefan Roese goto failed;
3709eefe2a2SStefan Roese }
3719eefe2a2SStefan Roese
3729eefe2a2SStefan Roese if (le32_to_cpu(sup->leb_size) != c->leb_size) {
373*0195a7bbSHeiko Schocher ubifs_err(c, "LEB size mismatch: %d in superblock, %d real",
3749eefe2a2SStefan Roese le32_to_cpu(sup->leb_size), c->leb_size);
3759eefe2a2SStefan Roese goto failed;
3769eefe2a2SStefan Roese }
3779eefe2a2SStefan Roese
3789eefe2a2SStefan Roese if (c->log_lebs < UBIFS_MIN_LOG_LEBS ||
3799eefe2a2SStefan Roese c->lpt_lebs < UBIFS_MIN_LPT_LEBS ||
3809eefe2a2SStefan Roese c->orph_lebs < UBIFS_MIN_ORPH_LEBS ||
3819eefe2a2SStefan Roese c->main_lebs < UBIFS_MIN_MAIN_LEBS) {
3829eefe2a2SStefan Roese err = 4;
3839eefe2a2SStefan Roese goto failed;
3849eefe2a2SStefan Roese }
3859eefe2a2SStefan Roese
3869eefe2a2SStefan Roese /*
3879eefe2a2SStefan Roese * Calculate minimum allowed amount of main area LEBs. This is very
3889eefe2a2SStefan Roese * similar to %UBIFS_MIN_LEB_CNT, but we take into account real what we
3899eefe2a2SStefan Roese * have just read from the superblock.
3909eefe2a2SStefan Roese */
3919eefe2a2SStefan Roese min_leb_cnt = UBIFS_SB_LEBS + UBIFS_MST_LEBS + c->log_lebs;
3929eefe2a2SStefan Roese min_leb_cnt += c->lpt_lebs + c->orph_lebs + c->jhead_cnt + 6;
3939eefe2a2SStefan Roese
3949eefe2a2SStefan Roese if (c->leb_cnt < min_leb_cnt || c->leb_cnt > c->vi.size) {
395*0195a7bbSHeiko Schocher ubifs_err(c, "bad LEB count: %d in superblock, %d on UBI volume, %d minimum required",
396ff94bc40SHeiko Schocher c->leb_cnt, c->vi.size, min_leb_cnt);
3979eefe2a2SStefan Roese goto failed;
3989eefe2a2SStefan Roese }
3999eefe2a2SStefan Roese
4009eefe2a2SStefan Roese if (c->max_leb_cnt < c->leb_cnt) {
401*0195a7bbSHeiko Schocher ubifs_err(c, "max. LEB count %d less than LEB count %d",
4029eefe2a2SStefan Roese c->max_leb_cnt, c->leb_cnt);
4039eefe2a2SStefan Roese goto failed;
4049eefe2a2SStefan Roese }
4059eefe2a2SStefan Roese
4069eefe2a2SStefan Roese if (c->main_lebs < UBIFS_MIN_MAIN_LEBS) {
407*0195a7bbSHeiko Schocher ubifs_err(c, "too few main LEBs count %d, must be at least %d",
408ff94bc40SHeiko Schocher c->main_lebs, UBIFS_MIN_MAIN_LEBS);
4099eefe2a2SStefan Roese goto failed;
4109eefe2a2SStefan Roese }
4119eefe2a2SStefan Roese
412ff94bc40SHeiko Schocher max_bytes = (long long)c->leb_size * UBIFS_MIN_BUD_LEBS;
413ff94bc40SHeiko Schocher if (c->max_bud_bytes < max_bytes) {
414*0195a7bbSHeiko Schocher ubifs_err(c, "too small journal (%lld bytes), must be at least %lld bytes",
415ff94bc40SHeiko Schocher c->max_bud_bytes, max_bytes);
416ff94bc40SHeiko Schocher goto failed;
417ff94bc40SHeiko Schocher }
418ff94bc40SHeiko Schocher
419ff94bc40SHeiko Schocher max_bytes = (long long)c->leb_size * c->main_lebs;
420ff94bc40SHeiko Schocher if (c->max_bud_bytes > max_bytes) {
421*0195a7bbSHeiko Schocher ubifs_err(c, "too large journal size (%lld bytes), only %lld bytes available in the main area",
422ff94bc40SHeiko Schocher c->max_bud_bytes, max_bytes);
4239eefe2a2SStefan Roese goto failed;
4249eefe2a2SStefan Roese }
4259eefe2a2SStefan Roese
4269eefe2a2SStefan Roese if (c->jhead_cnt < NONDATA_JHEADS_CNT + 1 ||
4279eefe2a2SStefan Roese c->jhead_cnt > NONDATA_JHEADS_CNT + UBIFS_MAX_JHEADS) {
4289eefe2a2SStefan Roese err = 9;
4299eefe2a2SStefan Roese goto failed;
4309eefe2a2SStefan Roese }
4319eefe2a2SStefan Roese
4329eefe2a2SStefan Roese if (c->fanout < UBIFS_MIN_FANOUT ||
4339eefe2a2SStefan Roese ubifs_idx_node_sz(c, c->fanout) > c->leb_size) {
4349eefe2a2SStefan Roese err = 10;
4359eefe2a2SStefan Roese goto failed;
4369eefe2a2SStefan Roese }
4379eefe2a2SStefan Roese
4389eefe2a2SStefan Roese if (c->lsave_cnt < 0 || (c->lsave_cnt > DEFAULT_LSAVE_CNT &&
4399eefe2a2SStefan Roese c->lsave_cnt > c->max_leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS -
4409eefe2a2SStefan Roese c->log_lebs - c->lpt_lebs - c->orph_lebs)) {
4419eefe2a2SStefan Roese err = 11;
4429eefe2a2SStefan Roese goto failed;
4439eefe2a2SStefan Roese }
4449eefe2a2SStefan Roese
4459eefe2a2SStefan Roese if (UBIFS_SB_LEBS + UBIFS_MST_LEBS + c->log_lebs + c->lpt_lebs +
4469eefe2a2SStefan Roese c->orph_lebs + c->main_lebs != c->leb_cnt) {
4479eefe2a2SStefan Roese err = 12;
4489eefe2a2SStefan Roese goto failed;
4499eefe2a2SStefan Roese }
4509eefe2a2SStefan Roese
451*0195a7bbSHeiko Schocher if (c->default_compr >= UBIFS_COMPR_TYPES_CNT) {
4529eefe2a2SStefan Roese err = 13;
4539eefe2a2SStefan Roese goto failed;
4549eefe2a2SStefan Roese }
4559eefe2a2SStefan Roese
4569eefe2a2SStefan Roese if (c->rp_size < 0 || max_bytes < c->rp_size) {
4579eefe2a2SStefan Roese err = 14;
4589eefe2a2SStefan Roese goto failed;
4599eefe2a2SStefan Roese }
4609eefe2a2SStefan Roese
4619eefe2a2SStefan Roese if (le32_to_cpu(sup->time_gran) > 1000000000 ||
4629eefe2a2SStefan Roese le32_to_cpu(sup->time_gran) < 1) {
4639eefe2a2SStefan Roese err = 15;
4649eefe2a2SStefan Roese goto failed;
4659eefe2a2SStefan Roese }
4669eefe2a2SStefan Roese
4679eefe2a2SStefan Roese return 0;
4689eefe2a2SStefan Roese
4699eefe2a2SStefan Roese failed:
470*0195a7bbSHeiko Schocher ubifs_err(c, "bad superblock, error %d", err);
471ff94bc40SHeiko Schocher ubifs_dump_node(c, sup);
4729eefe2a2SStefan Roese return -EINVAL;
4739eefe2a2SStefan Roese }
4749eefe2a2SStefan Roese
4759eefe2a2SStefan Roese /**
4769eefe2a2SStefan Roese * ubifs_read_sb_node - read superblock node.
4779eefe2a2SStefan Roese * @c: UBIFS file-system description object
4789eefe2a2SStefan Roese *
4799eefe2a2SStefan Roese * This function returns a pointer to the superblock node or a negative error
480ff94bc40SHeiko Schocher * code. Note, the user of this function is responsible of kfree()'ing the
481ff94bc40SHeiko Schocher * returned superblock buffer.
4829eefe2a2SStefan Roese */
ubifs_read_sb_node(struct ubifs_info * c)4839eefe2a2SStefan Roese struct ubifs_sb_node *ubifs_read_sb_node(struct ubifs_info *c)
4849eefe2a2SStefan Roese {
4859eefe2a2SStefan Roese struct ubifs_sb_node *sup;
4869eefe2a2SStefan Roese int err;
4879eefe2a2SStefan Roese
4889eefe2a2SStefan Roese sup = kmalloc(ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size), GFP_NOFS);
4899eefe2a2SStefan Roese if (!sup)
4909eefe2a2SStefan Roese return ERR_PTR(-ENOMEM);
4919eefe2a2SStefan Roese
4929eefe2a2SStefan Roese err = ubifs_read_node(c, sup, UBIFS_SB_NODE, UBIFS_SB_NODE_SZ,
4939eefe2a2SStefan Roese UBIFS_SB_LNUM, 0);
4949eefe2a2SStefan Roese if (err) {
4959eefe2a2SStefan Roese kfree(sup);
4969eefe2a2SStefan Roese return ERR_PTR(err);
4979eefe2a2SStefan Roese }
4989eefe2a2SStefan Roese
4999eefe2a2SStefan Roese return sup;
5009eefe2a2SStefan Roese }
5019eefe2a2SStefan Roese
5029eefe2a2SStefan Roese /**
503ff94bc40SHeiko Schocher * ubifs_write_sb_node - write superblock node.
504ff94bc40SHeiko Schocher * @c: UBIFS file-system description object
505ff94bc40SHeiko Schocher * @sup: superblock node read with 'ubifs_read_sb_node()'
506ff94bc40SHeiko Schocher *
507ff94bc40SHeiko Schocher * This function returns %0 on success and a negative error code on failure.
508ff94bc40SHeiko Schocher */
ubifs_write_sb_node(struct ubifs_info * c,struct ubifs_sb_node * sup)509ff94bc40SHeiko Schocher int ubifs_write_sb_node(struct ubifs_info *c, struct ubifs_sb_node *sup)
510ff94bc40SHeiko Schocher {
511ff94bc40SHeiko Schocher int len = ALIGN(UBIFS_SB_NODE_SZ, c->min_io_size);
512ff94bc40SHeiko Schocher
513ff94bc40SHeiko Schocher ubifs_prepare_node(c, sup, UBIFS_SB_NODE_SZ, 1);
514ff94bc40SHeiko Schocher return ubifs_leb_change(c, UBIFS_SB_LNUM, sup, len);
515ff94bc40SHeiko Schocher }
516ff94bc40SHeiko Schocher
517ff94bc40SHeiko Schocher /**
5189eefe2a2SStefan Roese * ubifs_read_superblock - read superblock.
5199eefe2a2SStefan Roese * @c: UBIFS file-system description object
5209eefe2a2SStefan Roese *
5219eefe2a2SStefan Roese * This function finds, reads and checks the superblock. If an empty UBI volume
5229eefe2a2SStefan Roese * is being mounted, this function creates default superblock. Returns zero in
5239eefe2a2SStefan Roese * case of success, and a negative error code in case of failure.
5249eefe2a2SStefan Roese */
ubifs_read_superblock(struct ubifs_info * c)5259eefe2a2SStefan Roese int ubifs_read_superblock(struct ubifs_info *c)
5269eefe2a2SStefan Roese {
5279eefe2a2SStefan Roese int err, sup_flags;
5289eefe2a2SStefan Roese struct ubifs_sb_node *sup;
5299eefe2a2SStefan Roese
5309eefe2a2SStefan Roese if (c->empty) {
531ff94bc40SHeiko Schocher #ifndef __UBOOT__
532ff94bc40SHeiko Schocher err = create_default_filesystem(c);
533ff94bc40SHeiko Schocher if (err)
534ff94bc40SHeiko Schocher return err;
535ff94bc40SHeiko Schocher #else
5369eefe2a2SStefan Roese printf("No UBIFS filesystem found!\n");
5379eefe2a2SStefan Roese return -1;
538ff94bc40SHeiko Schocher #endif
5399eefe2a2SStefan Roese }
5409eefe2a2SStefan Roese
5419eefe2a2SStefan Roese sup = ubifs_read_sb_node(c);
5429eefe2a2SStefan Roese if (IS_ERR(sup))
5439eefe2a2SStefan Roese return PTR_ERR(sup);
5449eefe2a2SStefan Roese
545febd7e41SArtem Bityutskiy c->fmt_version = le32_to_cpu(sup->fmt_version);
546febd7e41SArtem Bityutskiy c->ro_compat_version = le32_to_cpu(sup->ro_compat_version);
547febd7e41SArtem Bityutskiy
5489eefe2a2SStefan Roese /*
5499eefe2a2SStefan Roese * The software supports all previous versions but not future versions,
5509eefe2a2SStefan Roese * due to the unavailability of time-travelling equipment.
5519eefe2a2SStefan Roese */
5529eefe2a2SStefan Roese if (c->fmt_version > UBIFS_FORMAT_VERSION) {
553ff94bc40SHeiko Schocher ubifs_assert(!c->ro_media || c->ro_mount);
554ff94bc40SHeiko Schocher if (!c->ro_mount ||
555febd7e41SArtem Bityutskiy c->ro_compat_version > UBIFS_RO_COMPAT_VERSION) {
556*0195a7bbSHeiko Schocher ubifs_err(c, "on-flash format version is w%d/r%d, but software only supports up to version w%d/r%d",
557ff94bc40SHeiko Schocher c->fmt_version, c->ro_compat_version,
558ff94bc40SHeiko Schocher UBIFS_FORMAT_VERSION,
559febd7e41SArtem Bityutskiy UBIFS_RO_COMPAT_VERSION);
560febd7e41SArtem Bityutskiy if (c->ro_compat_version <= UBIFS_RO_COMPAT_VERSION) {
561*0195a7bbSHeiko Schocher ubifs_msg(c, "only R/O mounting is possible");
562febd7e41SArtem Bityutskiy err = -EROFS;
563febd7e41SArtem Bityutskiy } else
5649eefe2a2SStefan Roese err = -EINVAL;
5659eefe2a2SStefan Roese goto out;
5669eefe2a2SStefan Roese }
5679eefe2a2SStefan Roese
568febd7e41SArtem Bityutskiy /*
569febd7e41SArtem Bityutskiy * The FS is mounted R/O, and the media format is
570febd7e41SArtem Bityutskiy * R/O-compatible with the UBIFS implementation, so we can
571febd7e41SArtem Bityutskiy * mount.
572febd7e41SArtem Bityutskiy */
573febd7e41SArtem Bityutskiy c->rw_incompat = 1;
574febd7e41SArtem Bityutskiy }
575febd7e41SArtem Bityutskiy
5769eefe2a2SStefan Roese if (c->fmt_version < 3) {
577*0195a7bbSHeiko Schocher ubifs_err(c, "on-flash format version %d is not supported",
5789eefe2a2SStefan Roese c->fmt_version);
5799eefe2a2SStefan Roese err = -EINVAL;
5809eefe2a2SStefan Roese goto out;
5819eefe2a2SStefan Roese }
5829eefe2a2SStefan Roese
5839eefe2a2SStefan Roese switch (sup->key_hash) {
5849eefe2a2SStefan Roese case UBIFS_KEY_HASH_R5:
5859eefe2a2SStefan Roese c->key_hash = key_r5_hash;
5869eefe2a2SStefan Roese c->key_hash_type = UBIFS_KEY_HASH_R5;
5879eefe2a2SStefan Roese break;
5889eefe2a2SStefan Roese
5899eefe2a2SStefan Roese case UBIFS_KEY_HASH_TEST:
5909eefe2a2SStefan Roese c->key_hash = key_test_hash;
5919eefe2a2SStefan Roese c->key_hash_type = UBIFS_KEY_HASH_TEST;
5929eefe2a2SStefan Roese break;
5939eefe2a2SStefan Roese };
5949eefe2a2SStefan Roese
5959eefe2a2SStefan Roese c->key_fmt = sup->key_fmt;
5969eefe2a2SStefan Roese
5979eefe2a2SStefan Roese switch (c->key_fmt) {
5989eefe2a2SStefan Roese case UBIFS_SIMPLE_KEY_FMT:
5999eefe2a2SStefan Roese c->key_len = UBIFS_SK_LEN;
6009eefe2a2SStefan Roese break;
6019eefe2a2SStefan Roese default:
602*0195a7bbSHeiko Schocher ubifs_err(c, "unsupported key format");
6039eefe2a2SStefan Roese err = -EINVAL;
6049eefe2a2SStefan Roese goto out;
6059eefe2a2SStefan Roese }
6069eefe2a2SStefan Roese
6079eefe2a2SStefan Roese c->leb_cnt = le32_to_cpu(sup->leb_cnt);
6089eefe2a2SStefan Roese c->max_leb_cnt = le32_to_cpu(sup->max_leb_cnt);
6099eefe2a2SStefan Roese c->max_bud_bytes = le64_to_cpu(sup->max_bud_bytes);
6109eefe2a2SStefan Roese c->log_lebs = le32_to_cpu(sup->log_lebs);
6119eefe2a2SStefan Roese c->lpt_lebs = le32_to_cpu(sup->lpt_lebs);
6129eefe2a2SStefan Roese c->orph_lebs = le32_to_cpu(sup->orph_lebs);
6139eefe2a2SStefan Roese c->jhead_cnt = le32_to_cpu(sup->jhead_cnt) + NONDATA_JHEADS_CNT;
6149eefe2a2SStefan Roese c->fanout = le32_to_cpu(sup->fanout);
6159eefe2a2SStefan Roese c->lsave_cnt = le32_to_cpu(sup->lsave_cnt);
6169eefe2a2SStefan Roese c->rp_size = le64_to_cpu(sup->rp_size);
617ff94bc40SHeiko Schocher #ifndef __UBOOT__
618ff94bc40SHeiko Schocher c->rp_uid = make_kuid(&init_user_ns, le32_to_cpu(sup->rp_uid));
619ff94bc40SHeiko Schocher c->rp_gid = make_kgid(&init_user_ns, le32_to_cpu(sup->rp_gid));
620ff94bc40SHeiko Schocher #else
621ff94bc40SHeiko Schocher c->rp_uid.val = le32_to_cpu(sup->rp_uid);
622ff94bc40SHeiko Schocher c->rp_gid.val = le32_to_cpu(sup->rp_gid);
623ff94bc40SHeiko Schocher #endif
6249eefe2a2SStefan Roese sup_flags = le32_to_cpu(sup->flags);
625ff94bc40SHeiko Schocher if (!c->mount_opts.override_compr)
626ff94bc40SHeiko Schocher c->default_compr = le16_to_cpu(sup->default_compr);
6279eefe2a2SStefan Roese
6289eefe2a2SStefan Roese c->vfs_sb->s_time_gran = le32_to_cpu(sup->time_gran);
6299eefe2a2SStefan Roese memcpy(&c->uuid, &sup->uuid, 16);
6309eefe2a2SStefan Roese c->big_lpt = !!(sup_flags & UBIFS_FLG_BIGLPT);
631ff94bc40SHeiko Schocher c->space_fixup = !!(sup_flags & UBIFS_FLG_SPACE_FIXUP);
6329eefe2a2SStefan Roese
6339eefe2a2SStefan Roese /* Automatically increase file system size to the maximum size */
6349eefe2a2SStefan Roese c->old_leb_cnt = c->leb_cnt;
6359eefe2a2SStefan Roese if (c->leb_cnt < c->vi.size && c->leb_cnt < c->max_leb_cnt) {
6369eefe2a2SStefan Roese c->leb_cnt = min_t(int, c->max_leb_cnt, c->vi.size);
637ff94bc40SHeiko Schocher if (c->ro_mount)
6389eefe2a2SStefan Roese dbg_mnt("Auto resizing (ro) from %d LEBs to %d LEBs",
6399eefe2a2SStefan Roese c->old_leb_cnt, c->leb_cnt);
640ff94bc40SHeiko Schocher #ifndef __UBOOT__
641ff94bc40SHeiko Schocher else {
642ff94bc40SHeiko Schocher dbg_mnt("Auto resizing (sb) from %d LEBs to %d LEBs",
643ff94bc40SHeiko Schocher c->old_leb_cnt, c->leb_cnt);
644ff94bc40SHeiko Schocher sup->leb_cnt = cpu_to_le32(c->leb_cnt);
645ff94bc40SHeiko Schocher err = ubifs_write_sb_node(c, sup);
646ff94bc40SHeiko Schocher if (err)
647ff94bc40SHeiko Schocher goto out;
648ff94bc40SHeiko Schocher c->old_leb_cnt = c->leb_cnt;
649ff94bc40SHeiko Schocher }
650ff94bc40SHeiko Schocher #endif
6519eefe2a2SStefan Roese }
6529eefe2a2SStefan Roese
6539eefe2a2SStefan Roese c->log_bytes = (long long)c->log_lebs * c->leb_size;
6549eefe2a2SStefan Roese c->log_last = UBIFS_LOG_LNUM + c->log_lebs - 1;
6559eefe2a2SStefan Roese c->lpt_first = UBIFS_LOG_LNUM + c->log_lebs;
6569eefe2a2SStefan Roese c->lpt_last = c->lpt_first + c->lpt_lebs - 1;
6579eefe2a2SStefan Roese c->orph_first = c->lpt_last + 1;
6589eefe2a2SStefan Roese c->orph_last = c->orph_first + c->orph_lebs - 1;
6599eefe2a2SStefan Roese c->main_lebs = c->leb_cnt - UBIFS_SB_LEBS - UBIFS_MST_LEBS;
6609eefe2a2SStefan Roese c->main_lebs -= c->log_lebs + c->lpt_lebs + c->orph_lebs;
6619eefe2a2SStefan Roese c->main_first = c->leb_cnt - c->main_lebs;
6629eefe2a2SStefan Roese
6639eefe2a2SStefan Roese err = validate_sb(c, sup);
6649eefe2a2SStefan Roese out:
6659eefe2a2SStefan Roese kfree(sup);
6669eefe2a2SStefan Roese return err;
6679eefe2a2SStefan Roese }
668ff94bc40SHeiko Schocher
669ff94bc40SHeiko Schocher /**
670ff94bc40SHeiko Schocher * fixup_leb - fixup/unmap an LEB containing free space.
671ff94bc40SHeiko Schocher * @c: UBIFS file-system description object
672ff94bc40SHeiko Schocher * @lnum: the LEB number to fix up
673ff94bc40SHeiko Schocher * @len: number of used bytes in LEB (starting at offset 0)
674ff94bc40SHeiko Schocher *
675ff94bc40SHeiko Schocher * This function reads the contents of the given LEB number @lnum, then fixes
676ff94bc40SHeiko Schocher * it up, so that empty min. I/O units in the end of LEB are actually erased on
677ff94bc40SHeiko Schocher * flash (rather than being just all-0xff real data). If the LEB is completely
678ff94bc40SHeiko Schocher * empty, it is simply unmapped.
679ff94bc40SHeiko Schocher */
fixup_leb(struct ubifs_info * c,int lnum,int len)680ff94bc40SHeiko Schocher static int fixup_leb(struct ubifs_info *c, int lnum, int len)
681ff94bc40SHeiko Schocher {
682ff94bc40SHeiko Schocher int err;
683ff94bc40SHeiko Schocher
684ff94bc40SHeiko Schocher ubifs_assert(len >= 0);
685ff94bc40SHeiko Schocher ubifs_assert(len % c->min_io_size == 0);
686ff94bc40SHeiko Schocher ubifs_assert(len < c->leb_size);
687ff94bc40SHeiko Schocher
688ff94bc40SHeiko Schocher if (len == 0) {
689ff94bc40SHeiko Schocher dbg_mnt("unmap empty LEB %d", lnum);
690ff94bc40SHeiko Schocher return ubifs_leb_unmap(c, lnum);
691ff94bc40SHeiko Schocher }
692ff94bc40SHeiko Schocher
693ff94bc40SHeiko Schocher dbg_mnt("fixup LEB %d, data len %d", lnum, len);
694ff94bc40SHeiko Schocher err = ubifs_leb_read(c, lnum, c->sbuf, 0, len, 1);
695ff94bc40SHeiko Schocher if (err)
696ff94bc40SHeiko Schocher return err;
697ff94bc40SHeiko Schocher
698ff94bc40SHeiko Schocher return ubifs_leb_change(c, lnum, c->sbuf, len);
699ff94bc40SHeiko Schocher }
700ff94bc40SHeiko Schocher
701ff94bc40SHeiko Schocher /**
702ff94bc40SHeiko Schocher * fixup_free_space - find & remap all LEBs containing free space.
703ff94bc40SHeiko Schocher * @c: UBIFS file-system description object
704ff94bc40SHeiko Schocher *
705ff94bc40SHeiko Schocher * This function walks through all LEBs in the filesystem and fiexes up those
706ff94bc40SHeiko Schocher * containing free/empty space.
707ff94bc40SHeiko Schocher */
fixup_free_space(struct ubifs_info * c)708ff94bc40SHeiko Schocher static int fixup_free_space(struct ubifs_info *c)
709ff94bc40SHeiko Schocher {
710ff94bc40SHeiko Schocher int lnum, err = 0;
711ff94bc40SHeiko Schocher struct ubifs_lprops *lprops;
712ff94bc40SHeiko Schocher
713ff94bc40SHeiko Schocher ubifs_get_lprops(c);
714ff94bc40SHeiko Schocher
715ff94bc40SHeiko Schocher /* Fixup LEBs in the master area */
716ff94bc40SHeiko Schocher for (lnum = UBIFS_MST_LNUM; lnum < UBIFS_LOG_LNUM; lnum++) {
717ff94bc40SHeiko Schocher err = fixup_leb(c, lnum, c->mst_offs + c->mst_node_alsz);
718ff94bc40SHeiko Schocher if (err)
719ff94bc40SHeiko Schocher goto out;
720ff94bc40SHeiko Schocher }
721ff94bc40SHeiko Schocher
722ff94bc40SHeiko Schocher /* Unmap unused log LEBs */
723ff94bc40SHeiko Schocher lnum = ubifs_next_log_lnum(c, c->lhead_lnum);
724ff94bc40SHeiko Schocher while (lnum != c->ltail_lnum) {
725ff94bc40SHeiko Schocher err = fixup_leb(c, lnum, 0);
726ff94bc40SHeiko Schocher if (err)
727ff94bc40SHeiko Schocher goto out;
728ff94bc40SHeiko Schocher lnum = ubifs_next_log_lnum(c, lnum);
729ff94bc40SHeiko Schocher }
730ff94bc40SHeiko Schocher
731ff94bc40SHeiko Schocher /*
732ff94bc40SHeiko Schocher * Fixup the log head which contains the only a CS node at the
733ff94bc40SHeiko Schocher * beginning.
734ff94bc40SHeiko Schocher */
735ff94bc40SHeiko Schocher err = fixup_leb(c, c->lhead_lnum,
736ff94bc40SHeiko Schocher ALIGN(UBIFS_CS_NODE_SZ, c->min_io_size));
737ff94bc40SHeiko Schocher if (err)
738ff94bc40SHeiko Schocher goto out;
739ff94bc40SHeiko Schocher
740ff94bc40SHeiko Schocher /* Fixup LEBs in the LPT area */
741ff94bc40SHeiko Schocher for (lnum = c->lpt_first; lnum <= c->lpt_last; lnum++) {
742ff94bc40SHeiko Schocher int free = c->ltab[lnum - c->lpt_first].free;
743ff94bc40SHeiko Schocher
744ff94bc40SHeiko Schocher if (free > 0) {
745ff94bc40SHeiko Schocher err = fixup_leb(c, lnum, c->leb_size - free);
746ff94bc40SHeiko Schocher if (err)
747ff94bc40SHeiko Schocher goto out;
748ff94bc40SHeiko Schocher }
749ff94bc40SHeiko Schocher }
750ff94bc40SHeiko Schocher
751ff94bc40SHeiko Schocher /* Unmap LEBs in the orphans area */
752ff94bc40SHeiko Schocher for (lnum = c->orph_first; lnum <= c->orph_last; lnum++) {
753ff94bc40SHeiko Schocher err = fixup_leb(c, lnum, 0);
754ff94bc40SHeiko Schocher if (err)
755ff94bc40SHeiko Schocher goto out;
756ff94bc40SHeiko Schocher }
757ff94bc40SHeiko Schocher
758ff94bc40SHeiko Schocher /* Fixup LEBs in the main area */
759ff94bc40SHeiko Schocher for (lnum = c->main_first; lnum < c->leb_cnt; lnum++) {
760ff94bc40SHeiko Schocher lprops = ubifs_lpt_lookup(c, lnum);
761ff94bc40SHeiko Schocher if (IS_ERR(lprops)) {
762ff94bc40SHeiko Schocher err = PTR_ERR(lprops);
763ff94bc40SHeiko Schocher goto out;
764ff94bc40SHeiko Schocher }
765ff94bc40SHeiko Schocher
766ff94bc40SHeiko Schocher if (lprops->free > 0) {
767ff94bc40SHeiko Schocher err = fixup_leb(c, lnum, c->leb_size - lprops->free);
768ff94bc40SHeiko Schocher if (err)
769ff94bc40SHeiko Schocher goto out;
770ff94bc40SHeiko Schocher }
771ff94bc40SHeiko Schocher }
772ff94bc40SHeiko Schocher
773ff94bc40SHeiko Schocher out:
774ff94bc40SHeiko Schocher ubifs_release_lprops(c);
775ff94bc40SHeiko Schocher return err;
776ff94bc40SHeiko Schocher }
777ff94bc40SHeiko Schocher
778ff94bc40SHeiko Schocher /**
779ff94bc40SHeiko Schocher * ubifs_fixup_free_space - find & fix all LEBs with free space.
780ff94bc40SHeiko Schocher * @c: UBIFS file-system description object
781ff94bc40SHeiko Schocher *
782ff94bc40SHeiko Schocher * This function fixes up LEBs containing free space on first mount, if the
783ff94bc40SHeiko Schocher * appropriate flag was set when the FS was created. Each LEB with one or more
784ff94bc40SHeiko Schocher * empty min. I/O unit (i.e. free-space-count > 0) is re-written, to make sure
785ff94bc40SHeiko Schocher * the free space is actually erased. E.g., this is necessary for some NAND
786ff94bc40SHeiko Schocher * chips, since the free space may have been programmed like real "0xff" data
787ff94bc40SHeiko Schocher * (generating a non-0xff ECC), causing future writes to the not-really-erased
788ff94bc40SHeiko Schocher * NAND pages to behave badly. After the space is fixed up, the superblock flag
789ff94bc40SHeiko Schocher * is cleared, so that this is skipped for all future mounts.
790ff94bc40SHeiko Schocher */
ubifs_fixup_free_space(struct ubifs_info * c)791ff94bc40SHeiko Schocher int ubifs_fixup_free_space(struct ubifs_info *c)
792ff94bc40SHeiko Schocher {
793ff94bc40SHeiko Schocher int err;
794ff94bc40SHeiko Schocher struct ubifs_sb_node *sup;
795ff94bc40SHeiko Schocher
796ff94bc40SHeiko Schocher ubifs_assert(c->space_fixup);
797ff94bc40SHeiko Schocher ubifs_assert(!c->ro_mount);
798ff94bc40SHeiko Schocher
799*0195a7bbSHeiko Schocher ubifs_msg(c, "start fixing up free space");
800ff94bc40SHeiko Schocher
801ff94bc40SHeiko Schocher err = fixup_free_space(c);
802ff94bc40SHeiko Schocher if (err)
803ff94bc40SHeiko Schocher return err;
804ff94bc40SHeiko Schocher
805ff94bc40SHeiko Schocher sup = ubifs_read_sb_node(c);
806ff94bc40SHeiko Schocher if (IS_ERR(sup))
807ff94bc40SHeiko Schocher return PTR_ERR(sup);
808ff94bc40SHeiko Schocher
809ff94bc40SHeiko Schocher /* Free-space fixup is no longer required */
810ff94bc40SHeiko Schocher c->space_fixup = 0;
811ff94bc40SHeiko Schocher sup->flags &= cpu_to_le32(~UBIFS_FLG_SPACE_FIXUP);
812ff94bc40SHeiko Schocher
813ff94bc40SHeiko Schocher err = ubifs_write_sb_node(c, sup);
814ff94bc40SHeiko Schocher kfree(sup);
815ff94bc40SHeiko Schocher if (err)
816ff94bc40SHeiko Schocher return err;
817ff94bc40SHeiko Schocher
818*0195a7bbSHeiko Schocher ubifs_msg(c, "free space fixup complete");
819ff94bc40SHeiko Schocher return err;
820ff94bc40SHeiko Schocher }
821