debug.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (c) International Business Machines Corp., 2006
  4. *
  5. * Author: Artem Bityutskiy (Битюцкий Артём)
  6. */
  7. #ifndef __UBI_DEBUG_H__
  8. #define __UBI_DEBUG_H__
  9. void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
  10. void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
  11. void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
  12. #ifndef __UBOOT__
  13. #include <linux/random.h>
  14. #endif
  15. #include <hexdump.h>
  16. #define ubi_assert(expr) do { \
  17. if (unlikely(!(expr))) { \
  18. pr_crit("UBI assert failed in %s at %u (pid %d)\n", \
  19. __func__, __LINE__, current->pid); \
  20. dump_stack(); \
  21. } \
  22. } while (0)
  23. #define ubi_dbg_print_hex_dump(ps, pt, r, g, b, len, a) \
  24. print_hex_dump(ps, pt, r, g, b, len, a)
  25. #define ubi_dbg_msg(type, fmt, ...) \
  26. pr_debug("UBI DBG " type " (pid %d): " fmt "\n", current->pid, \
  27. ##__VA_ARGS__)
  28. /* General debugging messages */
  29. #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
  30. /* Messages from the eraseblock association sub-system */
  31. #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
  32. /* Messages from the wear-leveling sub-system */
  33. #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
  34. /* Messages from the input/output sub-system */
  35. #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
  36. /* Initialization and build messages */
  37. #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
  38. void ubi_dump_vol_info(const struct ubi_volume *vol);
  39. void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
  40. void ubi_dump_av(const struct ubi_ainf_volume *av);
  41. void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type);
  42. void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req);
  43. int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset,
  44. int len);
  45. int ubi_debugfs_init(void);
  46. void ubi_debugfs_exit(void);
  47. int ubi_debugfs_init_dev(struct ubi_device *ubi);
  48. void ubi_debugfs_exit_dev(struct ubi_device *ubi);
  49. /**
  50. * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
  51. * @ubi: UBI device description object
  52. *
  53. * Returns non-zero if the UBI background thread is disabled for testing
  54. * purposes.
  55. */
  56. static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
  57. {
  58. return ubi->dbg.disable_bgt;
  59. }
  60. /**
  61. * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
  62. * @ubi: UBI device description object
  63. *
  64. * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
  65. */
  66. static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
  67. {
  68. if (ubi->dbg.emulate_bitflips)
  69. return !(prandom_u32() % 200);
  70. return 0;
  71. }
  72. /**
  73. * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
  74. * @ubi: UBI device description object
  75. *
  76. * Returns non-zero if a write failure should be emulated, otherwise returns
  77. * zero.
  78. */
  79. static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
  80. {
  81. if (ubi->dbg.emulate_io_failures)
  82. return !(prandom_u32() % 500);
  83. return 0;
  84. }
  85. /**
  86. * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
  87. * @ubi: UBI device description object
  88. *
  89. * Returns non-zero if an erase failure should be emulated, otherwise returns
  90. * zero.
  91. */
  92. static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
  93. {
  94. if (ubi->dbg.emulate_io_failures)
  95. return !(prandom_u32() % 400);
  96. return 0;
  97. }
  98. static inline int ubi_dbg_chk_io(const struct ubi_device *ubi)
  99. {
  100. return ubi->dbg.chk_io;
  101. }
  102. static inline int ubi_dbg_chk_gen(const struct ubi_device *ubi)
  103. {
  104. return ubi->dbg.chk_gen;
  105. }
  106. static inline int ubi_dbg_chk_fastmap(const struct ubi_device *ubi)
  107. {
  108. return ubi->dbg.chk_fastmap;
  109. }
  110. static inline void ubi_enable_dbg_chk_fastmap(struct ubi_device *ubi)
  111. {
  112. ubi->dbg.chk_fastmap = 1;
  113. }
  114. int ubi_dbg_power_cut(struct ubi_device *ubi, int caller);
  115. #endif /* !__UBI_DEBUG_H__ */