pstore.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. /*
  2. * Persistent Storage - pstore.h
  3. *
  4. * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
  5. *
  6. * This code is the generic layer to export data records from platform
  7. * level persistent storage via a file system.
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License version 2 as
  11. * published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21. */
  22. #ifndef _LINUX_PSTORE_H
  23. #define _LINUX_PSTORE_H
  24. #include <linux/time.h>
  25. #include <linux/kmsg_dump.h>
  26. #include <linux/mutex.h>
  27. #include <linux/types.h>
  28. #include <linux/spinlock.h>
  29. #include <linux/errno.h>
  30. /* types */
  31. enum pstore_type_id {
  32. PSTORE_TYPE_DMESG = 0,
  33. PSTORE_TYPE_MCE = 1,
  34. PSTORE_TYPE_CONSOLE = 2,
  35. PSTORE_TYPE_FTRACE = 3,
  36. /* PPC64 partition types */
  37. PSTORE_TYPE_PPC_RTAS = 4,
  38. PSTORE_TYPE_PPC_OF = 5,
  39. PSTORE_TYPE_PPC_COMMON = 6,
  40. PSTORE_TYPE_PMSG = 7,
  41. PSTORE_TYPE_UNKNOWN = 255
  42. };
  43. struct module;
  44. struct pstore_info {
  45. struct module *owner;
  46. char *name;
  47. spinlock_t buf_lock; /* serialize access to 'buf' */
  48. char *buf;
  49. size_t bufsize;
  50. struct mutex read_mutex; /* serialize open/read/close */
  51. int flags;
  52. int (*open)(struct pstore_info *psi);
  53. int (*close)(struct pstore_info *psi);
  54. ssize_t (*read)(u64 *id, enum pstore_type_id *type,
  55. int *count, struct timespec *time, char **buf,
  56. bool *compressed, struct pstore_info *psi);
  57. int (*write)(enum pstore_type_id type,
  58. enum kmsg_dump_reason reason, u64 *id,
  59. unsigned int part, int count, bool compressed,
  60. size_t size, struct pstore_info *psi);
  61. int (*write_buf)(enum pstore_type_id type,
  62. enum kmsg_dump_reason reason, u64 *id,
  63. unsigned int part, const char *buf, bool compressed,
  64. size_t size, struct pstore_info *psi);
  65. int (*erase)(enum pstore_type_id type, u64 id,
  66. int count, struct timespec time,
  67. struct pstore_info *psi);
  68. void *data;
  69. };
  70. #define PSTORE_FLAGS_FRAGILE 1
  71. #ifdef CONFIG_PSTORE
  72. extern int pstore_register(struct pstore_info *);
  73. extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
  74. #else
  75. static inline int
  76. pstore_register(struct pstore_info *psi)
  77. {
  78. return -ENODEV;
  79. }
  80. static inline bool
  81. pstore_cannot_block_path(enum kmsg_dump_reason reason)
  82. {
  83. return false;
  84. }
  85. #endif
  86. #endif /*_LINUX_PSTORE_H*/