debug.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  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. #ifndef __UBOOT__
  17. #define ubi_assert(expr) do { \
  18. if (unlikely(!(expr))) { \
  19. pr_crit("UBI assert failed in %s at %u (pid %d)\n", \
  20. __func__, __LINE__, current->pid); \
  21. dump_stack(); \
  22. } \
  23. } while (0)
  24. #else
  25. #define ubi_assert(expr) do { \
  26. if (unlikely(!(expr))) { \
  27. pr_debug("UBI assert failed in %s at %u\n", \
  28. __func__, __LINE__); \
  29. dump_stack(); \
  30. } \
  31. } while (0)
  32. #endif
  33. #define ubi_dbg_print_hex_dump(ps, pt, r, g, b, len, a) \
  34. print_hex_dump(ps, pt, r, g, b, len, a)
  35. #define ubi_dbg_msg(type, fmt, ...) \
  36. pr_debug("UBI DBG " type " (pid %d): " fmt "\n", current->pid, \
  37. ##__VA_ARGS__)
  38. /* General debugging messages */
  39. #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
  40. /* Messages from the eraseblock association sub-system */
  41. #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
  42. /* Messages from the wear-leveling sub-system */
  43. #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
  44. /* Messages from the input/output sub-system */
  45. #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
  46. /* Initialization and build messages */
  47. #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
  48. void ubi_dump_vol_info(const struct ubi_volume *vol);
  49. void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
  50. void ubi_dump_av(const struct ubi_ainf_volume *av);
  51. void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type);
  52. void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req);
  53. int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset,
  54. int len);
  55. int ubi_debugfs_init(void);
  56. void ubi_debugfs_exit(void);
  57. int ubi_debugfs_init_dev(struct ubi_device *ubi);
  58. void ubi_debugfs_exit_dev(struct ubi_device *ubi);
  59. /**
  60. * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
  61. * @ubi: UBI device description object
  62. *
  63. * Returns non-zero if the UBI background thread is disabled for testing
  64. * purposes.
  65. */
  66. static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
  67. {
  68. return ubi->dbg.disable_bgt;
  69. }
  70. /**
  71. * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
  72. * @ubi: UBI device description object
  73. *
  74. * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
  75. */
  76. static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
  77. {
  78. if (ubi->dbg.emulate_bitflips)
  79. return !(prandom_u32() % 200);
  80. return 0;
  81. }
  82. /**
  83. * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
  84. * @ubi: UBI device description object
  85. *
  86. * Returns non-zero if a write failure should be emulated, otherwise returns
  87. * zero.
  88. */
  89. static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
  90. {
  91. if (ubi->dbg.emulate_io_failures)
  92. return !(prandom_u32() % 500);
  93. return 0;
  94. }
  95. /**
  96. * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
  97. * @ubi: UBI device description object
  98. *
  99. * Returns non-zero if an erase failure should be emulated, otherwise returns
  100. * zero.
  101. */
  102. static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
  103. {
  104. if (ubi->dbg.emulate_io_failures)
  105. return !(prandom_u32() % 400);
  106. return 0;
  107. }
  108. static inline int ubi_dbg_chk_io(const struct ubi_device *ubi)
  109. {
  110. return ubi->dbg.chk_io;
  111. }
  112. static inline int ubi_dbg_chk_gen(const struct ubi_device *ubi)
  113. {
  114. return ubi->dbg.chk_gen;
  115. }
  116. static inline int ubi_dbg_chk_fastmap(const struct ubi_device *ubi)
  117. {
  118. return ubi->dbg.chk_fastmap;
  119. }
  120. static inline void ubi_enable_dbg_chk_fastmap(struct ubi_device *ubi)
  121. {
  122. ubi->dbg.chk_fastmap = 1;
  123. }
  124. int ubi_dbg_power_cut(struct ubi_device *ubi, int caller);
  125. #endif /* !__UBI_DEBUG_H__ */