budget.c 23 KB

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