Documentation/vm/Makefile: don't try to build slqbinfo
[linux-2.6.git] / fs / ubifs / budget.c
1 /*
2  * This file is part of UBIFS.
3  *
4  * Copyright (C) 2006-2008 Nokia Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License version 2 as published by
8  * the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13  * more details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 51
17  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18  *
19  * Authors: Adrian Hunter
20  *          Artem Bityutskiy (Битюцкий Артём)
21  */
22
23 /*
24  * This file implements the budgeting sub-system which is responsible for UBIFS
25  * space management.
26  *
27  * Factors such as compression, wasted space at the ends of LEBs, space in other
28  * journal heads, the effect of updates on the index, and so on, make it
29  * impossible to accurately predict the amount of space needed. Consequently
30  * approximations are used.
31  */
32
33 #include "ubifs.h"
34 #include <linux/writeback.h>
35 #include <linux/math64.h>
36
37 /*
38  * When pessimistic budget calculations say that there is no enough space,
39  * UBIFS starts writing back dirty inodes and pages, doing garbage collection,
40  * or committing. The below constant defines maximum number of times UBIFS
41  * repeats the operations.
42  */
43 #define MAX_MKSPC_RETRIES 3
44
45 /*
46  * The below constant defines amount of dirty pages which should be written
47  * back at when trying to shrink the liability.
48  */
49 #define NR_TO_WRITE 16
50
51 /**
52  * shrink_liability - write-back some dirty pages/inodes.
53  * @c: UBIFS file-system description object
54  * @nr_to_write: how many dirty pages to write-back
55  *
56  * This function shrinks UBIFS liability by means of writing back some amount
57  * of dirty inodes and their pages. Returns the amount of pages which were
58  * written back. The returned value does not include dirty inodes which were
59  * synchronized.
60  *
61  * Note, this function synchronizes even VFS inodes which are locked
62  * (@i_mutex) by the caller of the budgeting function, because write-back does
63  * not touch @i_mutex.
64  */
65 static int shrink_liability(struct ubifs_info *c, int nr_to_write)
66 {
67         int nr_written;
68         struct writeback_control wbc = {
69                 .sync_mode   = WB_SYNC_NONE,
70                 .range_end   = LLONG_MAX,
71                 .nr_to_write = nr_to_write,
72         };
73
74         generic_sync_sb_inodes(c->vfs_sb, &wbc);
75         nr_written = nr_to_write - wbc.nr_to_write;
76
77         if (!nr_written) {
78                 /*
79                  * Re-try again but wait on pages/inodes which are being
80                  * written-back concurrently (e.g., by pdflush).
81                  */
82                 memset(&wbc, 0, sizeof(struct writeback_control));
83                 wbc.sync_mode   = WB_SYNC_ALL;
84                 wbc.range_end   = LLONG_MAX;
85                 wbc.nr_to_write = nr_to_write;
86                 generic_sync_sb_inodes(c->vfs_sb, &wbc);
87                 nr_written = nr_to_write - wbc.nr_to_write;
88         }
89
90         dbg_budg("%d pages were written back", nr_written);
91         return nr_written;
92 }
93
94
95 /**
96  * run_gc - run garbage collector.
97  * @c: UBIFS file-system description object
98  *
99  * This function runs garbage collector to make some more free space. Returns
100  * zero if a free LEB has been produced, %-EAGAIN if commit is required, and a
101  * negative error code in case of failure.
102  */
103 static int run_gc(struct ubifs_info *c)
104 {
105         int err, lnum;
106
107         /* Make some free space by garbage-collecting dirty space */
108         down_read(&c->commit_sem);
109         lnum = ubifs_garbage_collect(c, 1);
110         up_read(&c->commit_sem);
111         if (lnum < 0)
112                 return lnum;
113
114         /* GC freed one LEB, return it to lprops */
115         dbg_budg("GC freed LEB %d", lnum);
116         err = ubifs_return_leb(c, lnum);
117         if (err)
118                 return err;
119         return 0;
120 }
121
122 /**
123  * get_liability - calculate current liability.
124  * @c: UBIFS file-system description object
125  *
126  * This function calculates and returns current UBIFS liability, i.e. the
127  * amount of bytes UBIFS has "promised" to write to the media.
128  */
129 static long long get_liability(struct ubifs_info *c)
130 {
131         long long liab;
132
133         spin_lock(&c->space_lock);
134         liab = c->budg_idx_growth + c->budg_data_growth + c->budg_dd_growth;
135         spin_unlock(&c->space_lock);
136         return liab;
137 }
138
139 /**
140  * make_free_space - make more free space on the file-system.
141  * @c: UBIFS file-system description object
142  *
143  * This function is called when an operation cannot be budgeted because there
144  * is supposedly no free space. But in most cases there is some free space:
145  *   o budgeting is pessimistic, so it always budgets more than it is actually
146  *     needed, so shrinking the liability is one way to make free space - the
147  *     cached data will take less space then it was budgeted for;
148  *   o GC may turn some dark space into free space (budgeting treats dark space
149  *     as not available);
150  *   o commit may free some LEB, i.e., turn freeable LEBs into free LEBs.
151  *
152  * So this function tries to do the above. Returns %-EAGAIN if some free space
153  * was presumably made and the caller has to re-try budgeting the operation.
154  * Returns %-ENOSPC if it couldn't do more free space, and other negative error
155  * codes on failures.
156  */
157 static int make_free_space(struct ubifs_info *c)
158 {
159         int err, retries = 0;
160         long long liab1, liab2;
161
162         do {
163                 liab1 = get_liability(c);
164                 /*
165                  * We probably have some dirty pages or inodes (liability), try
166                  * to write them back.
167                  */
168                 dbg_budg("liability %lld, run write-back", liab1);
169                 shrink_liability(c, NR_TO_WRITE);
170
171                 liab2 = get_liability(c);
172                 if (liab2 < liab1)
173                         return -EAGAIN;
174
175                 dbg_budg("new liability %lld (not shrinked)", liab2);
176
177                 /* Liability did not shrink again, try GC */
178                 dbg_budg("Run GC");
179                 err = run_gc(c);
180                 if (!err)
181                         return -EAGAIN;
182
183                 if (err != -EAGAIN && err != -ENOSPC)
184                         /* Some real error happened */
185                         return err;
186
187                 dbg_budg("Run commit (retries %d)", retries);
188                 err = ubifs_run_commit(c);
189                 if (err)
190                         return err;
191         } while (retries++ < MAX_MKSPC_RETRIES);
192
193         return -ENOSPC;
194 }
195
196 /**
197  * ubifs_calc_min_idx_lebs - calculate amount of LEBs for the index.
198  * @c: UBIFS file-system description object
199  *
200  * This function calculates and returns the number of LEBs which should be kept
201  * for index usage.
202  */
203 int ubifs_calc_min_idx_lebs(struct ubifs_info *c)
204 {
205         int idx_lebs;
206         long long idx_size;
207
208         idx_size = c->old_idx_sz + c->budg_idx_growth + c->budg_uncommitted_idx;
209         /* And make sure we have thrice the index size of space reserved */
210         idx_size += idx_size << 1;
211         /*
212          * We do not maintain 'old_idx_size' as 'old_idx_lebs'/'old_idx_bytes'
213          * pair, nor similarly the two variables for the new index size, so we
214          * have to do this costly 64-bit division on fast-path.
215          */
216         idx_lebs = div_u64(idx_size + c->idx_leb_size - 1, c->idx_leb_size);
217         /*
218          * The index head is not available for the in-the-gaps method, so add an
219          * extra LEB to compensate.
220          */
221         idx_lebs += 1;
222         if (idx_lebs < MIN_INDEX_LEBS)
223                 idx_lebs = MIN_INDEX_LEBS;
224         return idx_lebs;
225 }
226
227 /**
228  * ubifs_calc_available - calculate available FS space.
229  * @c: UBIFS file-system description object
230  * @min_idx_lebs: minimum number of LEBs reserved for the index
231  *
232  * This function calculates and returns amount of FS space available for use.
233  */
234 long long ubifs_calc_available(const struct ubifs_info *c, int min_idx_lebs)
235 {
236         int subtract_lebs;
237         long long available;
238
239         available = c->main_bytes - c->lst.total_used;
240
241         /*
242          * Now 'available' contains theoretically available flash space
243          * assuming there is no index, so we have to subtract the space which
244          * is reserved for the index.
245          */
246         subtract_lebs = min_idx_lebs;
247
248         /* Take into account that GC reserves one LEB for its own needs */
249         subtract_lebs += 1;
250
251         /*
252          * The GC journal head LEB is not really accessible. And since
253          * different write types go to different heads, we may count only on
254          * one head's space.
255          */
256         subtract_lebs += c->jhead_cnt - 1;
257
258         /* We also reserve one LEB for deletions, which bypass budgeting */
259         subtract_lebs += 1;
260
261         available -= (long long)subtract_lebs * c->leb_size;
262
263         /* Subtract the dead space which is not available for use */
264         available -= c->lst.total_dead;
265
266         /*
267          * Subtract dark space, which might or might not be usable - it depends
268          * on the data which we have on the media and which will be written. If
269          * this is a lot of uncompressed or not-compressible data, the dark
270          * space cannot be used.
271          */
272         available -= c->lst.total_dark;
273
274         /*
275          * However, there is more dark space. The index may be bigger than
276          * @min_idx_lebs. Those extra LEBs are assumed to be available, but
277          * their dark space is not included in total_dark, so it is subtracted
278          * here.
279          */
280         if (c->lst.idx_lebs > min_idx_lebs) {
281                 subtract_lebs = c->lst.idx_lebs - min_idx_lebs;
282                 available -= subtract_lebs * c->dark_wm;
283         }
284
285         /* The calculations are rough and may end up with a negative number */
286         return available > 0 ? available : 0;
287 }
288
289 /**
290  * can_use_rp - check whether the user is allowed to use reserved pool.
291  * @c: UBIFS file-system description object
292  *
293  * UBIFS has so-called "reserved pool" which is flash space reserved
294  * for the superuser and for uses whose UID/GID is recorded in UBIFS superblock.
295  * This function checks whether current user is allowed to use reserved pool.
296  * Returns %1  current user is allowed to use reserved pool and %0 otherwise.
297  */
298 static int can_use_rp(struct ubifs_info *c)
299 {
300         if (current_fsuid() == c->rp_uid || capable(CAP_SYS_RESOURCE) ||
301             (c->rp_gid != 0 && in_group_p(c->rp_gid)))
302                 return 1;
303         return 0;
304 }
305
306 /**
307  * do_budget_space - reserve flash space for index and data growth.
308  * @c: UBIFS file-system description object
309  *
310  * This function makes sure UBIFS has enough free LEBs for index growth and
311  * data.
312  *
313  * When budgeting index space, UBIFS reserves thrice as many LEBs as the index
314  * would take if it was consolidated and written to the flash. This guarantees
315  * that the "in-the-gaps" commit method always succeeds and UBIFS will always
316  * be able to commit dirty index. So this function basically adds amount of
317  * budgeted index space to the size of the current index, multiplies this by 3,
318  * and makes sure this does not exceed the amount of free LEBs.
319  *
320  * Notes about @c->min_idx_lebs and @c->lst.idx_lebs variables:
321  * o @c->lst.idx_lebs is the number of LEBs the index currently uses. It might
322  *    be large, because UBIFS does not do any index consolidation as long as
323  *    there is free space. IOW, the index may take a lot of LEBs, but the LEBs
324  *    will contain a lot of dirt.
325  * o @c->min_idx_lebs is the number of LEBS the index presumably takes. IOW,
326  *    the index may be consolidated to take up to @c->min_idx_lebs LEBs.
327  *
328  * This function returns zero in case of success, and %-ENOSPC in case of
329  * failure.
330  */
331 static int do_budget_space(struct ubifs_info *c)
332 {
333         long long outstanding, available;
334         int lebs, rsvd_idx_lebs, min_idx_lebs;
335
336         /* First budget index space */
337         min_idx_lebs = ubifs_calc_min_idx_lebs(c);
338
339         /* Now 'min_idx_lebs' contains number of LEBs to reserve */
340         if (min_idx_lebs > c->lst.idx_lebs)
341                 rsvd_idx_lebs = min_idx_lebs - c->lst.idx_lebs;
342         else
343                 rsvd_idx_lebs = 0;
344
345         /*
346          * The number of LEBs that are available to be used by the index is:
347          *
348          *    @c->lst.empty_lebs + @c->freeable_cnt + @c->idx_gc_cnt -
349          *    @c->lst.taken_empty_lebs
350          *
351          * @c->lst.empty_lebs are available because they are empty.
352          * @c->freeable_cnt are available because they contain only free and
353          * dirty space, @c->idx_gc_cnt are available because they are index
354          * LEBs that have been garbage collected and are awaiting the commit
355          * before they can be used. And the in-the-gaps method will grab these
356          * if it needs them. @c->lst.taken_empty_lebs are empty LEBs that have
357          * already been allocated for some purpose.
358          *
359          * Note, @c->idx_gc_cnt is included to both @c->lst.empty_lebs (because
360          * these LEBs are empty) and to @c->lst.taken_empty_lebs (because they
361          * are taken until after the commit).
362          *
363          * Note, @c->lst.taken_empty_lebs may temporarily be higher by one
364          * because of the way we serialize LEB allocations and budgeting. See a
365          * comment in 'ubifs_find_free_space()'.
366          */
367         lebs = c->lst.empty_lebs + c->freeable_cnt + c->idx_gc_cnt -
368                c->lst.taken_empty_lebs;
369         if (unlikely(rsvd_idx_lebs > lebs)) {
370                 dbg_budg("out of indexing space: min_idx_lebs %d (old %d), "
371                          "rsvd_idx_lebs %d", min_idx_lebs, c->min_idx_lebs,
372                          rsvd_idx_lebs);
373                 return -ENOSPC;
374         }
375
376         available = ubifs_calc_available(c, min_idx_lebs);
377         outstanding = c->budg_data_growth + c->budg_dd_growth;
378
379         if (unlikely(available < outstanding)) {
380                 dbg_budg("out of data space: available %lld, outstanding %lld",
381                          available, outstanding);
382                 return -ENOSPC;
383         }
384
385         if (available - outstanding <= c->rp_size && !can_use_rp(c))
386                 return -ENOSPC;
387
388         c->min_idx_lebs = min_idx_lebs;
389         return 0;
390 }
391
392 /**
393  * calc_idx_growth - calculate approximate index growth from budgeting request.
394  * @c: UBIFS file-system description object
395  * @req: budgeting request
396  *
397  * For now we assume each new node adds one znode. But this is rather poor
398  * approximation, though.
399  */
400 static int calc_idx_growth(const struct ubifs_info *c,
401                            const struct ubifs_budget_req *req)
402 {
403         int znodes;
404
405         znodes = req->new_ino + (req->new_page << UBIFS_BLOCKS_PER_PAGE_SHIFT) +
406                  req->new_dent;
407         return znodes * c->max_idx_node_sz;
408 }
409
410 /**
411  * calc_data_growth - calculate approximate amount of new data from budgeting
412  * request.
413  * @c: UBIFS file-system description object
414  * @req: budgeting request
415  */
416 static int calc_data_growth(const struct ubifs_info *c,
417                             const struct ubifs_budget_req *req)
418 {
419         int data_growth;
420
421         data_growth = req->new_ino  ? c->inode_budget : 0;
422         if (req->new_page)
423                 data_growth += c->page_budget;
424         if (req->new_dent)
425                 data_growth += c->dent_budget;
426         data_growth += req->new_ino_d;
427         return data_growth;
428 }
429
430 /**
431  * calc_dd_growth - calculate approximate amount of data which makes other data
432  * dirty from budgeting request.
433  * @c: UBIFS file-system description object
434  * @req: budgeting request
435  */
436 static int calc_dd_growth(const struct ubifs_info *c,
437                           const struct ubifs_budget_req *req)
438 {
439         int dd_growth;
440
441         dd_growth = req->dirtied_page ? c->page_budget : 0;
442
443         if (req->dirtied_ino)
444                 dd_growth += c->inode_budget << (req->dirtied_ino - 1);
445         if (req->mod_dent)
446                 dd_growth += c->dent_budget;
447         dd_growth += req->dirtied_ino_d;
448         return dd_growth;
449 }
450
451 /**
452  * ubifs_budget_space - ensure there is enough space to complete an operation.
453  * @c: UBIFS file-system description object
454  * @req: budget request
455  *
456  * This function allocates budget for an operation. It uses pessimistic
457  * approximation of how much flash space the operation needs. The goal of this
458  * function is to make sure UBIFS always has flash space to flush all dirty
459  * pages, dirty inodes, and dirty znodes (liability). This function may force
460  * commit, garbage-collection or write-back. Returns zero in case of success,
461  * %-ENOSPC if there is no free space and other negative error codes in case of
462  * failures.
463  */
464 int ubifs_budget_space(struct ubifs_info *c, struct ubifs_budget_req *req)
465 {
466         int uninitialized_var(cmt_retries), uninitialized_var(wb_retries);
467         int err, idx_growth, data_growth, dd_growth, retried = 0;
468
469         ubifs_assert(req->new_page <= 1);
470         ubifs_assert(req->dirtied_page <= 1);
471         ubifs_assert(req->new_dent <= 1);
472         ubifs_assert(req->mod_dent <= 1);
473         ubifs_assert(req->new_ino <= 1);
474         ubifs_assert(req->new_ino_d <= UBIFS_MAX_INO_DATA);
475         ubifs_assert(req->dirtied_ino <= 4);
476         ubifs_assert(req->dirtied_ino_d <= UBIFS_MAX_INO_DATA * 4);
477         ubifs_assert(!(req->new_ino_d & 7));
478         ubifs_assert(!(req->dirtied_ino_d & 7));
479
480         data_growth = calc_data_growth(c, req);
481         dd_growth = calc_dd_growth(c, req);
482         if (!data_growth && !dd_growth)
483                 return 0;
484         idx_growth = calc_idx_growth(c, req);
485
486 again:
487         spin_lock(&c->space_lock);
488         ubifs_assert(c->budg_idx_growth >= 0);
489         ubifs_assert(c->budg_data_growth >= 0);
490         ubifs_assert(c->budg_dd_growth >= 0);
491
492         if (unlikely(c->nospace) && (c->nospace_rp || !can_use_rp(c))) {
493                 dbg_budg("no space");
494                 spin_unlock(&c->space_lock);
495                 return -ENOSPC;
496         }
497
498         c->budg_idx_growth += idx_growth;
499         c->budg_data_growth += data_growth;
500         c->budg_dd_growth += dd_growth;
501
502         err = do_budget_space(c);
503         if (likely(!err)) {
504                 req->idx_growth = idx_growth;
505                 req->data_growth = data_growth;
506                 req->dd_growth = dd_growth;
507                 spin_unlock(&c->space_lock);
508                 return 0;
509         }
510
511         /* Restore the old values */
512         c->budg_idx_growth -= idx_growth;
513         c->budg_data_growth -= data_growth;
514         c->budg_dd_growth -= dd_growth;
515         spin_unlock(&c->space_lock);
516
517         if (req->fast) {
518                 dbg_budg("no space for fast budgeting");
519                 return err;
520         }
521
522         err = make_free_space(c);
523         cond_resched();
524         if (err == -EAGAIN) {
525                 dbg_budg("try again");
526                 goto again;
527         } else if (err == -ENOSPC) {
528                 if (!retried) {
529                         retried = 1;
530                         dbg_budg("-ENOSPC, but anyway try once again");
531                         goto again;
532                 }
533                 dbg_budg("FS is full, -ENOSPC");
534                 c->nospace = 1;
535                 if (can_use_rp(c) || c->rp_size == 0)
536                         c->nospace_rp = 1;
537                 smp_wmb();
538         } else
539                 ubifs_err("cannot budget space, error %d", err);
540         return err;
541 }
542
543 /**
544  * ubifs_release_budget - release budgeted free space.
545  * @c: UBIFS file-system description object
546  * @req: budget request
547  *
548  * This function releases the space budgeted by 'ubifs_budget_space()'. Note,
549  * since the index changes (which were budgeted for in @req->idx_growth) will
550  * only be written to the media on commit, this function moves the index budget
551  * from @c->budg_idx_growth to @c->budg_uncommitted_idx. The latter will be
552  * zeroed by the commit operation.
553  */
554 void ubifs_release_budget(struct ubifs_info *c, struct ubifs_budget_req *req)
555 {
556         ubifs_assert(req->new_page <= 1);
557         ubifs_assert(req->dirtied_page <= 1);
558         ubifs_assert(req->new_dent <= 1);
559         ubifs_assert(req->mod_dent <= 1);
560         ubifs_assert(req->new_ino <= 1);
561         ubifs_assert(req->new_ino_d <= UBIFS_MAX_INO_DATA);
562         ubifs_assert(req->dirtied_ino <= 4);
563         ubifs_assert(req->dirtied_ino_d <= UBIFS_MAX_INO_DATA * 4);
564         ubifs_assert(!(req->new_ino_d & 7));
565         ubifs_assert(!(req->dirtied_ino_d & 7));
566         if (!req->recalculate) {
567                 ubifs_assert(req->idx_growth >= 0);
568                 ubifs_assert(req->data_growth >= 0);
569                 ubifs_assert(req->dd_growth >= 0);
570         }
571
572         if (req->recalculate) {
573                 req->data_growth = calc_data_growth(c, req);
574                 req->dd_growth = calc_dd_growth(c, req);
575                 req->idx_growth = calc_idx_growth(c, req);
576         }
577
578         if (!req->data_growth && !req->dd_growth)
579                 return;
580
581         c->nospace = c->nospace_rp = 0;
582         smp_wmb();
583
584         spin_lock(&c->space_lock);
585         c->budg_idx_growth -= req->idx_growth;
586         c->budg_uncommitted_idx += req->idx_growth;
587         c->budg_data_growth -= req->data_growth;
588         c->budg_dd_growth -= req->dd_growth;
589         c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
590
591         ubifs_assert(c->budg_idx_growth >= 0);
592         ubifs_assert(c->budg_data_growth >= 0);
593         ubifs_assert(c->budg_dd_growth >= 0);
594         ubifs_assert(c->min_idx_lebs < c->main_lebs);
595         ubifs_assert(!(c->budg_idx_growth & 7));
596         ubifs_assert(!(c->budg_data_growth & 7));
597         ubifs_assert(!(c->budg_dd_growth & 7));
598         spin_unlock(&c->space_lock);
599 }
600
601 /**
602  * ubifs_convert_page_budget - convert budget of a new page.
603  * @c: UBIFS file-system description object
604  *
605  * This function converts budget which was allocated for a new page of data to
606  * the budget of changing an existing page of data. The latter is smaller than
607  * the former, so this function only does simple re-calculation and does not
608  * involve any write-back.
609  */
610 void ubifs_convert_page_budget(struct ubifs_info *c)
611 {
612         spin_lock(&c->space_lock);
613         /* Release the index growth reservation */
614         c->budg_idx_growth -= c->max_idx_node_sz << UBIFS_BLOCKS_PER_PAGE_SHIFT;
615         /* Release the data growth reservation */
616         c->budg_data_growth -= c->page_budget;
617         /* Increase the dirty data growth reservation instead */
618         c->budg_dd_growth += c->page_budget;
619         /* And re-calculate the indexing space reservation */
620         c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
621         spin_unlock(&c->space_lock);
622 }
623
624 /**
625  * ubifs_release_dirty_inode_budget - release dirty inode budget.
626  * @c: UBIFS file-system description object
627  * @ui: UBIFS inode to release the budget for
628  *
629  * This function releases budget corresponding to a dirty inode. It is usually
630  * called when after the inode has been written to the media and marked as
631  * clean.
632  */
633 void ubifs_release_dirty_inode_budget(struct ubifs_info *c,
634                                       struct ubifs_inode *ui)
635 {
636         struct ubifs_budget_req req;
637
638         memset(&req, 0, sizeof(struct ubifs_budget_req));
639         req.dd_growth = c->inode_budget + ALIGN(ui->data_len, 8);
640         ubifs_release_budget(c, &req);
641 }
642
643 /**
644  * ubifs_reported_space - calculate reported free space.
645  * @c: the UBIFS file-system description object
646  * @free: amount of free space
647  *
648  * This function calculates amount of free space which will be reported to
649  * user-space. User-space application tend to expect that if the file-system
650  * (e.g., via the 'statfs()' call) reports that it has N bytes available, they
651  * are able to write a file of size N. UBIFS attaches node headers to each data
652  * node and it has to write indexing nodes as well. This introduces additional
653  * overhead, and UBIFS has to report slightly less free space to meet the above
654  * expectations.
655  *
656  * This function assumes free space is made up of uncompressed data nodes and
657  * full index nodes (one per data node, tripled because we always allow enough
658  * space to write the index thrice).
659  *
660  * Note, the calculation is pessimistic, which means that most of the time
661  * UBIFS reports less space than it actually has.
662  */
663 long long ubifs_reported_space(const struct ubifs_info *c, long long free)
664 {
665         int divisor, factor, f;
666
667         /*
668          * Reported space size is @free * X, where X is UBIFS block size
669          * divided by UBIFS block size + all overhead one data block
670          * introduces. The overhead is the node header + indexing overhead.
671          *
672          * Indexing overhead calculations are based on the following formula:
673          * I = N/(f - 1) + 1, where I - number of indexing nodes, N - number
674          * of data nodes, f - fanout. Because effective UBIFS fanout is twice
675          * as less than maximum fanout, we assume that each data node
676          * introduces 3 * @c->max_idx_node_sz / (@c->fanout/2 - 1) bytes.
677          * Note, the multiplier 3 is because UBIFS reserves thrice as more space
678          * for the index.
679          */
680         f = c->fanout > 3 ? c->fanout >> 1 : 2;
681         factor = UBIFS_BLOCK_SIZE;
682         divisor = UBIFS_MAX_DATA_NODE_SZ;
683         divisor += (c->max_idx_node_sz * 3) / (f - 1);
684         free *= factor;
685         return div_u64(free, divisor);
686 }
687
688 /**
689  * ubifs_get_free_space_nolock - return amount of free space.
690  * @c: UBIFS file-system description object
691  *
692  * This function calculates amount of free space to report to user-space.
693  *
694  * Because UBIFS may introduce substantial overhead (the index, node headers,
695  * alignment, wastage at the end of LEBs, etc), it cannot report real amount of
696  * free flash space it has (well, because not all dirty space is reclaimable,
697  * UBIFS does not actually know the real amount). If UBIFS did so, it would
698  * bread user expectations about what free space is. Users seem to accustomed
699  * to assume that if the file-system reports N bytes of free space, they would
700  * be able to fit a file of N bytes to the FS. This almost works for
701  * traditional file-systems, because they have way less overhead than UBIFS.
702  * So, to keep users happy, UBIFS tries to take the overhead into account.
703  */
704 long long ubifs_get_free_space_nolock(struct ubifs_info *c)
705 {
706         int rsvd_idx_lebs, lebs;
707         long long available, outstanding, free;
708
709         ubifs_assert(c->min_idx_lebs == ubifs_calc_min_idx_lebs(c));
710         outstanding = c->budg_data_growth + c->budg_dd_growth;
711         available = ubifs_calc_available(c, c->min_idx_lebs);
712
713         /*
714          * When reporting free space to user-space, UBIFS guarantees that it is
715          * possible to write a file of free space size. This means that for
716          * empty LEBs we may use more precise calculations than
717          * 'ubifs_calc_available()' is using. Namely, we know that in empty
718          * LEBs we would waste only @c->leb_overhead bytes, not @c->dark_wm.
719          * Thus, amend the available space.
720          *
721          * Note, the calculations below are similar to what we have in
722          * 'do_budget_space()', so refer there for comments.
723          */
724         if (c->min_idx_lebs > c->lst.idx_lebs)
725                 rsvd_idx_lebs = c->min_idx_lebs - c->lst.idx_lebs;
726         else
727                 rsvd_idx_lebs = 0;
728         lebs = c->lst.empty_lebs + c->freeable_cnt + c->idx_gc_cnt -
729                c->lst.taken_empty_lebs;
730         lebs -= rsvd_idx_lebs;
731         available += lebs * (c->dark_wm - c->leb_overhead);
732
733         if (available > outstanding)
734                 free = ubifs_reported_space(c, available - outstanding);
735         else
736                 free = 0;
737         return free;
738 }
739
740 /**
741  * ubifs_get_free_space - return amount of free space.
742  * @c: UBIFS file-system description object
743  *
744  * This function calculates and retuns amount of free space to report to
745  * user-space.
746  */
747 long long ubifs_get_free_space(struct ubifs_info *c)
748 {
749         long long free;
750
751         spin_lock(&c->space_lock);
752         free = ubifs_get_free_space_nolock(c);
753         spin_unlock(&c->space_lock);
754
755         return free;
756 }