kprobes.c 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445
  1. /*
  2. * Kernel Probes (KProbes)
  3. * kernel/kprobes.c
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program; if not, write to the Free Software
  17. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18. *
  19. * Copyright (C) IBM Corporation, 2002, 2004
  20. *
  21. * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
  22. * Probes initial implementation (includes suggestions from
  23. * Rusty Russell).
  24. * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
  25. * hlists and exceptions notifier as suggested by Andi Kleen.
  26. * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
  27. * interface to access function arguments.
  28. * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
  29. * exceptions notifier to be first on the priority list.
  30. * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
  31. * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
  32. * <prasanna@in.ibm.com> added function-return probes.
  33. */
  34. #include <linux/kprobes.h>
  35. #include <linux/hash.h>
  36. #include <linux/init.h>
  37. #include <linux/slab.h>
  38. #include <linux/stddef.h>
  39. #include <linux/export.h>
  40. #include <linux/moduleloader.h>
  41. #include <linux/kallsyms.h>
  42. #include <linux/freezer.h>
  43. #include <linux/seq_file.h>
  44. #include <linux/debugfs.h>
  45. #include <linux/sysctl.h>
  46. #include <linux/kdebug.h>
  47. #include <linux/memory.h>
  48. #include <linux/ftrace.h>
  49. #include <linux/cpu.h>
  50. #include <linux/jump_label.h>
  51. #include <asm-generic/sections.h>
  52. #include <asm/cacheflush.h>
  53. #include <asm/errno.h>
  54. #include <asm/uaccess.h>
  55. #define KPROBE_HASH_BITS 6
  56. #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
  57. /*
  58. * Some oddball architectures like 64bit powerpc have function descriptors
  59. * so this must be overridable.
  60. */
  61. #ifndef kprobe_lookup_name
  62. #define kprobe_lookup_name(name, addr) \
  63. addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
  64. #endif
  65. static int kprobes_initialized;
  66. static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
  67. static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
  68. /* NOTE: change this value only with kprobe_mutex held */
  69. static bool kprobes_all_disarmed;
  70. /* This protects kprobe_table and optimizing_list */
  71. static DEFINE_MUTEX(kprobe_mutex);
  72. static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
  73. static struct {
  74. raw_spinlock_t lock ____cacheline_aligned_in_smp;
  75. } kretprobe_table_locks[KPROBE_TABLE_SIZE];
  76. static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
  77. {
  78. return &(kretprobe_table_locks[hash].lock);
  79. }
  80. /* Blacklist -- list of struct kprobe_blacklist_entry */
  81. static LIST_HEAD(kprobe_blacklist);
  82. #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
  83. /*
  84. * kprobe->ainsn.insn points to the copy of the instruction to be
  85. * single-stepped. x86_64, POWER4 and above have no-exec support and
  86. * stepping on the instruction on a vmalloced/kmalloced/data page
  87. * is a recipe for disaster
  88. */
  89. struct kprobe_insn_page {
  90. struct list_head list;
  91. kprobe_opcode_t *insns; /* Page of instruction slots */
  92. struct kprobe_insn_cache *cache;
  93. int nused;
  94. int ngarbage;
  95. char slot_used[];
  96. };
  97. #define KPROBE_INSN_PAGE_SIZE(slots) \
  98. (offsetof(struct kprobe_insn_page, slot_used) + \
  99. (sizeof(char) * (slots)))
  100. static int slots_per_page(struct kprobe_insn_cache *c)
  101. {
  102. return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
  103. }
  104. enum kprobe_slot_state {
  105. SLOT_CLEAN = 0,
  106. SLOT_DIRTY = 1,
  107. SLOT_USED = 2,
  108. };
  109. static void *alloc_insn_page(void)
  110. {
  111. return module_alloc(PAGE_SIZE);
  112. }
  113. static void free_insn_page(void *page)
  114. {
  115. module_free(NULL, page);
  116. }
  117. struct kprobe_insn_cache kprobe_insn_slots = {
  118. .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
  119. .alloc = alloc_insn_page,
  120. .free = free_insn_page,
  121. .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
  122. .insn_size = MAX_INSN_SIZE,
  123. .nr_garbage = 0,
  124. };
  125. static int collect_garbage_slots(struct kprobe_insn_cache *c);
  126. /**
  127. * __get_insn_slot() - Find a slot on an executable page for an instruction.
  128. * We allocate an executable page if there's no room on existing ones.
  129. */
  130. kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
  131. {
  132. struct kprobe_insn_page *kip;
  133. kprobe_opcode_t *slot = NULL;
  134. mutex_lock(&c->mutex);
  135. retry:
  136. list_for_each_entry(kip, &c->pages, list) {
  137. if (kip->nused < slots_per_page(c)) {
  138. int i;
  139. for (i = 0; i < slots_per_page(c); i++) {
  140. if (kip->slot_used[i] == SLOT_CLEAN) {
  141. kip->slot_used[i] = SLOT_USED;
  142. kip->nused++;
  143. slot = kip->insns + (i * c->insn_size);
  144. goto out;
  145. }
  146. }
  147. /* kip->nused is broken. Fix it. */
  148. kip->nused = slots_per_page(c);
  149. WARN_ON(1);
  150. }
  151. }
  152. /* If there are any garbage slots, collect it and try again. */
  153. if (c->nr_garbage && collect_garbage_slots(c) == 0)
  154. goto retry;
  155. /* All out of space. Need to allocate a new page. */
  156. kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
  157. if (!kip)
  158. goto out;
  159. /*
  160. * Use module_alloc so this page is within +/- 2GB of where the
  161. * kernel image and loaded module images reside. This is required
  162. * so x86_64 can correctly handle the %rip-relative fixups.
  163. */
  164. kip->insns = c->alloc();
  165. if (!kip->insns) {
  166. kfree(kip);
  167. goto out;
  168. }
  169. INIT_LIST_HEAD(&kip->list);
  170. memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
  171. kip->slot_used[0] = SLOT_USED;
  172. kip->nused = 1;
  173. kip->ngarbage = 0;
  174. kip->cache = c;
  175. list_add(&kip->list, &c->pages);
  176. slot = kip->insns;
  177. out:
  178. mutex_unlock(&c->mutex);
  179. return slot;
  180. }
  181. /* Return 1 if all garbages are collected, otherwise 0. */
  182. static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
  183. {
  184. kip->slot_used[idx] = SLOT_CLEAN;
  185. kip->nused--;
  186. if (kip->nused == 0) {
  187. /*
  188. * Page is no longer in use. Free it unless
  189. * it's the last one. We keep the last one
  190. * so as not to have to set it up again the
  191. * next time somebody inserts a probe.
  192. */
  193. if (!list_is_singular(&kip->list)) {
  194. list_del(&kip->list);
  195. kip->cache->free(kip->insns);
  196. kfree(kip);
  197. }
  198. return 1;
  199. }
  200. return 0;
  201. }
  202. static int collect_garbage_slots(struct kprobe_insn_cache *c)
  203. {
  204. struct kprobe_insn_page *kip, *next;
  205. /* Ensure no-one is interrupted on the garbages */
  206. synchronize_sched();
  207. list_for_each_entry_safe(kip, next, &c->pages, list) {
  208. int i;
  209. if (kip->ngarbage == 0)
  210. continue;
  211. kip->ngarbage = 0; /* we will collect all garbages */
  212. for (i = 0; i < slots_per_page(c); i++) {
  213. if (kip->slot_used[i] == SLOT_DIRTY &&
  214. collect_one_slot(kip, i))
  215. break;
  216. }
  217. }
  218. c->nr_garbage = 0;
  219. return 0;
  220. }
  221. void __free_insn_slot(struct kprobe_insn_cache *c,
  222. kprobe_opcode_t *slot, int dirty)
  223. {
  224. struct kprobe_insn_page *kip;
  225. mutex_lock(&c->mutex);
  226. list_for_each_entry(kip, &c->pages, list) {
  227. long idx = ((long)slot - (long)kip->insns) /
  228. (c->insn_size * sizeof(kprobe_opcode_t));
  229. if (idx >= 0 && idx < slots_per_page(c)) {
  230. WARN_ON(kip->slot_used[idx] != SLOT_USED);
  231. if (dirty) {
  232. kip->slot_used[idx] = SLOT_DIRTY;
  233. kip->ngarbage++;
  234. if (++c->nr_garbage > slots_per_page(c))
  235. collect_garbage_slots(c);
  236. } else
  237. collect_one_slot(kip, idx);
  238. goto out;
  239. }
  240. }
  241. /* Could not free this slot. */
  242. WARN_ON(1);
  243. out:
  244. mutex_unlock(&c->mutex);
  245. }
  246. #ifdef CONFIG_OPTPROBES
  247. /* For optimized_kprobe buffer */
  248. struct kprobe_insn_cache kprobe_optinsn_slots = {
  249. .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
  250. .alloc = alloc_insn_page,
  251. .free = free_insn_page,
  252. .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
  253. /* .insn_size is initialized later */
  254. .nr_garbage = 0,
  255. };
  256. #endif
  257. #endif
  258. /* We have preemption disabled.. so it is safe to use __ versions */
  259. static inline void set_kprobe_instance(struct kprobe *kp)
  260. {
  261. __this_cpu_write(kprobe_instance, kp);
  262. }
  263. static inline void reset_kprobe_instance(void)
  264. {
  265. __this_cpu_write(kprobe_instance, NULL);
  266. }
  267. /*
  268. * This routine is called either:
  269. * - under the kprobe_mutex - during kprobe_[un]register()
  270. * OR
  271. * - with preemption disabled - from arch/xxx/kernel/kprobes.c
  272. */
  273. struct kprobe *get_kprobe(void *addr)
  274. {
  275. struct hlist_head *head;
  276. struct kprobe *p;
  277. head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
  278. hlist_for_each_entry_rcu(p, head, hlist) {
  279. if (p->addr == addr)
  280. return p;
  281. }
  282. return NULL;
  283. }
  284. NOKPROBE_SYMBOL(get_kprobe);
  285. static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
  286. /* Return true if the kprobe is an aggregator */
  287. static inline int kprobe_aggrprobe(struct kprobe *p)
  288. {
  289. return p->pre_handler == aggr_pre_handler;
  290. }
  291. /* Return true(!0) if the kprobe is unused */
  292. static inline int kprobe_unused(struct kprobe *p)
  293. {
  294. return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
  295. list_empty(&p->list);
  296. }
  297. /*
  298. * Keep all fields in the kprobe consistent
  299. */
  300. static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
  301. {
  302. memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
  303. memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
  304. }
  305. #ifdef CONFIG_OPTPROBES
  306. /* NOTE: change this value only with kprobe_mutex held */
  307. static bool kprobes_allow_optimization;
  308. /*
  309. * Call all pre_handler on the list, but ignores its return value.
  310. * This must be called from arch-dep optimized caller.
  311. */
  312. void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
  313. {
  314. struct kprobe *kp;
  315. list_for_each_entry_rcu(kp, &p->list, list) {
  316. if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
  317. set_kprobe_instance(kp);
  318. kp->pre_handler(kp, regs);
  319. }
  320. reset_kprobe_instance();
  321. }
  322. }
  323. NOKPROBE_SYMBOL(opt_pre_handler);
  324. /* Free optimized instructions and optimized_kprobe */
  325. static void free_aggr_kprobe(struct kprobe *p)
  326. {
  327. struct optimized_kprobe *op;
  328. op = container_of(p, struct optimized_kprobe, kp);
  329. arch_remove_optimized_kprobe(op);
  330. arch_remove_kprobe(p);
  331. kfree(op);
  332. }
  333. /* Return true(!0) if the kprobe is ready for optimization. */
  334. static inline int kprobe_optready(struct kprobe *p)
  335. {
  336. struct optimized_kprobe *op;
  337. if (kprobe_aggrprobe(p)) {
  338. op = container_of(p, struct optimized_kprobe, kp);
  339. return arch_prepared_optinsn(&op->optinsn);
  340. }
  341. return 0;
  342. }
  343. /* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
  344. static inline int kprobe_disarmed(struct kprobe *p)
  345. {
  346. struct optimized_kprobe *op;
  347. /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
  348. if (!kprobe_aggrprobe(p))
  349. return kprobe_disabled(p);
  350. op = container_of(p, struct optimized_kprobe, kp);
  351. return kprobe_disabled(p) && list_empty(&op->list);
  352. }
  353. /* Return true(!0) if the probe is queued on (un)optimizing lists */
  354. static int kprobe_queued(struct kprobe *p)
  355. {
  356. struct optimized_kprobe *op;
  357. if (kprobe_aggrprobe(p)) {
  358. op = container_of(p, struct optimized_kprobe, kp);
  359. if (!list_empty(&op->list))
  360. return 1;
  361. }
  362. return 0;
  363. }
  364. /*
  365. * Return an optimized kprobe whose optimizing code replaces
  366. * instructions including addr (exclude breakpoint).
  367. */
  368. static struct kprobe *get_optimized_kprobe(unsigned long addr)
  369. {
  370. int i;
  371. struct kprobe *p = NULL;
  372. struct optimized_kprobe *op;
  373. /* Don't check i == 0, since that is a breakpoint case. */
  374. for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
  375. p = get_kprobe((void *)(addr - i));
  376. if (p && kprobe_optready(p)) {
  377. op = container_of(p, struct optimized_kprobe, kp);
  378. if (arch_within_optimized_kprobe(op, addr))
  379. return p;
  380. }
  381. return NULL;
  382. }
  383. /* Optimization staging list, protected by kprobe_mutex */
  384. static LIST_HEAD(optimizing_list);
  385. static LIST_HEAD(unoptimizing_list);
  386. static LIST_HEAD(freeing_list);
  387. static void kprobe_optimizer(struct work_struct *work);
  388. static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
  389. #define OPTIMIZE_DELAY 5
  390. /*
  391. * Optimize (replace a breakpoint with a jump) kprobes listed on
  392. * optimizing_list.
  393. */
  394. static void do_optimize_kprobes(void)
  395. {
  396. /* Optimization never be done when disarmed */
  397. if (kprobes_all_disarmed || !kprobes_allow_optimization ||
  398. list_empty(&optimizing_list))
  399. return;
  400. /*
  401. * The optimization/unoptimization refers online_cpus via
  402. * stop_machine() and cpu-hotplug modifies online_cpus.
  403. * And same time, text_mutex will be held in cpu-hotplug and here.
  404. * This combination can cause a deadlock (cpu-hotplug try to lock
  405. * text_mutex but stop_machine can not be done because online_cpus
  406. * has been changed)
  407. * To avoid this deadlock, we need to call get_online_cpus()
  408. * for preventing cpu-hotplug outside of text_mutex locking.
  409. */
  410. get_online_cpus();
  411. mutex_lock(&text_mutex);
  412. arch_optimize_kprobes(&optimizing_list);
  413. mutex_unlock(&text_mutex);
  414. put_online_cpus();
  415. }
  416. /*
  417. * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
  418. * if need) kprobes listed on unoptimizing_list.
  419. */
  420. static void do_unoptimize_kprobes(void)
  421. {
  422. struct optimized_kprobe *op, *tmp;
  423. /* Unoptimization must be done anytime */
  424. if (list_empty(&unoptimizing_list))
  425. return;
  426. /* Ditto to do_optimize_kprobes */
  427. get_online_cpus();
  428. mutex_lock(&text_mutex);
  429. arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
  430. /* Loop free_list for disarming */
  431. list_for_each_entry_safe(op, tmp, &freeing_list, list) {
  432. /* Disarm probes if marked disabled */
  433. if (kprobe_disabled(&op->kp))
  434. arch_disarm_kprobe(&op->kp);
  435. if (kprobe_unused(&op->kp)) {
  436. /*
  437. * Remove unused probes from hash list. After waiting
  438. * for synchronization, these probes are reclaimed.
  439. * (reclaiming is done by do_free_cleaned_kprobes.)
  440. */
  441. hlist_del_rcu(&op->kp.hlist);
  442. } else
  443. list_del_init(&op->list);
  444. }
  445. mutex_unlock(&text_mutex);
  446. put_online_cpus();
  447. }
  448. /* Reclaim all kprobes on the free_list */
  449. static void do_free_cleaned_kprobes(void)
  450. {
  451. struct optimized_kprobe *op, *tmp;
  452. list_for_each_entry_safe(op, tmp, &freeing_list, list) {
  453. BUG_ON(!kprobe_unused(&op->kp));
  454. list_del_init(&op->list);
  455. free_aggr_kprobe(&op->kp);
  456. }
  457. }
  458. /* Start optimizer after OPTIMIZE_DELAY passed */
  459. static void kick_kprobe_optimizer(void)
  460. {
  461. schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
  462. }
  463. /* Kprobe jump optimizer */
  464. static void kprobe_optimizer(struct work_struct *work)
  465. {
  466. mutex_lock(&kprobe_mutex);
  467. /* Lock modules while optimizing kprobes */
  468. mutex_lock(&module_mutex);
  469. /*
  470. * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
  471. * kprobes before waiting for quiesence period.
  472. */
  473. do_unoptimize_kprobes();
  474. /*
  475. * Step 2: Wait for quiesence period to ensure all running interrupts
  476. * are done. Because optprobe may modify multiple instructions
  477. * there is a chance that Nth instruction is interrupted. In that
  478. * case, running interrupt can return to 2nd-Nth byte of jump
  479. * instruction. This wait is for avoiding it.
  480. */
  481. synchronize_sched();
  482. /* Step 3: Optimize kprobes after quiesence period */
  483. do_optimize_kprobes();
  484. /* Step 4: Free cleaned kprobes after quiesence period */
  485. do_free_cleaned_kprobes();
  486. mutex_unlock(&module_mutex);
  487. mutex_unlock(&kprobe_mutex);
  488. /* Step 5: Kick optimizer again if needed */
  489. if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
  490. kick_kprobe_optimizer();
  491. }
  492. /* Wait for completing optimization and unoptimization */
  493. static void wait_for_kprobe_optimizer(void)
  494. {
  495. mutex_lock(&kprobe_mutex);
  496. while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
  497. mutex_unlock(&kprobe_mutex);
  498. /* this will also make optimizing_work execute immmediately */
  499. flush_delayed_work(&optimizing_work);
  500. /* @optimizing_work might not have been queued yet, relax */
  501. cpu_relax();
  502. mutex_lock(&kprobe_mutex);
  503. }
  504. mutex_unlock(&kprobe_mutex);
  505. }
  506. /* Optimize kprobe if p is ready to be optimized */
  507. static void optimize_kprobe(struct kprobe *p)
  508. {
  509. struct optimized_kprobe *op;
  510. /* Check if the kprobe is disabled or not ready for optimization. */
  511. if (!kprobe_optready(p) || !kprobes_allow_optimization ||
  512. (kprobe_disabled(p) || kprobes_all_disarmed))
  513. return;
  514. /* Both of break_handler and post_handler are not supported. */
  515. if (p->break_handler || p->post_handler)
  516. return;
  517. op = container_of(p, struct optimized_kprobe, kp);
  518. /* Check there is no other kprobes at the optimized instructions */
  519. if (arch_check_optimized_kprobe(op) < 0)
  520. return;
  521. /* Check if it is already optimized. */
  522. if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
  523. return;
  524. op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
  525. if (!list_empty(&op->list))
  526. /* This is under unoptimizing. Just dequeue the probe */
  527. list_del_init(&op->list);
  528. else {
  529. list_add(&op->list, &optimizing_list);
  530. kick_kprobe_optimizer();
  531. }
  532. }
  533. /* Short cut to direct unoptimizing */
  534. static void force_unoptimize_kprobe(struct optimized_kprobe *op)
  535. {
  536. get_online_cpus();
  537. arch_unoptimize_kprobe(op);
  538. put_online_cpus();
  539. if (kprobe_disabled(&op->kp))
  540. arch_disarm_kprobe(&op->kp);
  541. }
  542. /* Unoptimize a kprobe if p is optimized */
  543. static void unoptimize_kprobe(struct kprobe *p, bool force)
  544. {
  545. struct optimized_kprobe *op;
  546. if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
  547. return; /* This is not an optprobe nor optimized */
  548. op = container_of(p, struct optimized_kprobe, kp);
  549. if (!kprobe_optimized(p)) {
  550. /* Unoptimized or unoptimizing case */
  551. if (force && !list_empty(&op->list)) {
  552. /*
  553. * Only if this is unoptimizing kprobe and forced,
  554. * forcibly unoptimize it. (No need to unoptimize
  555. * unoptimized kprobe again :)
  556. */
  557. list_del_init(&op->list);
  558. force_unoptimize_kprobe(op);
  559. }
  560. return;
  561. }
  562. op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
  563. if (!list_empty(&op->list)) {
  564. /* Dequeue from the optimization queue */
  565. list_del_init(&op->list);
  566. return;
  567. }
  568. /* Optimized kprobe case */
  569. if (force)
  570. /* Forcibly update the code: this is a special case */
  571. force_unoptimize_kprobe(op);
  572. else {
  573. list_add(&op->list, &unoptimizing_list);
  574. kick_kprobe_optimizer();
  575. }
  576. }
  577. /* Cancel unoptimizing for reusing */
  578. static void reuse_unused_kprobe(struct kprobe *ap)
  579. {
  580. struct optimized_kprobe *op;
  581. BUG_ON(!kprobe_unused(ap));
  582. /*
  583. * Unused kprobe MUST be on the way of delayed unoptimizing (means
  584. * there is still a relative jump) and disabled.
  585. */
  586. op = container_of(ap, struct optimized_kprobe, kp);
  587. if (unlikely(list_empty(&op->list)))
  588. printk(KERN_WARNING "Warning: found a stray unused "
  589. "aggrprobe@%p\n", ap->addr);
  590. /* Enable the probe again */
  591. ap->flags &= ~KPROBE_FLAG_DISABLED;
  592. /* Optimize it again (remove from op->list) */
  593. BUG_ON(!kprobe_optready(ap));
  594. optimize_kprobe(ap);
  595. }
  596. /* Remove optimized instructions */
  597. static void kill_optimized_kprobe(struct kprobe *p)
  598. {
  599. struct optimized_kprobe *op;
  600. op = container_of(p, struct optimized_kprobe, kp);
  601. if (!list_empty(&op->list))
  602. /* Dequeue from the (un)optimization queue */
  603. list_del_init(&op->list);
  604. op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
  605. if (kprobe_unused(p)) {
  606. /* Enqueue if it is unused */
  607. list_add(&op->list, &freeing_list);
  608. /*
  609. * Remove unused probes from the hash list. After waiting
  610. * for synchronization, this probe is reclaimed.
  611. * (reclaiming is done by do_free_cleaned_kprobes().)
  612. */
  613. hlist_del_rcu(&op->kp.hlist);
  614. }
  615. /* Don't touch the code, because it is already freed. */
  616. arch_remove_optimized_kprobe(op);
  617. }
  618. /* Try to prepare optimized instructions */
  619. static void prepare_optimized_kprobe(struct kprobe *p)
  620. {
  621. struct optimized_kprobe *op;
  622. op = container_of(p, struct optimized_kprobe, kp);
  623. arch_prepare_optimized_kprobe(op);
  624. }
  625. /* Allocate new optimized_kprobe and try to prepare optimized instructions */
  626. static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
  627. {
  628. struct optimized_kprobe *op;
  629. op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
  630. if (!op)
  631. return NULL;
  632. INIT_LIST_HEAD(&op->list);
  633. op->kp.addr = p->addr;
  634. arch_prepare_optimized_kprobe(op);
  635. return &op->kp;
  636. }
  637. static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
  638. /*
  639. * Prepare an optimized_kprobe and optimize it
  640. * NOTE: p must be a normal registered kprobe
  641. */
  642. static void try_to_optimize_kprobe(struct kprobe *p)
  643. {
  644. struct kprobe *ap;
  645. struct optimized_kprobe *op;
  646. /* Impossible to optimize ftrace-based kprobe */
  647. if (kprobe_ftrace(p))
  648. return;
  649. /* For preparing optimization, jump_label_text_reserved() is called */
  650. jump_label_lock();
  651. mutex_lock(&text_mutex);
  652. ap = alloc_aggr_kprobe(p);
  653. if (!ap)
  654. goto out;
  655. op = container_of(ap, struct optimized_kprobe, kp);
  656. if (!arch_prepared_optinsn(&op->optinsn)) {
  657. /* If failed to setup optimizing, fallback to kprobe */
  658. arch_remove_optimized_kprobe(op);
  659. kfree(op);
  660. goto out;
  661. }
  662. init_aggr_kprobe(ap, p);
  663. optimize_kprobe(ap); /* This just kicks optimizer thread */
  664. out:
  665. mutex_unlock(&text_mutex);
  666. jump_label_unlock();
  667. }
  668. #ifdef CONFIG_SYSCTL
  669. static void optimize_all_kprobes(void)
  670. {
  671. struct hlist_head *head;
  672. struct kprobe *p;
  673. unsigned int i;
  674. mutex_lock(&kprobe_mutex);
  675. /* If optimization is already allowed, just return */
  676. if (kprobes_allow_optimization)
  677. goto out;
  678. kprobes_allow_optimization = true;
  679. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  680. head = &kprobe_table[i];
  681. hlist_for_each_entry_rcu(p, head, hlist)
  682. if (!kprobe_disabled(p))
  683. optimize_kprobe(p);
  684. }
  685. printk(KERN_INFO "Kprobes globally optimized\n");
  686. out:
  687. mutex_unlock(&kprobe_mutex);
  688. }
  689. static void unoptimize_all_kprobes(void)
  690. {
  691. struct hlist_head *head;
  692. struct kprobe *p;
  693. unsigned int i;
  694. mutex_lock(&kprobe_mutex);
  695. /* If optimization is already prohibited, just return */
  696. if (!kprobes_allow_optimization) {
  697. mutex_unlock(&kprobe_mutex);
  698. return;
  699. }
  700. kprobes_allow_optimization = false;
  701. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  702. head = &kprobe_table[i];
  703. hlist_for_each_entry_rcu(p, head, hlist) {
  704. if (!kprobe_disabled(p))
  705. unoptimize_kprobe(p, false);
  706. }
  707. }
  708. mutex_unlock(&kprobe_mutex);
  709. /* Wait for unoptimizing completion */
  710. wait_for_kprobe_optimizer();
  711. printk(KERN_INFO "Kprobes globally unoptimized\n");
  712. }
  713. static DEFINE_MUTEX(kprobe_sysctl_mutex);
  714. int sysctl_kprobes_optimization;
  715. int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
  716. void __user *buffer, size_t *length,
  717. loff_t *ppos)
  718. {
  719. int ret;
  720. mutex_lock(&kprobe_sysctl_mutex);
  721. sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
  722. ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
  723. if (sysctl_kprobes_optimization)
  724. optimize_all_kprobes();
  725. else
  726. unoptimize_all_kprobes();
  727. mutex_unlock(&kprobe_sysctl_mutex);
  728. return ret;
  729. }
  730. #endif /* CONFIG_SYSCTL */
  731. /* Put a breakpoint for a probe. Must be called with text_mutex locked */
  732. static void __arm_kprobe(struct kprobe *p)
  733. {
  734. struct kprobe *_p;
  735. /* Check collision with other optimized kprobes */
  736. _p = get_optimized_kprobe((unsigned long)p->addr);
  737. if (unlikely(_p))
  738. /* Fallback to unoptimized kprobe */
  739. unoptimize_kprobe(_p, true);
  740. arch_arm_kprobe(p);
  741. optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
  742. }
  743. /* Remove the breakpoint of a probe. Must be called with text_mutex locked */
  744. static void __disarm_kprobe(struct kprobe *p, bool reopt)
  745. {
  746. struct kprobe *_p;
  747. unoptimize_kprobe(p, false); /* Try to unoptimize */
  748. if (!kprobe_queued(p)) {
  749. arch_disarm_kprobe(p);
  750. /* If another kprobe was blocked, optimize it. */
  751. _p = get_optimized_kprobe((unsigned long)p->addr);
  752. if (unlikely(_p) && reopt)
  753. optimize_kprobe(_p);
  754. }
  755. /* TODO: reoptimize others after unoptimized this probe */
  756. }
  757. #else /* !CONFIG_OPTPROBES */
  758. #define optimize_kprobe(p) do {} while (0)
  759. #define unoptimize_kprobe(p, f) do {} while (0)
  760. #define kill_optimized_kprobe(p) do {} while (0)
  761. #define prepare_optimized_kprobe(p) do {} while (0)
  762. #define try_to_optimize_kprobe(p) do {} while (0)
  763. #define __arm_kprobe(p) arch_arm_kprobe(p)
  764. #define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
  765. #define kprobe_disarmed(p) kprobe_disabled(p)
  766. #define wait_for_kprobe_optimizer() do {} while (0)
  767. /* There should be no unused kprobes can be reused without optimization */
  768. static void reuse_unused_kprobe(struct kprobe *ap)
  769. {
  770. printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
  771. BUG_ON(kprobe_unused(ap));
  772. }
  773. static void free_aggr_kprobe(struct kprobe *p)
  774. {
  775. arch_remove_kprobe(p);
  776. kfree(p);
  777. }
  778. static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
  779. {
  780. return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
  781. }
  782. #endif /* CONFIG_OPTPROBES */
  783. #ifdef CONFIG_KPROBES_ON_FTRACE
  784. static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
  785. .func = kprobe_ftrace_handler,
  786. .flags = FTRACE_OPS_FL_SAVE_REGS,
  787. };
  788. static int kprobe_ftrace_enabled;
  789. /* Must ensure p->addr is really on ftrace */
  790. static int prepare_kprobe(struct kprobe *p)
  791. {
  792. if (!kprobe_ftrace(p))
  793. return arch_prepare_kprobe(p);
  794. return arch_prepare_kprobe_ftrace(p);
  795. }
  796. /* Caller must lock kprobe_mutex */
  797. static void arm_kprobe_ftrace(struct kprobe *p)
  798. {
  799. int ret;
  800. ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
  801. (unsigned long)p->addr, 0, 0);
  802. WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
  803. kprobe_ftrace_enabled++;
  804. if (kprobe_ftrace_enabled == 1) {
  805. ret = register_ftrace_function(&kprobe_ftrace_ops);
  806. WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
  807. }
  808. }
  809. /* Caller must lock kprobe_mutex */
  810. static void disarm_kprobe_ftrace(struct kprobe *p)
  811. {
  812. int ret;
  813. kprobe_ftrace_enabled--;
  814. if (kprobe_ftrace_enabled == 0) {
  815. ret = unregister_ftrace_function(&kprobe_ftrace_ops);
  816. WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
  817. }
  818. ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
  819. (unsigned long)p->addr, 1, 0);
  820. WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
  821. }
  822. #else /* !CONFIG_KPROBES_ON_FTRACE */
  823. #define prepare_kprobe(p) arch_prepare_kprobe(p)
  824. #define arm_kprobe_ftrace(p) do {} while (0)
  825. #define disarm_kprobe_ftrace(p) do {} while (0)
  826. #endif
  827. /* Arm a kprobe with text_mutex */
  828. static void arm_kprobe(struct kprobe *kp)
  829. {
  830. if (unlikely(kprobe_ftrace(kp))) {
  831. arm_kprobe_ftrace(kp);
  832. return;
  833. }
  834. /*
  835. * Here, since __arm_kprobe() doesn't use stop_machine(),
  836. * this doesn't cause deadlock on text_mutex. So, we don't
  837. * need get_online_cpus().
  838. */
  839. mutex_lock(&text_mutex);
  840. __arm_kprobe(kp);
  841. mutex_unlock(&text_mutex);
  842. }
  843. /* Disarm a kprobe with text_mutex */
  844. static void disarm_kprobe(struct kprobe *kp, bool reopt)
  845. {
  846. if (unlikely(kprobe_ftrace(kp))) {
  847. disarm_kprobe_ftrace(kp);
  848. return;
  849. }
  850. /* Ditto */
  851. mutex_lock(&text_mutex);
  852. __disarm_kprobe(kp, reopt);
  853. mutex_unlock(&text_mutex);
  854. }
  855. /*
  856. * Aggregate handlers for multiple kprobes support - these handlers
  857. * take care of invoking the individual kprobe handlers on p->list
  858. */
  859. static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
  860. {
  861. struct kprobe *kp;
  862. list_for_each_entry_rcu(kp, &p->list, list) {
  863. if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
  864. set_kprobe_instance(kp);
  865. if (kp->pre_handler(kp, regs))
  866. return 1;
  867. }
  868. reset_kprobe_instance();
  869. }
  870. return 0;
  871. }
  872. NOKPROBE_SYMBOL(aggr_pre_handler);
  873. static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
  874. unsigned long flags)
  875. {
  876. struct kprobe *kp;
  877. list_for_each_entry_rcu(kp, &p->list, list) {
  878. if (kp->post_handler && likely(!kprobe_disabled(kp))) {
  879. set_kprobe_instance(kp);
  880. kp->post_handler(kp, regs, flags);
  881. reset_kprobe_instance();
  882. }
  883. }
  884. }
  885. NOKPROBE_SYMBOL(aggr_post_handler);
  886. static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
  887. int trapnr)
  888. {
  889. struct kprobe *cur = __this_cpu_read(kprobe_instance);
  890. /*
  891. * if we faulted "during" the execution of a user specified
  892. * probe handler, invoke just that probe's fault handler
  893. */
  894. if (cur && cur->fault_handler) {
  895. if (cur->fault_handler(cur, regs, trapnr))
  896. return 1;
  897. }
  898. return 0;
  899. }
  900. NOKPROBE_SYMBOL(aggr_fault_handler);
  901. static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
  902. {
  903. struct kprobe *cur = __this_cpu_read(kprobe_instance);
  904. int ret = 0;
  905. if (cur && cur->break_handler) {
  906. if (cur->break_handler(cur, regs))
  907. ret = 1;
  908. }
  909. reset_kprobe_instance();
  910. return ret;
  911. }
  912. NOKPROBE_SYMBOL(aggr_break_handler);
  913. /* Walks the list and increments nmissed count for multiprobe case */
  914. void kprobes_inc_nmissed_count(struct kprobe *p)
  915. {
  916. struct kprobe *kp;
  917. if (!kprobe_aggrprobe(p)) {
  918. p->nmissed++;
  919. } else {
  920. list_for_each_entry_rcu(kp, &p->list, list)
  921. kp->nmissed++;
  922. }
  923. return;
  924. }
  925. NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
  926. void recycle_rp_inst(struct kretprobe_instance *ri,
  927. struct hlist_head *head)
  928. {
  929. struct kretprobe *rp = ri->rp;
  930. /* remove rp inst off the rprobe_inst_table */
  931. hlist_del(&ri->hlist);
  932. INIT_HLIST_NODE(&ri->hlist);
  933. if (likely(rp)) {
  934. raw_spin_lock(&rp->lock);
  935. hlist_add_head(&ri->hlist, &rp->free_instances);
  936. raw_spin_unlock(&rp->lock);
  937. } else
  938. /* Unregistering */
  939. hlist_add_head(&ri->hlist, head);
  940. }
  941. NOKPROBE_SYMBOL(recycle_rp_inst);
  942. void kretprobe_hash_lock(struct task_struct *tsk,
  943. struct hlist_head **head, unsigned long *flags)
  944. __acquires(hlist_lock)
  945. {
  946. unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
  947. raw_spinlock_t *hlist_lock;
  948. *head = &kretprobe_inst_table[hash];
  949. hlist_lock = kretprobe_table_lock_ptr(hash);
  950. raw_spin_lock_irqsave(hlist_lock, *flags);
  951. }
  952. NOKPROBE_SYMBOL(kretprobe_hash_lock);
  953. static void kretprobe_table_lock(unsigned long hash,
  954. unsigned long *flags)
  955. __acquires(hlist_lock)
  956. {
  957. raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
  958. raw_spin_lock_irqsave(hlist_lock, *flags);
  959. }
  960. NOKPROBE_SYMBOL(kretprobe_table_lock);
  961. void kretprobe_hash_unlock(struct task_struct *tsk,
  962. unsigned long *flags)
  963. __releases(hlist_lock)
  964. {
  965. unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
  966. raw_spinlock_t *hlist_lock;
  967. hlist_lock = kretprobe_table_lock_ptr(hash);
  968. raw_spin_unlock_irqrestore(hlist_lock, *flags);
  969. }
  970. NOKPROBE_SYMBOL(kretprobe_hash_unlock);
  971. static void kretprobe_table_unlock(unsigned long hash,
  972. unsigned long *flags)
  973. __releases(hlist_lock)
  974. {
  975. raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
  976. raw_spin_unlock_irqrestore(hlist_lock, *flags);
  977. }
  978. NOKPROBE_SYMBOL(kretprobe_table_unlock);
  979. /*
  980. * This function is called from finish_task_switch when task tk becomes dead,
  981. * so that we can recycle any function-return probe instances associated
  982. * with this task. These left over instances represent probed functions
  983. * that have been called but will never return.
  984. */
  985. void kprobe_flush_task(struct task_struct *tk)
  986. {
  987. struct kretprobe_instance *ri;
  988. struct hlist_head *head, empty_rp;
  989. struct hlist_node *tmp;
  990. unsigned long hash, flags = 0;
  991. if (unlikely(!kprobes_initialized))
  992. /* Early boot. kretprobe_table_locks not yet initialized. */
  993. return;
  994. INIT_HLIST_HEAD(&empty_rp);
  995. hash = hash_ptr(tk, KPROBE_HASH_BITS);
  996. head = &kretprobe_inst_table[hash];
  997. kretprobe_table_lock(hash, &flags);
  998. hlist_for_each_entry_safe(ri, tmp, head, hlist) {
  999. if (ri->task == tk)
  1000. recycle_rp_inst(ri, &empty_rp);
  1001. }
  1002. kretprobe_table_unlock(hash, &flags);
  1003. hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
  1004. hlist_del(&ri->hlist);
  1005. kfree(ri);
  1006. }
  1007. }
  1008. NOKPROBE_SYMBOL(kprobe_flush_task);
  1009. static inline void free_rp_inst(struct kretprobe *rp)
  1010. {
  1011. struct kretprobe_instance *ri;
  1012. struct hlist_node *next;
  1013. hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
  1014. hlist_del(&ri->hlist);
  1015. kfree(ri);
  1016. }
  1017. }
  1018. static void cleanup_rp_inst(struct kretprobe *rp)
  1019. {
  1020. unsigned long flags, hash;
  1021. struct kretprobe_instance *ri;
  1022. struct hlist_node *next;
  1023. struct hlist_head *head;
  1024. /* No race here */
  1025. for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
  1026. kretprobe_table_lock(hash, &flags);
  1027. head = &kretprobe_inst_table[hash];
  1028. hlist_for_each_entry_safe(ri, next, head, hlist) {
  1029. if (ri->rp == rp)
  1030. ri->rp = NULL;
  1031. }
  1032. kretprobe_table_unlock(hash, &flags);
  1033. }
  1034. free_rp_inst(rp);
  1035. }
  1036. NOKPROBE_SYMBOL(cleanup_rp_inst);
  1037. /*
  1038. * Add the new probe to ap->list. Fail if this is the
  1039. * second jprobe at the address - two jprobes can't coexist
  1040. */
  1041. static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
  1042. {
  1043. BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
  1044. if (p->break_handler || p->post_handler)
  1045. unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
  1046. if (p->break_handler) {
  1047. if (ap->break_handler)
  1048. return -EEXIST;
  1049. list_add_tail_rcu(&p->list, &ap->list);
  1050. ap->break_handler = aggr_break_handler;
  1051. } else
  1052. list_add_rcu(&p->list, &ap->list);
  1053. if (p->post_handler && !ap->post_handler)
  1054. ap->post_handler = aggr_post_handler;
  1055. return 0;
  1056. }
  1057. /*
  1058. * Fill in the required fields of the "manager kprobe". Replace the
  1059. * earlier kprobe in the hlist with the manager kprobe
  1060. */
  1061. static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
  1062. {
  1063. /* Copy p's insn slot to ap */
  1064. copy_kprobe(p, ap);
  1065. flush_insn_slot(ap);
  1066. ap->addr = p->addr;
  1067. ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
  1068. ap->pre_handler = aggr_pre_handler;
  1069. ap->fault_handler = aggr_fault_handler;
  1070. /* We don't care the kprobe which has gone. */
  1071. if (p->post_handler && !kprobe_gone(p))
  1072. ap->post_handler = aggr_post_handler;
  1073. if (p->break_handler && !kprobe_gone(p))
  1074. ap->break_handler = aggr_break_handler;
  1075. INIT_LIST_HEAD(&ap->list);
  1076. INIT_HLIST_NODE(&ap->hlist);
  1077. list_add_rcu(&p->list, &ap->list);
  1078. hlist_replace_rcu(&p->hlist, &ap->hlist);
  1079. }
  1080. /*
  1081. * This is the second or subsequent kprobe at the address - handle
  1082. * the intricacies
  1083. */
  1084. static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
  1085. {
  1086. int ret = 0;
  1087. struct kprobe *ap = orig_p;
  1088. /* For preparing optimization, jump_label_text_reserved() is called */
  1089. jump_label_lock();
  1090. /*
  1091. * Get online CPUs to avoid text_mutex deadlock.with stop machine,
  1092. * which is invoked by unoptimize_kprobe() in add_new_kprobe()
  1093. */
  1094. get_online_cpus();
  1095. mutex_lock(&text_mutex);
  1096. if (!kprobe_aggrprobe(orig_p)) {
  1097. /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
  1098. ap = alloc_aggr_kprobe(orig_p);
  1099. if (!ap) {
  1100. ret = -ENOMEM;
  1101. goto out;
  1102. }
  1103. init_aggr_kprobe(ap, orig_p);
  1104. } else if (kprobe_unused(ap))
  1105. /* This probe is going to die. Rescue it */
  1106. reuse_unused_kprobe(ap);
  1107. if (kprobe_gone(ap)) {
  1108. /*
  1109. * Attempting to insert new probe at the same location that
  1110. * had a probe in the module vaddr area which already
  1111. * freed. So, the instruction slot has already been
  1112. * released. We need a new slot for the new probe.
  1113. */
  1114. ret = arch_prepare_kprobe(ap);
  1115. if (ret)
  1116. /*
  1117. * Even if fail to allocate new slot, don't need to
  1118. * free aggr_probe. It will be used next time, or
  1119. * freed by unregister_kprobe.
  1120. */
  1121. goto out;
  1122. /* Prepare optimized instructions if possible. */
  1123. prepare_optimized_kprobe(ap);
  1124. /*
  1125. * Clear gone flag to prevent allocating new slot again, and
  1126. * set disabled flag because it is not armed yet.
  1127. */
  1128. ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
  1129. | KPROBE_FLAG_DISABLED;
  1130. }
  1131. /* Copy ap's insn slot to p */
  1132. copy_kprobe(ap, p);
  1133. ret = add_new_kprobe(ap, p);
  1134. out:
  1135. mutex_unlock(&text_mutex);
  1136. put_online_cpus();
  1137. jump_label_unlock();
  1138. if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
  1139. ap->flags &= ~KPROBE_FLAG_DISABLED;
  1140. if (!kprobes_all_disarmed)
  1141. /* Arm the breakpoint again. */
  1142. arm_kprobe(ap);
  1143. }
  1144. return ret;
  1145. }
  1146. bool __weak arch_within_kprobe_blacklist(unsigned long addr)
  1147. {
  1148. /* The __kprobes marked functions and entry code must not be probed */
  1149. return addr >= (unsigned long)__kprobes_text_start &&
  1150. addr < (unsigned long)__kprobes_text_end;
  1151. }
  1152. static bool within_kprobe_blacklist(unsigned long addr)
  1153. {
  1154. struct kprobe_blacklist_entry *ent;
  1155. if (arch_within_kprobe_blacklist(addr))
  1156. return true;
  1157. /*
  1158. * If there exists a kprobe_blacklist, verify and
  1159. * fail any probe registration in the prohibited area
  1160. */
  1161. list_for_each_entry(ent, &kprobe_blacklist, list) {
  1162. if (addr >= ent->start_addr && addr < ent->end_addr)
  1163. return true;
  1164. }
  1165. return false;
  1166. }
  1167. /*
  1168. * If we have a symbol_name argument, look it up and add the offset field
  1169. * to it. This way, we can specify a relative address to a symbol.
  1170. * This returns encoded errors if it fails to look up symbol or invalid
  1171. * combination of parameters.
  1172. */
  1173. static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
  1174. {
  1175. kprobe_opcode_t *addr = p->addr;
  1176. if ((p->symbol_name && p->addr) ||
  1177. (!p->symbol_name && !p->addr))
  1178. goto invalid;
  1179. if (p->symbol_name) {
  1180. kprobe_lookup_name(p->symbol_name, addr);
  1181. if (!addr)
  1182. return ERR_PTR(-ENOENT);
  1183. }
  1184. addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
  1185. if (addr)
  1186. return addr;
  1187. invalid:
  1188. return ERR_PTR(-EINVAL);
  1189. }
  1190. /* Check passed kprobe is valid and return kprobe in kprobe_table. */
  1191. static struct kprobe *__get_valid_kprobe(struct kprobe *p)
  1192. {
  1193. struct kprobe *ap, *list_p;
  1194. ap = get_kprobe(p->addr);
  1195. if (unlikely(!ap))
  1196. return NULL;
  1197. if (p != ap) {
  1198. list_for_each_entry_rcu(list_p, &ap->list, list)
  1199. if (list_p == p)
  1200. /* kprobe p is a valid probe */
  1201. goto valid;
  1202. return NULL;
  1203. }
  1204. valid:
  1205. return ap;
  1206. }
  1207. /* Return error if the kprobe is being re-registered */
  1208. static inline int check_kprobe_rereg(struct kprobe *p)
  1209. {
  1210. int ret = 0;
  1211. mutex_lock(&kprobe_mutex);
  1212. if (__get_valid_kprobe(p))
  1213. ret = -EINVAL;
  1214. mutex_unlock(&kprobe_mutex);
  1215. return ret;
  1216. }
  1217. static int check_kprobe_address_safe(struct kprobe *p,
  1218. struct module **probed_mod)
  1219. {
  1220. int ret = 0;
  1221. unsigned long ftrace_addr;
  1222. /*
  1223. * If the address is located on a ftrace nop, set the
  1224. * breakpoint to the following instruction.
  1225. */
  1226. ftrace_addr = ftrace_location((unsigned long)p->addr);
  1227. if (ftrace_addr) {
  1228. #ifdef CONFIG_KPROBES_ON_FTRACE
  1229. /* Given address is not on the instruction boundary */
  1230. if ((unsigned long)p->addr != ftrace_addr)
  1231. return -EILSEQ;
  1232. p->flags |= KPROBE_FLAG_FTRACE;
  1233. #else /* !CONFIG_KPROBES_ON_FTRACE */
  1234. return -EINVAL;
  1235. #endif
  1236. }
  1237. jump_label_lock();
  1238. preempt_disable();
  1239. /* Ensure it is not in reserved area nor out of text */
  1240. if (!kernel_text_address((unsigned long) p->addr) ||
  1241. within_kprobe_blacklist((unsigned long) p->addr) ||
  1242. jump_label_text_reserved(p->addr, p->addr)) {
  1243. ret = -EINVAL;
  1244. goto out;
  1245. }
  1246. /* Check if are we probing a module */
  1247. *probed_mod = __module_text_address((unsigned long) p->addr);
  1248. if (*probed_mod) {
  1249. /*
  1250. * We must hold a refcount of the probed module while updating
  1251. * its code to prohibit unexpected unloading.
  1252. */
  1253. if (unlikely(!try_module_get(*probed_mod))) {
  1254. ret = -ENOENT;
  1255. goto out;
  1256. }
  1257. /*
  1258. * If the module freed .init.text, we couldn't insert
  1259. * kprobes in there.
  1260. */
  1261. if (within_module_init((unsigned long)p->addr, *probed_mod) &&
  1262. (*probed_mod)->state != MODULE_STATE_COMING) {
  1263. module_put(*probed_mod);
  1264. *probed_mod = NULL;
  1265. ret = -ENOENT;
  1266. }
  1267. }
  1268. out:
  1269. preempt_enable();
  1270. jump_label_unlock();
  1271. return ret;
  1272. }
  1273. int register_kprobe(struct kprobe *p)
  1274. {
  1275. int ret;
  1276. struct kprobe *old_p;
  1277. struct module *probed_mod;
  1278. kprobe_opcode_t *addr;
  1279. /* Adjust probe address from symbol */
  1280. addr = kprobe_addr(p);
  1281. if (IS_ERR(addr))
  1282. return PTR_ERR(addr);
  1283. p->addr = addr;
  1284. ret = check_kprobe_rereg(p);
  1285. if (ret)
  1286. return ret;
  1287. /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
  1288. p->flags &= KPROBE_FLAG_DISABLED;
  1289. p->nmissed = 0;
  1290. INIT_LIST_HEAD(&p->list);
  1291. ret = check_kprobe_address_safe(p, &probed_mod);
  1292. if (ret)
  1293. return ret;
  1294. mutex_lock(&kprobe_mutex);
  1295. old_p = get_kprobe(p->addr);
  1296. if (old_p) {
  1297. /* Since this may unoptimize old_p, locking text_mutex. */
  1298. ret = register_aggr_kprobe(old_p, p);
  1299. goto out;
  1300. }
  1301. mutex_lock(&text_mutex); /* Avoiding text modification */
  1302. ret = prepare_kprobe(p);
  1303. mutex_unlock(&text_mutex);
  1304. if (ret)
  1305. goto out;
  1306. INIT_HLIST_NODE(&p->hlist);
  1307. hlist_add_head_rcu(&p->hlist,
  1308. &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
  1309. if (!kprobes_all_disarmed && !kprobe_disabled(p))
  1310. arm_kprobe(p);
  1311. /* Try to optimize kprobe */
  1312. try_to_optimize_kprobe(p);
  1313. out:
  1314. mutex_unlock(&kprobe_mutex);
  1315. if (probed_mod)
  1316. module_put(probed_mod);
  1317. return ret;
  1318. }
  1319. EXPORT_SYMBOL_GPL(register_kprobe);
  1320. /* Check if all probes on the aggrprobe are disabled */
  1321. static int aggr_kprobe_disabled(struct kprobe *ap)
  1322. {
  1323. struct kprobe *kp;
  1324. list_for_each_entry_rcu(kp, &ap->list, list)
  1325. if (!kprobe_disabled(kp))
  1326. /*
  1327. * There is an active probe on the list.
  1328. * We can't disable this ap.
  1329. */
  1330. return 0;
  1331. return 1;
  1332. }
  1333. /* Disable one kprobe: Make sure called under kprobe_mutex is locked */
  1334. static struct kprobe *__disable_kprobe(struct kprobe *p)
  1335. {
  1336. struct kprobe *orig_p;
  1337. /* Get an original kprobe for return */
  1338. orig_p = __get_valid_kprobe(p);
  1339. if (unlikely(orig_p == NULL))
  1340. return NULL;
  1341. if (!kprobe_disabled(p)) {
  1342. /* Disable probe if it is a child probe */
  1343. if (p != orig_p)
  1344. p->flags |= KPROBE_FLAG_DISABLED;
  1345. /* Try to disarm and disable this/parent probe */
  1346. if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
  1347. disarm_kprobe(orig_p, true);
  1348. orig_p->flags |= KPROBE_FLAG_DISABLED;
  1349. }
  1350. }
  1351. return orig_p;
  1352. }
  1353. /*
  1354. * Unregister a kprobe without a scheduler synchronization.
  1355. */
  1356. static int __unregister_kprobe_top(struct kprobe *p)
  1357. {
  1358. struct kprobe *ap, *list_p;
  1359. /* Disable kprobe. This will disarm it if needed. */
  1360. ap = __disable_kprobe(p);
  1361. if (ap == NULL)
  1362. return -EINVAL;
  1363. if (ap == p)
  1364. /*
  1365. * This probe is an independent(and non-optimized) kprobe
  1366. * (not an aggrprobe). Remove from the hash list.
  1367. */
  1368. goto disarmed;
  1369. /* Following process expects this probe is an aggrprobe */
  1370. WARN_ON(!kprobe_aggrprobe(ap));
  1371. if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
  1372. /*
  1373. * !disarmed could be happen if the probe is under delayed
  1374. * unoptimizing.
  1375. */
  1376. goto disarmed;
  1377. else {
  1378. /* If disabling probe has special handlers, update aggrprobe */
  1379. if (p->break_handler && !kprobe_gone(p))
  1380. ap->break_handler = NULL;
  1381. if (p->post_handler && !kprobe_gone(p)) {
  1382. list_for_each_entry_rcu(list_p, &ap->list, list) {
  1383. if ((list_p != p) && (list_p->post_handler))
  1384. goto noclean;
  1385. }
  1386. ap->post_handler = NULL;
  1387. }
  1388. noclean:
  1389. /*
  1390. * Remove from the aggrprobe: this path will do nothing in
  1391. * __unregister_kprobe_bottom().
  1392. */
  1393. list_del_rcu(&p->list);
  1394. if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
  1395. /*
  1396. * Try to optimize this probe again, because post
  1397. * handler may have been changed.
  1398. */
  1399. optimize_kprobe(ap);
  1400. }
  1401. return 0;
  1402. disarmed:
  1403. BUG_ON(!kprobe_disarmed(ap));
  1404. hlist_del_rcu(&ap->hlist);
  1405. return 0;
  1406. }
  1407. static void __unregister_kprobe_bottom(struct kprobe *p)
  1408. {
  1409. struct kprobe *ap;
  1410. if (list_empty(&p->list))
  1411. /* This is an independent kprobe */
  1412. arch_remove_kprobe(p);
  1413. else if (list_is_singular(&p->list)) {
  1414. /* This is the last child of an aggrprobe */
  1415. ap = list_entry(p->list.next, struct kprobe, list);
  1416. list_del(&p->list);
  1417. free_aggr_kprobe(ap);
  1418. }
  1419. /* Otherwise, do nothing. */
  1420. }
  1421. int register_kprobes(struct kprobe **kps, int num)
  1422. {
  1423. int i, ret = 0;
  1424. if (num <= 0)
  1425. return -EINVAL;
  1426. for (i = 0; i < num; i++) {
  1427. ret = register_kprobe(kps[i]);
  1428. if (ret < 0) {
  1429. if (i > 0)
  1430. unregister_kprobes(kps, i);
  1431. break;
  1432. }
  1433. }
  1434. return ret;
  1435. }
  1436. EXPORT_SYMBOL_GPL(register_kprobes);
  1437. void unregister_kprobe(struct kprobe *p)
  1438. {
  1439. unregister_kprobes(&p, 1);
  1440. }
  1441. EXPORT_SYMBOL_GPL(unregister_kprobe);
  1442. void unregister_kprobes(struct kprobe **kps, int num)
  1443. {
  1444. int i;
  1445. if (num <= 0)
  1446. return;
  1447. mutex_lock(&kprobe_mutex);
  1448. for (i = 0; i < num; i++)
  1449. if (__unregister_kprobe_top(kps[i]) < 0)
  1450. kps[i]->addr = NULL;
  1451. mutex_unlock(&kprobe_mutex);
  1452. synchronize_sched();
  1453. for (i = 0; i < num; i++)
  1454. if (kps[i]->addr)
  1455. __unregister_kprobe_bottom(kps[i]);
  1456. }
  1457. EXPORT_SYMBOL_GPL(unregister_kprobes);
  1458. static struct notifier_block kprobe_exceptions_nb = {
  1459. .notifier_call = kprobe_exceptions_notify,
  1460. .priority = 0x7fffffff /* we need to be notified first */
  1461. };
  1462. unsigned long __weak arch_deref_entry_point(void *entry)
  1463. {
  1464. return (unsigned long)entry;
  1465. }
  1466. int register_jprobes(struct jprobe **jps, int num)
  1467. {
  1468. struct jprobe *jp;
  1469. int ret = 0, i;
  1470. if (num <= 0)
  1471. return -EINVAL;
  1472. for (i = 0; i < num; i++) {
  1473. unsigned long addr, offset;
  1474. jp = jps[i];
  1475. addr = arch_deref_entry_point(jp->entry);
  1476. /* Verify probepoint is a function entry point */
  1477. if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
  1478. offset == 0) {
  1479. jp->kp.pre_handler = setjmp_pre_handler;
  1480. jp->kp.break_handler = longjmp_break_handler;
  1481. ret = register_kprobe(&jp->kp);
  1482. } else
  1483. ret = -EINVAL;
  1484. if (ret < 0) {
  1485. if (i > 0)
  1486. unregister_jprobes(jps, i);
  1487. break;
  1488. }
  1489. }
  1490. return ret;
  1491. }
  1492. EXPORT_SYMBOL_GPL(register_jprobes);
  1493. int register_jprobe(struct jprobe *jp)
  1494. {
  1495. return register_jprobes(&jp, 1);
  1496. }
  1497. EXPORT_SYMBOL_GPL(register_jprobe);
  1498. void unregister_jprobe(struct jprobe *jp)
  1499. {
  1500. unregister_jprobes(&jp, 1);
  1501. }
  1502. EXPORT_SYMBOL_GPL(unregister_jprobe);
  1503. void unregister_jprobes(struct jprobe **jps, int num)
  1504. {
  1505. int i;
  1506. if (num <= 0)
  1507. return;
  1508. mutex_lock(&kprobe_mutex);
  1509. for (i = 0; i < num; i++)
  1510. if (__unregister_kprobe_top(&jps[i]->kp) < 0)
  1511. jps[i]->kp.addr = NULL;
  1512. mutex_unlock(&kprobe_mutex);
  1513. synchronize_sched();
  1514. for (i = 0; i < num; i++) {
  1515. if (jps[i]->kp.addr)
  1516. __unregister_kprobe_bottom(&jps[i]->kp);
  1517. }
  1518. }
  1519. EXPORT_SYMBOL_GPL(unregister_jprobes);
  1520. #ifdef CONFIG_KRETPROBES
  1521. /*
  1522. * This kprobe pre_handler is registered with every kretprobe. When probe
  1523. * hits it will set up the return probe.
  1524. */
  1525. static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
  1526. {
  1527. struct kretprobe *rp = container_of(p, struct kretprobe, kp);
  1528. unsigned long hash, flags = 0;
  1529. struct kretprobe_instance *ri;
  1530. /*TODO: consider to only swap the RA after the last pre_handler fired */
  1531. hash = hash_ptr(current, KPROBE_HASH_BITS);
  1532. raw_spin_lock_irqsave(&rp->lock, flags);
  1533. if (!hlist_empty(&rp->free_instances)) {
  1534. ri = hlist_entry(rp->free_instances.first,
  1535. struct kretprobe_instance, hlist);
  1536. hlist_del(&ri->hlist);
  1537. raw_spin_unlock_irqrestore(&rp->lock, flags);
  1538. ri->rp = rp;
  1539. ri->task = current;
  1540. if (rp->entry_handler && rp->entry_handler(ri, regs)) {
  1541. raw_spin_lock_irqsave(&rp->lock, flags);
  1542. hlist_add_head(&ri->hlist, &rp->free_instances);
  1543. raw_spin_unlock_irqrestore(&rp->lock, flags);
  1544. return 0;
  1545. }
  1546. arch_prepare_kretprobe(ri, regs);
  1547. /* XXX(hch): why is there no hlist_move_head? */
  1548. INIT_HLIST_NODE(&ri->hlist);
  1549. kretprobe_table_lock(hash, &flags);
  1550. hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
  1551. kretprobe_table_unlock(hash, &flags);
  1552. } else {
  1553. rp->nmissed++;
  1554. raw_spin_unlock_irqrestore(&rp->lock, flags);
  1555. }
  1556. return 0;
  1557. }
  1558. NOKPROBE_SYMBOL(pre_handler_kretprobe);
  1559. int register_kretprobe(struct kretprobe *rp)
  1560. {
  1561. int ret = 0;
  1562. struct kretprobe_instance *inst;
  1563. int i;
  1564. void *addr;
  1565. if (kretprobe_blacklist_size) {
  1566. addr = kprobe_addr(&rp->kp);
  1567. if (IS_ERR(addr))
  1568. return PTR_ERR(addr);
  1569. for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
  1570. if (kretprobe_blacklist[i].addr == addr)
  1571. return -EINVAL;
  1572. }
  1573. }
  1574. rp->kp.pre_handler = pre_handler_kretprobe;
  1575. rp->kp.post_handler = NULL;
  1576. rp->kp.fault_handler = NULL;
  1577. rp->kp.break_handler = NULL;
  1578. /* Pre-allocate memory for max kretprobe instances */
  1579. if (rp->maxactive <= 0) {
  1580. #ifdef CONFIG_PREEMPT
  1581. rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
  1582. #else
  1583. rp->maxactive = num_possible_cpus();
  1584. #endif
  1585. }
  1586. raw_spin_lock_init(&rp->lock);
  1587. INIT_HLIST_HEAD(&rp->free_instances);
  1588. for (i = 0; i < rp->maxactive; i++) {
  1589. inst = kmalloc(sizeof(struct kretprobe_instance) +
  1590. rp->data_size, GFP_KERNEL);
  1591. if (inst == NULL) {
  1592. free_rp_inst(rp);
  1593. return -ENOMEM;
  1594. }
  1595. INIT_HLIST_NODE(&inst->hlist);
  1596. hlist_add_head(&inst->hlist, &rp->free_instances);
  1597. }
  1598. rp->nmissed = 0;
  1599. /* Establish function entry probe point */
  1600. ret = register_kprobe(&rp->kp);
  1601. if (ret != 0)
  1602. free_rp_inst(rp);
  1603. return ret;
  1604. }
  1605. EXPORT_SYMBOL_GPL(register_kretprobe);
  1606. int register_kretprobes(struct kretprobe **rps, int num)
  1607. {
  1608. int ret = 0, i;
  1609. if (num <= 0)
  1610. return -EINVAL;
  1611. for (i = 0; i < num; i++) {
  1612. ret = register_kretprobe(rps[i]);
  1613. if (ret < 0) {
  1614. if (i > 0)
  1615. unregister_kretprobes(rps, i);
  1616. break;
  1617. }
  1618. }
  1619. return ret;
  1620. }
  1621. EXPORT_SYMBOL_GPL(register_kretprobes);
  1622. void unregister_kretprobe(struct kretprobe *rp)
  1623. {
  1624. unregister_kretprobes(&rp, 1);
  1625. }
  1626. EXPORT_SYMBOL_GPL(unregister_kretprobe);
  1627. void unregister_kretprobes(struct kretprobe **rps, int num)
  1628. {
  1629. int i;
  1630. if (num <= 0)
  1631. return;
  1632. mutex_lock(&kprobe_mutex);
  1633. for (i = 0; i < num; i++)
  1634. if (__unregister_kprobe_top(&rps[i]->kp) < 0)
  1635. rps[i]->kp.addr = NULL;
  1636. mutex_unlock(&kprobe_mutex);
  1637. synchronize_sched();
  1638. for (i = 0; i < num; i++) {
  1639. if (rps[i]->kp.addr) {
  1640. __unregister_kprobe_bottom(&rps[i]->kp);
  1641. cleanup_rp_inst(rps[i]);
  1642. }
  1643. }
  1644. }
  1645. EXPORT_SYMBOL_GPL(unregister_kretprobes);
  1646. #else /* CONFIG_KRETPROBES */
  1647. int register_kretprobe(struct kretprobe *rp)
  1648. {
  1649. return -ENOSYS;
  1650. }
  1651. EXPORT_SYMBOL_GPL(register_kretprobe);
  1652. int register_kretprobes(struct kretprobe **rps, int num)
  1653. {
  1654. return -ENOSYS;
  1655. }
  1656. EXPORT_SYMBOL_GPL(register_kretprobes);
  1657. void unregister_kretprobe(struct kretprobe *rp)
  1658. {
  1659. }
  1660. EXPORT_SYMBOL_GPL(unregister_kretprobe);
  1661. void unregister_kretprobes(struct kretprobe **rps, int num)
  1662. {
  1663. }
  1664. EXPORT_SYMBOL_GPL(unregister_kretprobes);
  1665. static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
  1666. {
  1667. return 0;
  1668. }
  1669. NOKPROBE_SYMBOL(pre_handler_kretprobe);
  1670. #endif /* CONFIG_KRETPROBES */
  1671. /* Set the kprobe gone and remove its instruction buffer. */
  1672. static void kill_kprobe(struct kprobe *p)
  1673. {
  1674. struct kprobe *kp;
  1675. p->flags |= KPROBE_FLAG_GONE;
  1676. if (kprobe_aggrprobe(p)) {
  1677. /*
  1678. * If this is an aggr_kprobe, we have to list all the
  1679. * chained probes and mark them GONE.
  1680. */
  1681. list_for_each_entry_rcu(kp, &p->list, list)
  1682. kp->flags |= KPROBE_FLAG_GONE;
  1683. p->post_handler = NULL;
  1684. p->break_handler = NULL;
  1685. kill_optimized_kprobe(p);
  1686. }
  1687. /*
  1688. * Here, we can remove insn_slot safely, because no thread calls
  1689. * the original probed function (which will be freed soon) any more.
  1690. */
  1691. arch_remove_kprobe(p);
  1692. }
  1693. /* Disable one kprobe */
  1694. int disable_kprobe(struct kprobe *kp)
  1695. {
  1696. int ret = 0;
  1697. mutex_lock(&kprobe_mutex);
  1698. /* Disable this kprobe */
  1699. if (__disable_kprobe(kp) == NULL)
  1700. ret = -EINVAL;
  1701. mutex_unlock(&kprobe_mutex);
  1702. return ret;
  1703. }
  1704. EXPORT_SYMBOL_GPL(disable_kprobe);
  1705. /* Enable one kprobe */
  1706. int enable_kprobe(struct kprobe *kp)
  1707. {
  1708. int ret = 0;
  1709. struct kprobe *p;
  1710. mutex_lock(&kprobe_mutex);
  1711. /* Check whether specified probe is valid. */
  1712. p = __get_valid_kprobe(kp);
  1713. if (unlikely(p == NULL)) {
  1714. ret = -EINVAL;
  1715. goto out;
  1716. }
  1717. if (kprobe_gone(kp)) {
  1718. /* This kprobe has gone, we couldn't enable it. */
  1719. ret = -EINVAL;
  1720. goto out;
  1721. }
  1722. if (p != kp)
  1723. kp->flags &= ~KPROBE_FLAG_DISABLED;
  1724. if (!kprobes_all_disarmed && kprobe_disabled(p)) {
  1725. p->flags &= ~KPROBE_FLAG_DISABLED;
  1726. arm_kprobe(p);
  1727. }
  1728. out:
  1729. mutex_unlock(&kprobe_mutex);
  1730. return ret;
  1731. }
  1732. EXPORT_SYMBOL_GPL(enable_kprobe);
  1733. void dump_kprobe(struct kprobe *kp)
  1734. {
  1735. printk(KERN_WARNING "Dumping kprobe:\n");
  1736. printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
  1737. kp->symbol_name, kp->addr, kp->offset);
  1738. }
  1739. NOKPROBE_SYMBOL(dump_kprobe);
  1740. /*
  1741. * Lookup and populate the kprobe_blacklist.
  1742. *
  1743. * Unlike the kretprobe blacklist, we'll need to determine
  1744. * the range of addresses that belong to the said functions,
  1745. * since a kprobe need not necessarily be at the beginning
  1746. * of a function.
  1747. */
  1748. static int __init populate_kprobe_blacklist(unsigned long *start,
  1749. unsigned long *end)
  1750. {
  1751. unsigned long *iter;
  1752. struct kprobe_blacklist_entry *ent;
  1753. unsigned long entry, offset = 0, size = 0;
  1754. for (iter = start; iter < end; iter++) {
  1755. entry = arch_deref_entry_point((void *)*iter);
  1756. if (!kernel_text_address(entry) ||
  1757. !kallsyms_lookup_size_offset(entry, &size, &offset)) {
  1758. pr_err("Failed to find blacklist at %p\n",
  1759. (void *)entry);
  1760. continue;
  1761. }
  1762. ent = kmalloc(sizeof(*ent), GFP_KERNEL);
  1763. if (!ent)
  1764. return -ENOMEM;
  1765. ent->start_addr = entry;
  1766. ent->end_addr = entry + size;
  1767. INIT_LIST_HEAD(&ent->list);
  1768. list_add_tail(&ent->list, &kprobe_blacklist);
  1769. }
  1770. return 0;
  1771. }
  1772. /* Module notifier call back, checking kprobes on the module */
  1773. static int kprobes_module_callback(struct notifier_block *nb,
  1774. unsigned long val, void *data)
  1775. {
  1776. struct module *mod = data;
  1777. struct hlist_head *head;
  1778. struct kprobe *p;
  1779. unsigned int i;
  1780. int checkcore = (val == MODULE_STATE_GOING);
  1781. if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
  1782. return NOTIFY_DONE;
  1783. /*
  1784. * When MODULE_STATE_GOING was notified, both of module .text and
  1785. * .init.text sections would be freed. When MODULE_STATE_LIVE was
  1786. * notified, only .init.text section would be freed. We need to
  1787. * disable kprobes which have been inserted in the sections.
  1788. */
  1789. mutex_lock(&kprobe_mutex);
  1790. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  1791. head = &kprobe_table[i];
  1792. hlist_for_each_entry_rcu(p, head, hlist)
  1793. if (within_module_init((unsigned long)p->addr, mod) ||
  1794. (checkcore &&
  1795. within_module_core((unsigned long)p->addr, mod))) {
  1796. /*
  1797. * The vaddr this probe is installed will soon
  1798. * be vfreed buy not synced to disk. Hence,
  1799. * disarming the breakpoint isn't needed.
  1800. */
  1801. kill_kprobe(p);
  1802. }
  1803. }
  1804. mutex_unlock(&kprobe_mutex);
  1805. return NOTIFY_DONE;
  1806. }
  1807. static struct notifier_block kprobe_module_nb = {
  1808. .notifier_call = kprobes_module_callback,
  1809. .priority = 0
  1810. };
  1811. /* Markers of _kprobe_blacklist section */
  1812. extern unsigned long __start_kprobe_blacklist[];
  1813. extern unsigned long __stop_kprobe_blacklist[];
  1814. static int __init init_kprobes(void)
  1815. {
  1816. int i, err = 0;
  1817. /* FIXME allocate the probe table, currently defined statically */
  1818. /* initialize all list heads */
  1819. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  1820. INIT_HLIST_HEAD(&kprobe_table[i]);
  1821. INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
  1822. raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
  1823. }
  1824. err = populate_kprobe_blacklist(__start_kprobe_blacklist,
  1825. __stop_kprobe_blacklist);
  1826. if (err) {
  1827. pr_err("kprobes: failed to populate blacklist: %d\n", err);
  1828. pr_err("Please take care of using kprobes.\n");
  1829. }
  1830. if (kretprobe_blacklist_size) {
  1831. /* lookup the function address from its name */
  1832. for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
  1833. kprobe_lookup_name(kretprobe_blacklist[i].name,
  1834. kretprobe_blacklist[i].addr);
  1835. if (!kretprobe_blacklist[i].addr)
  1836. printk("kretprobe: lookup failed: %s\n",
  1837. kretprobe_blacklist[i].name);
  1838. }
  1839. }
  1840. #if defined(CONFIG_OPTPROBES)
  1841. #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
  1842. /* Init kprobe_optinsn_slots */
  1843. kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
  1844. #endif
  1845. /* By default, kprobes can be optimized */
  1846. kprobes_allow_optimization = true;
  1847. #endif
  1848. /* By default, kprobes are armed */
  1849. kprobes_all_disarmed = false;
  1850. err = arch_init_kprobes();
  1851. if (!err)
  1852. err = register_die_notifier(&kprobe_exceptions_nb);
  1853. if (!err)
  1854. err = register_module_notifier(&kprobe_module_nb);
  1855. kprobes_initialized = (err == 0);
  1856. if (!err)
  1857. init_test_probes();
  1858. return err;
  1859. }
  1860. #ifdef CONFIG_DEBUG_FS
  1861. static void report_probe(struct seq_file *pi, struct kprobe *p,
  1862. const char *sym, int offset, char *modname, struct kprobe *pp)
  1863. {
  1864. char *kprobe_type;
  1865. if (p->pre_handler == pre_handler_kretprobe)
  1866. kprobe_type = "r";
  1867. else if (p->pre_handler == setjmp_pre_handler)
  1868. kprobe_type = "j";
  1869. else
  1870. kprobe_type = "k";
  1871. if (sym)
  1872. seq_printf(pi, "%p %s %s+0x%x %s ",
  1873. p->addr, kprobe_type, sym, offset,
  1874. (modname ? modname : " "));
  1875. else
  1876. seq_printf(pi, "%p %s %p ",
  1877. p->addr, kprobe_type, p->addr);
  1878. if (!pp)
  1879. pp = p;
  1880. seq_printf(pi, "%s%s%s%s\n",
  1881. (kprobe_gone(p) ? "[GONE]" : ""),
  1882. ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
  1883. (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
  1884. (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
  1885. }
  1886. static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
  1887. {
  1888. return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
  1889. }
  1890. static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
  1891. {
  1892. (*pos)++;
  1893. if (*pos >= KPROBE_TABLE_SIZE)
  1894. return NULL;
  1895. return pos;
  1896. }
  1897. static void kprobe_seq_stop(struct seq_file *f, void *v)
  1898. {
  1899. /* Nothing to do */
  1900. }
  1901. static int show_kprobe_addr(struct seq_file *pi, void *v)
  1902. {
  1903. struct hlist_head *head;
  1904. struct kprobe *p, *kp;
  1905. const char *sym = NULL;
  1906. unsigned int i = *(loff_t *) v;
  1907. unsigned long offset = 0;
  1908. char *modname, namebuf[KSYM_NAME_LEN];
  1909. head = &kprobe_table[i];
  1910. preempt_disable();
  1911. hlist_for_each_entry_rcu(p, head, hlist) {
  1912. sym = kallsyms_lookup((unsigned long)p->addr, NULL,
  1913. &offset, &modname, namebuf);
  1914. if (kprobe_aggrprobe(p)) {
  1915. list_for_each_entry_rcu(kp, &p->list, list)
  1916. report_probe(pi, kp, sym, offset, modname, p);
  1917. } else
  1918. report_probe(pi, p, sym, offset, modname, NULL);
  1919. }
  1920. preempt_enable();
  1921. return 0;
  1922. }
  1923. static const struct seq_operations kprobes_seq_ops = {
  1924. .start = kprobe_seq_start,
  1925. .next = kprobe_seq_next,
  1926. .stop = kprobe_seq_stop,
  1927. .show = show_kprobe_addr
  1928. };
  1929. static int kprobes_open(struct inode *inode, struct file *filp)
  1930. {
  1931. return seq_open(filp, &kprobes_seq_ops);
  1932. }
  1933. static const struct file_operations debugfs_kprobes_operations = {
  1934. .open = kprobes_open,
  1935. .read = seq_read,
  1936. .llseek = seq_lseek,
  1937. .release = seq_release,
  1938. };
  1939. /* kprobes/blacklist -- shows which functions can not be probed */
  1940. static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
  1941. {
  1942. return seq_list_start(&kprobe_blacklist, *pos);
  1943. }
  1944. static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
  1945. {
  1946. return seq_list_next(v, &kprobe_blacklist, pos);
  1947. }
  1948. static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
  1949. {
  1950. struct kprobe_blacklist_entry *ent =
  1951. list_entry(v, struct kprobe_blacklist_entry, list);
  1952. seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
  1953. (void *)ent->end_addr, (void *)ent->start_addr);
  1954. return 0;
  1955. }
  1956. static const struct seq_operations kprobe_blacklist_seq_ops = {
  1957. .start = kprobe_blacklist_seq_start,
  1958. .next = kprobe_blacklist_seq_next,
  1959. .stop = kprobe_seq_stop, /* Reuse void function */
  1960. .show = kprobe_blacklist_seq_show,
  1961. };
  1962. static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
  1963. {
  1964. return seq_open(filp, &kprobe_blacklist_seq_ops);
  1965. }
  1966. static const struct file_operations debugfs_kprobe_blacklist_ops = {
  1967. .open = kprobe_blacklist_open,
  1968. .read = seq_read,
  1969. .llseek = seq_lseek,
  1970. .release = seq_release,
  1971. };
  1972. static void arm_all_kprobes(void)
  1973. {
  1974. struct hlist_head *head;
  1975. struct kprobe *p;
  1976. unsigned int i;
  1977. mutex_lock(&kprobe_mutex);
  1978. /* If kprobes are armed, just return */
  1979. if (!kprobes_all_disarmed)
  1980. goto already_enabled;
  1981. /* Arming kprobes doesn't optimize kprobe itself */
  1982. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  1983. head = &kprobe_table[i];
  1984. hlist_for_each_entry_rcu(p, head, hlist)
  1985. if (!kprobe_disabled(p))
  1986. arm_kprobe(p);
  1987. }
  1988. kprobes_all_disarmed = false;
  1989. printk(KERN_INFO "Kprobes globally enabled\n");
  1990. already_enabled:
  1991. mutex_unlock(&kprobe_mutex);
  1992. return;
  1993. }
  1994. static void disarm_all_kprobes(void)
  1995. {
  1996. struct hlist_head *head;
  1997. struct kprobe *p;
  1998. unsigned int i;
  1999. mutex_lock(&kprobe_mutex);
  2000. /* If kprobes are already disarmed, just return */
  2001. if (kprobes_all_disarmed) {
  2002. mutex_unlock(&kprobe_mutex);
  2003. return;
  2004. }
  2005. kprobes_all_disarmed = true;
  2006. printk(KERN_INFO "Kprobes globally disabled\n");
  2007. for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
  2008. head = &kprobe_table[i];
  2009. hlist_for_each_entry_rcu(p, head, hlist) {
  2010. if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
  2011. disarm_kprobe(p, false);
  2012. }
  2013. }
  2014. mutex_unlock(&kprobe_mutex);
  2015. /* Wait for disarming all kprobes by optimizer */
  2016. wait_for_kprobe_optimizer();
  2017. }
  2018. /*
  2019. * XXX: The debugfs bool file interface doesn't allow for callbacks
  2020. * when the bool state is switched. We can reuse that facility when
  2021. * available
  2022. */
  2023. static ssize_t read_enabled_file_bool(struct file *file,
  2024. char __user *user_buf, size_t count, loff_t *ppos)
  2025. {
  2026. char buf[3];
  2027. if (!kprobes_all_disarmed)
  2028. buf[0] = '1';
  2029. else
  2030. buf[0] = '0';
  2031. buf[1] = '\n';
  2032. buf[2] = 0x00;
  2033. return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
  2034. }
  2035. static ssize_t write_enabled_file_bool(struct file *file,
  2036. const char __user *user_buf, size_t count, loff_t *ppos)
  2037. {
  2038. char buf[32];
  2039. size_t buf_size;
  2040. buf_size = min(count, (sizeof(buf)-1));
  2041. if (copy_from_user(buf, user_buf, buf_size))
  2042. return -EFAULT;
  2043. buf[buf_size] = '\0';
  2044. switch (buf[0]) {
  2045. case 'y':
  2046. case 'Y':
  2047. case '1':
  2048. arm_all_kprobes();
  2049. break;
  2050. case 'n':
  2051. case 'N':
  2052. case '0':
  2053. disarm_all_kprobes();
  2054. break;
  2055. default:
  2056. return -EINVAL;
  2057. }
  2058. return count;
  2059. }
  2060. static const struct file_operations fops_kp = {
  2061. .read = read_enabled_file_bool,
  2062. .write = write_enabled_file_bool,
  2063. .llseek = default_llseek,
  2064. };
  2065. static int __init debugfs_kprobe_init(void)
  2066. {
  2067. struct dentry *dir, *file;
  2068. unsigned int value = 1;
  2069. dir = debugfs_create_dir("kprobes", NULL);
  2070. if (!dir)
  2071. return -ENOMEM;
  2072. file = debugfs_create_file("list", 0444, dir, NULL,
  2073. &debugfs_kprobes_operations);
  2074. if (!file)
  2075. goto error;
  2076. file = debugfs_create_file("enabled", 0600, dir,
  2077. &value, &fops_kp);
  2078. if (!file)
  2079. goto error;
  2080. file = debugfs_create_file("blacklist", 0444, dir, NULL,
  2081. &debugfs_kprobe_blacklist_ops);
  2082. if (!file)
  2083. goto error;
  2084. return 0;
  2085. error:
  2086. debugfs_remove(dir);
  2087. return -ENOMEM;
  2088. }
  2089. late_initcall(debugfs_kprobe_init);
  2090. #endif /* CONFIG_DEBUG_FS */
  2091. module_init(init_kprobes);
  2092. /* defined in arch/.../kernel/kprobes.c */
  2093. EXPORT_SYMBOL_GPL(jprobe_return);