oprofile.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. /**
  2. * @file oprofile.h
  3. *
  4. * API for machine-specific interrupts to interface
  5. * to oprofile.
  6. *
  7. * @remark Copyright 2002 OProfile authors
  8. * @remark Read the file COPYING
  9. *
  10. * @author John Levon <levon@movementarian.org>
  11. */
  12. #ifndef OPROFILE_H
  13. #define OPROFILE_H
  14. #include <linux/types.h>
  15. #include <linux/spinlock.h>
  16. #include <linux/init.h>
  17. #include <linux/errno.h>
  18. #include <linux/printk.h>
  19. #include <linux/atomic.h>
  20. /* Each escaped entry is prefixed by ESCAPE_CODE
  21. * then one of the following codes, then the
  22. * relevant data.
  23. * These #defines live in this file so that arch-specific
  24. * buffer sync'ing code can access them.
  25. */
  26. #define ESCAPE_CODE ~0UL
  27. #define CTX_SWITCH_CODE 1
  28. #define CPU_SWITCH_CODE 2
  29. #define COOKIE_SWITCH_CODE 3
  30. #define KERNEL_ENTER_SWITCH_CODE 4
  31. #define KERNEL_EXIT_SWITCH_CODE 5
  32. #define MODULE_LOADED_CODE 6
  33. #define CTX_TGID_CODE 7
  34. #define TRACE_BEGIN_CODE 8
  35. #define TRACE_END_CODE 9
  36. #define XEN_ENTER_SWITCH_CODE 10
  37. #define SPU_PROFILING_CODE 11
  38. #define SPU_CTX_SWITCH_CODE 12
  39. #define IBS_FETCH_CODE 13
  40. #define IBS_OP_CODE 14
  41. struct dentry;
  42. struct file_operations;
  43. struct pt_regs;
  44. /* Operations structure to be filled in */
  45. struct oprofile_operations {
  46. /* create any necessary configuration files in the oprofile fs.
  47. * Optional. */
  48. int (*create_files)(struct dentry * root);
  49. /* Do any necessary interrupt setup. Optional. */
  50. int (*setup)(void);
  51. /* Do any necessary interrupt shutdown. Optional. */
  52. void (*shutdown)(void);
  53. /* Start delivering interrupts. */
  54. int (*start)(void);
  55. /* Stop delivering interrupts. */
  56. void (*stop)(void);
  57. /* Arch-specific buffer sync functions.
  58. * Return value = 0: Success
  59. * Return value = -1: Failure
  60. * Return value = 1: Run generic sync function
  61. */
  62. int (*sync_start)(void);
  63. int (*sync_stop)(void);
  64. /* Initiate a stack backtrace. Optional. */
  65. void (*backtrace)(struct pt_regs * const regs, unsigned int depth);
  66. /* Multiplex between different events. Optional. */
  67. int (*switch_events)(void);
  68. /* CPU identification string. */
  69. char * cpu_type;
  70. };
  71. /**
  72. * One-time initialisation. *ops must be set to a filled-in
  73. * operations structure. This is called even in timer interrupt
  74. * mode so an arch can set a backtrace callback.
  75. *
  76. * If an error occurs, the fields should be left untouched.
  77. */
  78. int oprofile_arch_init(struct oprofile_operations * ops);
  79. /**
  80. * One-time exit/cleanup for the arch.
  81. */
  82. void oprofile_arch_exit(void);
  83. /**
  84. * Add a sample. This may be called from any context.
  85. */
  86. void oprofile_add_sample(struct pt_regs * const regs, unsigned long event);
  87. /**
  88. * Add an extended sample. Use this when the PC is not from the regs, and
  89. * we cannot determine if we're in kernel mode from the regs.
  90. *
  91. * This function does perform a backtrace.
  92. *
  93. */
  94. void oprofile_add_ext_sample(unsigned long pc, struct pt_regs * const regs,
  95. unsigned long event, int is_kernel);
  96. /**
  97. * Add an hardware sample.
  98. */
  99. void oprofile_add_ext_hw_sample(unsigned long pc, struct pt_regs * const regs,
  100. unsigned long event, int is_kernel,
  101. struct task_struct *task);
  102. /* Use this instead when the PC value is not from the regs. Doesn't
  103. * backtrace. */
  104. void oprofile_add_pc(unsigned long pc, int is_kernel, unsigned long event);
  105. /* add a backtrace entry, to be called from the ->backtrace callback */
  106. void oprofile_add_trace(unsigned long eip);
  107. /**
  108. * Create a file of the given name as a child of the given root, with
  109. * the specified file operations.
  110. */
  111. int oprofilefs_create_file(struct dentry * root,
  112. char const * name, const struct file_operations * fops);
  113. int oprofilefs_create_file_perm(struct dentry * root,
  114. char const * name, const struct file_operations * fops, int perm);
  115. /** Create a file for read/write access to an unsigned long. */
  116. int oprofilefs_create_ulong(struct dentry * root,
  117. char const * name, ulong * val);
  118. /** Create a file for read-only access to an unsigned long. */
  119. int oprofilefs_create_ro_ulong(struct dentry * root,
  120. char const * name, ulong * val);
  121. /** Create a file for read-only access to an atomic_t. */
  122. int oprofilefs_create_ro_atomic(struct dentry * root,
  123. char const * name, atomic_t * val);
  124. /** create a directory */
  125. struct dentry *oprofilefs_mkdir(struct dentry *parent, char const *name);
  126. /**
  127. * Write the given asciz string to the given user buffer @buf, updating *offset
  128. * appropriately. Returns bytes written or -EFAULT.
  129. */
  130. ssize_t oprofilefs_str_to_user(char const * str, char __user * buf, size_t count, loff_t * offset);
  131. /**
  132. * Convert an unsigned long value into ASCII and copy it to the user buffer @buf,
  133. * updating *offset appropriately. Returns bytes written or -EFAULT.
  134. */
  135. ssize_t oprofilefs_ulong_to_user(unsigned long val, char __user * buf, size_t count, loff_t * offset);
  136. /**
  137. * Read an ASCII string for a number from a userspace buffer and fill *val on success.
  138. * Returns 0 on success, < 0 on error.
  139. */
  140. int oprofilefs_ulong_from_user(unsigned long * val, char const __user * buf, size_t count);
  141. /** lock for read/write safety */
  142. extern raw_spinlock_t oprofilefs_lock;
  143. /**
  144. * Add the contents of a circular buffer to the event buffer.
  145. */
  146. void oprofile_put_buff(unsigned long *buf, unsigned int start,
  147. unsigned int stop, unsigned int max);
  148. unsigned long oprofile_get_cpu_buffer_size(void);
  149. void oprofile_cpu_buffer_inc_smpl_lost(void);
  150. /* cpu buffer functions */
  151. struct op_sample;
  152. struct op_entry {
  153. struct ring_buffer_event *event;
  154. struct op_sample *sample;
  155. unsigned long size;
  156. unsigned long *data;
  157. };
  158. void oprofile_write_reserve(struct op_entry *entry,
  159. struct pt_regs * const regs,
  160. unsigned long pc, int code, int size);
  161. int oprofile_add_data(struct op_entry *entry, unsigned long val);
  162. int oprofile_add_data64(struct op_entry *entry, u64 val);
  163. int oprofile_write_commit(struct op_entry *entry);
  164. #ifdef CONFIG_HW_PERF_EVENTS
  165. int __init oprofile_perf_init(struct oprofile_operations *ops);
  166. void oprofile_perf_exit(void);
  167. char *op_name_from_perf_id(void);
  168. #else
  169. static inline int __init oprofile_perf_init(struct oprofile_operations *ops)
  170. {
  171. pr_info("oprofile: hardware counters not available\n");
  172. return -ENODEV;
  173. }
  174. static inline void oprofile_perf_exit(void) { }
  175. #endif /* CONFIG_HW_PERF_EVENTS */
  176. #endif /* OPROFILE_H */