kmemleak.c 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685
  1. /*
  2. * mm/kmemleak.c
  3. *
  4. * Copyright (C) 2008 ARM Limited
  5. * Written by Catalin Marinas <catalin.marinas@arm.com>
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License version 2 as
  9. * published by the Free Software Foundation.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19. *
  20. *
  21. * For more information on the algorithm and kmemleak usage, please see
  22. * Documentation/kmemleak.txt.
  23. *
  24. * Notes on locking
  25. * ----------------
  26. *
  27. * The following locks and mutexes are used by kmemleak:
  28. *
  29. * - kmemleak_lock (rwlock): protects the object_list modifications and
  30. * accesses to the object_tree_root. The object_list is the main list
  31. * holding the metadata (struct kmemleak_object) for the allocated memory
  32. * blocks. The object_tree_root is a priority search tree used to look-up
  33. * metadata based on a pointer to the corresponding memory block. The
  34. * kmemleak_object structures are added to the object_list and
  35. * object_tree_root in the create_object() function called from the
  36. * kmemleak_alloc() callback and removed in delete_object() called from the
  37. * kmemleak_free() callback
  38. * - kmemleak_object.lock (spinlock): protects a kmemleak_object. Accesses to
  39. * the metadata (e.g. count) are protected by this lock. Note that some
  40. * members of this structure may be protected by other means (atomic or
  41. * kmemleak_lock). This lock is also held when scanning the corresponding
  42. * memory block to avoid the kernel freeing it via the kmemleak_free()
  43. * callback. This is less heavyweight than holding a global lock like
  44. * kmemleak_lock during scanning
  45. * - scan_mutex (mutex): ensures that only one thread may scan the memory for
  46. * unreferenced objects at a time. The gray_list contains the objects which
  47. * are already referenced or marked as false positives and need to be
  48. * scanned. This list is only modified during a scanning episode when the
  49. * scan_mutex is held. At the end of a scan, the gray_list is always empty.
  50. * Note that the kmemleak_object.use_count is incremented when an object is
  51. * added to the gray_list and therefore cannot be freed. This mutex also
  52. * prevents multiple users of the "kmemleak" debugfs file together with
  53. * modifications to the memory scanning parameters including the scan_thread
  54. * pointer
  55. *
  56. * The kmemleak_object structures have a use_count incremented or decremented
  57. * using the get_object()/put_object() functions. When the use_count becomes
  58. * 0, this count can no longer be incremented and put_object() schedules the
  59. * kmemleak_object freeing via an RCU callback. All calls to the get_object()
  60. * function must be protected by rcu_read_lock() to avoid accessing a freed
  61. * structure.
  62. */
  63. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  64. #include <linux/init.h>
  65. #include <linux/kernel.h>
  66. #include <linux/list.h>
  67. #include <linux/sched.h>
  68. #include <linux/jiffies.h>
  69. #include <linux/delay.h>
  70. #include <linux/module.h>
  71. #include <linux/kthread.h>
  72. #include <linux/prio_tree.h>
  73. #include <linux/gfp.h>
  74. #include <linux/fs.h>
  75. #include <linux/debugfs.h>
  76. #include <linux/seq_file.h>
  77. #include <linux/cpumask.h>
  78. #include <linux/spinlock.h>
  79. #include <linux/mutex.h>
  80. #include <linux/rcupdate.h>
  81. #include <linux/stacktrace.h>
  82. #include <linux/cache.h>
  83. #include <linux/percpu.h>
  84. #include <linux/hardirq.h>
  85. #include <linux/mmzone.h>
  86. #include <linux/slab.h>
  87. #include <linux/thread_info.h>
  88. #include <linux/err.h>
  89. #include <linux/uaccess.h>
  90. #include <linux/string.h>
  91. #include <linux/nodemask.h>
  92. #include <linux/mm.h>
  93. #include <linux/workqueue.h>
  94. #include <asm/sections.h>
  95. #include <asm/processor.h>
  96. #include <asm/atomic.h>
  97. #include <linux/kmemcheck.h>
  98. #include <linux/kmemleak.h>
  99. /*
  100. * Kmemleak configuration and common defines.
  101. */
  102. #define MAX_TRACE 16 /* stack trace length */
  103. #define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
  104. #define SECS_FIRST_SCAN 60 /* delay before the first scan */
  105. #define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
  106. #define GRAY_LIST_PASSES 25 /* maximum number of gray list scans */
  107. #define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
  108. #define BYTES_PER_POINTER sizeof(void *)
  109. /* GFP bitmask for kmemleak internal allocations */
  110. #define GFP_KMEMLEAK_MASK (GFP_KERNEL | GFP_ATOMIC)
  111. /* scanning area inside a memory block */
  112. struct kmemleak_scan_area {
  113. struct hlist_node node;
  114. unsigned long offset;
  115. size_t length;
  116. };
  117. #define KMEMLEAK_GREY 0
  118. #define KMEMLEAK_BLACK -1
  119. /*
  120. * Structure holding the metadata for each allocated memory block.
  121. * Modifications to such objects should be made while holding the
  122. * object->lock. Insertions or deletions from object_list, gray_list or
  123. * tree_node are already protected by the corresponding locks or mutex (see
  124. * the notes on locking above). These objects are reference-counted
  125. * (use_count) and freed using the RCU mechanism.
  126. */
  127. struct kmemleak_object {
  128. spinlock_t lock;
  129. unsigned long flags; /* object status flags */
  130. struct list_head object_list;
  131. struct list_head gray_list;
  132. struct prio_tree_node tree_node;
  133. struct rcu_head rcu; /* object_list lockless traversal */
  134. /* object usage count; object freed when use_count == 0 */
  135. atomic_t use_count;
  136. unsigned long pointer;
  137. size_t size;
  138. /* minimum number of a pointers found before it is considered leak */
  139. int min_count;
  140. /* the total number of pointers found pointing to this object */
  141. int count;
  142. /* memory ranges to be scanned inside an object (empty for all) */
  143. struct hlist_head area_list;
  144. unsigned long trace[MAX_TRACE];
  145. unsigned int trace_len;
  146. unsigned long jiffies; /* creation timestamp */
  147. pid_t pid; /* pid of the current task */
  148. char comm[TASK_COMM_LEN]; /* executable name */
  149. };
  150. /* flag representing the memory block allocation status */
  151. #define OBJECT_ALLOCATED (1 << 0)
  152. /* flag set after the first reporting of an unreference object */
  153. #define OBJECT_REPORTED (1 << 1)
  154. /* flag set to not scan the object */
  155. #define OBJECT_NO_SCAN (1 << 2)
  156. /* flag set on newly allocated objects */
  157. #define OBJECT_NEW (1 << 3)
  158. /* number of bytes to print per line; must be 16 or 32 */
  159. #define HEX_ROW_SIZE 16
  160. /* number of bytes to print at a time (1, 2, 4, 8) */
  161. #define HEX_GROUP_SIZE 1
  162. /* include ASCII after the hex output */
  163. #define HEX_ASCII 1
  164. /* max number of lines to be printed */
  165. #define HEX_MAX_LINES 2
  166. /* the list of all allocated objects */
  167. static LIST_HEAD(object_list);
  168. /* the list of gray-colored objects (see color_gray comment below) */
  169. static LIST_HEAD(gray_list);
  170. /* prio search tree for object boundaries */
  171. static struct prio_tree_root object_tree_root;
  172. /* rw_lock protecting the access to object_list and prio_tree_root */
  173. static DEFINE_RWLOCK(kmemleak_lock);
  174. /* allocation caches for kmemleak internal data */
  175. static struct kmem_cache *object_cache;
  176. static struct kmem_cache *scan_area_cache;
  177. /* set if tracing memory operations is enabled */
  178. static atomic_t kmemleak_enabled = ATOMIC_INIT(0);
  179. /* set in the late_initcall if there were no errors */
  180. static atomic_t kmemleak_initialized = ATOMIC_INIT(0);
  181. /* enables or disables early logging of the memory operations */
  182. static atomic_t kmemleak_early_log = ATOMIC_INIT(1);
  183. /* set if a fata kmemleak error has occurred */
  184. static atomic_t kmemleak_error = ATOMIC_INIT(0);
  185. /* minimum and maximum address that may be valid pointers */
  186. static unsigned long min_addr = ULONG_MAX;
  187. static unsigned long max_addr;
  188. static struct task_struct *scan_thread;
  189. /* used to avoid reporting of recently allocated objects */
  190. static unsigned long jiffies_min_age;
  191. static unsigned long jiffies_last_scan;
  192. /* delay between automatic memory scannings */
  193. static signed long jiffies_scan_wait;
  194. /* enables or disables the task stacks scanning */
  195. static int kmemleak_stack_scan = 1;
  196. /* protects the memory scanning, parameters and debug/kmemleak file access */
  197. static DEFINE_MUTEX(scan_mutex);
  198. /*
  199. * Early object allocation/freeing logging. Kmemleak is initialized after the
  200. * kernel allocator. However, both the kernel allocator and kmemleak may
  201. * allocate memory blocks which need to be tracked. Kmemleak defines an
  202. * arbitrary buffer to hold the allocation/freeing information before it is
  203. * fully initialized.
  204. */
  205. /* kmemleak operation type for early logging */
  206. enum {
  207. KMEMLEAK_ALLOC,
  208. KMEMLEAK_FREE,
  209. KMEMLEAK_FREE_PART,
  210. KMEMLEAK_NOT_LEAK,
  211. KMEMLEAK_IGNORE,
  212. KMEMLEAK_SCAN_AREA,
  213. KMEMLEAK_NO_SCAN
  214. };
  215. /*
  216. * Structure holding the information passed to kmemleak callbacks during the
  217. * early logging.
  218. */
  219. struct early_log {
  220. int op_type; /* kmemleak operation type */
  221. const void *ptr; /* allocated/freed memory block */
  222. size_t size; /* memory block size */
  223. int min_count; /* minimum reference count */
  224. unsigned long offset; /* scan area offset */
  225. size_t length; /* scan area length */
  226. unsigned long trace[MAX_TRACE]; /* stack trace */
  227. unsigned int trace_len; /* stack trace length */
  228. };
  229. /* early logging buffer and current position */
  230. static struct early_log
  231. early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
  232. static int crt_early_log __initdata;
  233. static void kmemleak_disable(void);
  234. /*
  235. * Print a warning and dump the stack trace.
  236. */
  237. #define kmemleak_warn(x...) do { \
  238. pr_warning(x); \
  239. dump_stack(); \
  240. } while (0)
  241. /*
  242. * Macro invoked when a serious kmemleak condition occured and cannot be
  243. * recovered from. Kmemleak will be disabled and further allocation/freeing
  244. * tracing no longer available.
  245. */
  246. #define kmemleak_stop(x...) do { \
  247. kmemleak_warn(x); \
  248. kmemleak_disable(); \
  249. } while (0)
  250. /*
  251. * Printing of the objects hex dump to the seq file. The number of lines to be
  252. * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
  253. * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
  254. * with the object->lock held.
  255. */
  256. static void hex_dump_object(struct seq_file *seq,
  257. struct kmemleak_object *object)
  258. {
  259. const u8 *ptr = (const u8 *)object->pointer;
  260. int i, len, remaining;
  261. unsigned char linebuf[HEX_ROW_SIZE * 5];
  262. /* limit the number of lines to HEX_MAX_LINES */
  263. remaining = len =
  264. min(object->size, (size_t)(HEX_MAX_LINES * HEX_ROW_SIZE));
  265. seq_printf(seq, " hex dump (first %d bytes):\n", len);
  266. for (i = 0; i < len; i += HEX_ROW_SIZE) {
  267. int linelen = min(remaining, HEX_ROW_SIZE);
  268. remaining -= HEX_ROW_SIZE;
  269. hex_dump_to_buffer(ptr + i, linelen, HEX_ROW_SIZE,
  270. HEX_GROUP_SIZE, linebuf, sizeof(linebuf),
  271. HEX_ASCII);
  272. seq_printf(seq, " %s\n", linebuf);
  273. }
  274. }
  275. /*
  276. * Object colors, encoded with count and min_count:
  277. * - white - orphan object, not enough references to it (count < min_count)
  278. * - gray - not orphan, not marked as false positive (min_count == 0) or
  279. * sufficient references to it (count >= min_count)
  280. * - black - ignore, it doesn't contain references (e.g. text section)
  281. * (min_count == -1). No function defined for this color.
  282. * Newly created objects don't have any color assigned (object->count == -1)
  283. * before the next memory scan when they become white.
  284. */
  285. static bool color_white(const struct kmemleak_object *object)
  286. {
  287. return object->count != KMEMLEAK_BLACK &&
  288. object->count < object->min_count;
  289. }
  290. static bool color_gray(const struct kmemleak_object *object)
  291. {
  292. return object->min_count != KMEMLEAK_BLACK &&
  293. object->count >= object->min_count;
  294. }
  295. static bool color_black(const struct kmemleak_object *object)
  296. {
  297. return object->min_count == KMEMLEAK_BLACK;
  298. }
  299. /*
  300. * Objects are considered unreferenced only if their color is white, they have
  301. * not be deleted and have a minimum age to avoid false positives caused by
  302. * pointers temporarily stored in CPU registers.
  303. */
  304. static bool unreferenced_object(struct kmemleak_object *object)
  305. {
  306. return (object->flags & OBJECT_ALLOCATED) && color_white(object) &&
  307. time_before_eq(object->jiffies + jiffies_min_age,
  308. jiffies_last_scan);
  309. }
  310. /*
  311. * Printing of the unreferenced objects information to the seq file. The
  312. * print_unreferenced function must be called with the object->lock held.
  313. */
  314. static void print_unreferenced(struct seq_file *seq,
  315. struct kmemleak_object *object)
  316. {
  317. int i;
  318. seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
  319. object->pointer, object->size);
  320. seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu\n",
  321. object->comm, object->pid, object->jiffies);
  322. hex_dump_object(seq, object);
  323. seq_printf(seq, " backtrace:\n");
  324. for (i = 0; i < object->trace_len; i++) {
  325. void *ptr = (void *)object->trace[i];
  326. seq_printf(seq, " [<%p>] %pS\n", ptr, ptr);
  327. }
  328. }
  329. /*
  330. * Print the kmemleak_object information. This function is used mainly for
  331. * debugging special cases when kmemleak operations. It must be called with
  332. * the object->lock held.
  333. */
  334. static void dump_object_info(struct kmemleak_object *object)
  335. {
  336. struct stack_trace trace;
  337. trace.nr_entries = object->trace_len;
  338. trace.entries = object->trace;
  339. pr_notice("Object 0x%08lx (size %zu):\n",
  340. object->tree_node.start, object->size);
  341. pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
  342. object->comm, object->pid, object->jiffies);
  343. pr_notice(" min_count = %d\n", object->min_count);
  344. pr_notice(" count = %d\n", object->count);
  345. pr_notice(" flags = 0x%lx\n", object->flags);
  346. pr_notice(" backtrace:\n");
  347. print_stack_trace(&trace, 4);
  348. }
  349. /*
  350. * Look-up a memory block metadata (kmemleak_object) in the priority search
  351. * tree based on a pointer value. If alias is 0, only values pointing to the
  352. * beginning of the memory block are allowed. The kmemleak_lock must be held
  353. * when calling this function.
  354. */
  355. static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
  356. {
  357. struct prio_tree_node *node;
  358. struct prio_tree_iter iter;
  359. struct kmemleak_object *object;
  360. prio_tree_iter_init(&iter, &object_tree_root, ptr, ptr);
  361. node = prio_tree_next(&iter);
  362. if (node) {
  363. object = prio_tree_entry(node, struct kmemleak_object,
  364. tree_node);
  365. if (!alias && object->pointer != ptr) {
  366. kmemleak_warn("Found object by alias");
  367. object = NULL;
  368. }
  369. } else
  370. object = NULL;
  371. return object;
  372. }
  373. /*
  374. * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
  375. * that once an object's use_count reached 0, the RCU freeing was already
  376. * registered and the object should no longer be used. This function must be
  377. * called under the protection of rcu_read_lock().
  378. */
  379. static int get_object(struct kmemleak_object *object)
  380. {
  381. return atomic_inc_not_zero(&object->use_count);
  382. }
  383. /*
  384. * RCU callback to free a kmemleak_object.
  385. */
  386. static void free_object_rcu(struct rcu_head *rcu)
  387. {
  388. struct hlist_node *elem, *tmp;
  389. struct kmemleak_scan_area *area;
  390. struct kmemleak_object *object =
  391. container_of(rcu, struct kmemleak_object, rcu);
  392. /*
  393. * Once use_count is 0 (guaranteed by put_object), there is no other
  394. * code accessing this object, hence no need for locking.
  395. */
  396. hlist_for_each_entry_safe(area, elem, tmp, &object->area_list, node) {
  397. hlist_del(elem);
  398. kmem_cache_free(scan_area_cache, area);
  399. }
  400. kmem_cache_free(object_cache, object);
  401. }
  402. /*
  403. * Decrement the object use_count. Once the count is 0, free the object using
  404. * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
  405. * delete_object() path, the delayed RCU freeing ensures that there is no
  406. * recursive call to the kernel allocator. Lock-less RCU object_list traversal
  407. * is also possible.
  408. */
  409. static void put_object(struct kmemleak_object *object)
  410. {
  411. if (!atomic_dec_and_test(&object->use_count))
  412. return;
  413. /* should only get here after delete_object was called */
  414. WARN_ON(object->flags & OBJECT_ALLOCATED);
  415. call_rcu(&object->rcu, free_object_rcu);
  416. }
  417. /*
  418. * Look up an object in the prio search tree and increase its use_count.
  419. */
  420. static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
  421. {
  422. unsigned long flags;
  423. struct kmemleak_object *object = NULL;
  424. rcu_read_lock();
  425. read_lock_irqsave(&kmemleak_lock, flags);
  426. if (ptr >= min_addr && ptr < max_addr)
  427. object = lookup_object(ptr, alias);
  428. read_unlock_irqrestore(&kmemleak_lock, flags);
  429. /* check whether the object is still available */
  430. if (object && !get_object(object))
  431. object = NULL;
  432. rcu_read_unlock();
  433. return object;
  434. }
  435. /*
  436. * Save stack trace to the given array of MAX_TRACE size.
  437. */
  438. static int __save_stack_trace(unsigned long *trace)
  439. {
  440. struct stack_trace stack_trace;
  441. stack_trace.max_entries = MAX_TRACE;
  442. stack_trace.nr_entries = 0;
  443. stack_trace.entries = trace;
  444. stack_trace.skip = 2;
  445. save_stack_trace(&stack_trace);
  446. return stack_trace.nr_entries;
  447. }
  448. /*
  449. * Create the metadata (struct kmemleak_object) corresponding to an allocated
  450. * memory block and add it to the object_list and object_tree_root.
  451. */
  452. static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
  453. int min_count, gfp_t gfp)
  454. {
  455. unsigned long flags;
  456. struct kmemleak_object *object;
  457. struct prio_tree_node *node;
  458. object = kmem_cache_alloc(object_cache, gfp & GFP_KMEMLEAK_MASK);
  459. if (!object) {
  460. kmemleak_stop("Cannot allocate a kmemleak_object structure\n");
  461. return NULL;
  462. }
  463. INIT_LIST_HEAD(&object->object_list);
  464. INIT_LIST_HEAD(&object->gray_list);
  465. INIT_HLIST_HEAD(&object->area_list);
  466. spin_lock_init(&object->lock);
  467. atomic_set(&object->use_count, 1);
  468. object->flags = OBJECT_ALLOCATED | OBJECT_NEW;
  469. object->pointer = ptr;
  470. object->size = size;
  471. object->min_count = min_count;
  472. object->count = -1; /* no color initially */
  473. object->jiffies = jiffies;
  474. /* task information */
  475. if (in_irq()) {
  476. object->pid = 0;
  477. strncpy(object->comm, "hardirq", sizeof(object->comm));
  478. } else if (in_softirq()) {
  479. object->pid = 0;
  480. strncpy(object->comm, "softirq", sizeof(object->comm));
  481. } else {
  482. object->pid = current->pid;
  483. /*
  484. * There is a small chance of a race with set_task_comm(),
  485. * however using get_task_comm() here may cause locking
  486. * dependency issues with current->alloc_lock. In the worst
  487. * case, the command line is not correct.
  488. */
  489. strncpy(object->comm, current->comm, sizeof(object->comm));
  490. }
  491. /* kernel backtrace */
  492. object->trace_len = __save_stack_trace(object->trace);
  493. INIT_PRIO_TREE_NODE(&object->tree_node);
  494. object->tree_node.start = ptr;
  495. object->tree_node.last = ptr + size - 1;
  496. write_lock_irqsave(&kmemleak_lock, flags);
  497. min_addr = min(min_addr, ptr);
  498. max_addr = max(max_addr, ptr + size);
  499. node = prio_tree_insert(&object_tree_root, &object->tree_node);
  500. /*
  501. * The code calling the kernel does not yet have the pointer to the
  502. * memory block to be able to free it. However, we still hold the
  503. * kmemleak_lock here in case parts of the kernel started freeing
  504. * random memory blocks.
  505. */
  506. if (node != &object->tree_node) {
  507. kmemleak_stop("Cannot insert 0x%lx into the object search tree "
  508. "(already existing)\n", ptr);
  509. object = lookup_object(ptr, 1);
  510. spin_lock(&object->lock);
  511. dump_object_info(object);
  512. spin_unlock(&object->lock);
  513. goto out;
  514. }
  515. list_add_tail_rcu(&object->object_list, &object_list);
  516. out:
  517. write_unlock_irqrestore(&kmemleak_lock, flags);
  518. return object;
  519. }
  520. /*
  521. * Remove the metadata (struct kmemleak_object) for a memory block from the
  522. * object_list and object_tree_root and decrement its use_count.
  523. */
  524. static void __delete_object(struct kmemleak_object *object)
  525. {
  526. unsigned long flags;
  527. write_lock_irqsave(&kmemleak_lock, flags);
  528. prio_tree_remove(&object_tree_root, &object->tree_node);
  529. list_del_rcu(&object->object_list);
  530. write_unlock_irqrestore(&kmemleak_lock, flags);
  531. WARN_ON(!(object->flags & OBJECT_ALLOCATED));
  532. WARN_ON(atomic_read(&object->use_count) < 2);
  533. /*
  534. * Locking here also ensures that the corresponding memory block
  535. * cannot be freed when it is being scanned.
  536. */
  537. spin_lock_irqsave(&object->lock, flags);
  538. object->flags &= ~OBJECT_ALLOCATED;
  539. spin_unlock_irqrestore(&object->lock, flags);
  540. put_object(object);
  541. }
  542. /*
  543. * Look up the metadata (struct kmemleak_object) corresponding to ptr and
  544. * delete it.
  545. */
  546. static void delete_object_full(unsigned long ptr)
  547. {
  548. struct kmemleak_object *object;
  549. object = find_and_get_object(ptr, 0);
  550. if (!object) {
  551. #ifdef DEBUG
  552. kmemleak_warn("Freeing unknown object at 0x%08lx\n",
  553. ptr);
  554. #endif
  555. return;
  556. }
  557. __delete_object(object);
  558. put_object(object);
  559. }
  560. /*
  561. * Look up the metadata (struct kmemleak_object) corresponding to ptr and
  562. * delete it. If the memory block is partially freed, the function may create
  563. * additional metadata for the remaining parts of the block.
  564. */
  565. static void delete_object_part(unsigned long ptr, size_t size)
  566. {
  567. struct kmemleak_object *object;
  568. unsigned long start, end;
  569. object = find_and_get_object(ptr, 1);
  570. if (!object) {
  571. #ifdef DEBUG
  572. kmemleak_warn("Partially freeing unknown object at 0x%08lx "
  573. "(size %zu)\n", ptr, size);
  574. #endif
  575. return;
  576. }
  577. __delete_object(object);
  578. /*
  579. * Create one or two objects that may result from the memory block
  580. * split. Note that partial freeing is only done by free_bootmem() and
  581. * this happens before kmemleak_init() is called. The path below is
  582. * only executed during early log recording in kmemleak_init(), so
  583. * GFP_KERNEL is enough.
  584. */
  585. start = object->pointer;
  586. end = object->pointer + object->size;
  587. if (ptr > start)
  588. create_object(start, ptr - start, object->min_count,
  589. GFP_KERNEL);
  590. if (ptr + size < end)
  591. create_object(ptr + size, end - ptr - size, object->min_count,
  592. GFP_KERNEL);
  593. put_object(object);
  594. }
  595. static void __paint_it(struct kmemleak_object *object, int color)
  596. {
  597. object->min_count = color;
  598. if (color == KMEMLEAK_BLACK)
  599. object->flags |= OBJECT_NO_SCAN;
  600. }
  601. static void paint_it(struct kmemleak_object *object, int color)
  602. {
  603. unsigned long flags;
  604. spin_lock_irqsave(&object->lock, flags);
  605. __paint_it(object, color);
  606. spin_unlock_irqrestore(&object->lock, flags);
  607. }
  608. static void paint_ptr(unsigned long ptr, int color)
  609. {
  610. struct kmemleak_object *object;
  611. object = find_and_get_object(ptr, 0);
  612. if (!object) {
  613. kmemleak_warn("Trying to color unknown object "
  614. "at 0x%08lx as %s\n", ptr,
  615. (color == KMEMLEAK_GREY) ? "Grey" :
  616. (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
  617. return;
  618. }
  619. paint_it(object, color);
  620. put_object(object);
  621. }
  622. /*
  623. * Make a object permanently as gray-colored so that it can no longer be
  624. * reported as a leak. This is used in general to mark a false positive.
  625. */
  626. static void make_gray_object(unsigned long ptr)
  627. {
  628. paint_ptr(ptr, KMEMLEAK_GREY);
  629. }
  630. /*
  631. * Mark the object as black-colored so that it is ignored from scans and
  632. * reporting.
  633. */
  634. static void make_black_object(unsigned long ptr)
  635. {
  636. paint_ptr(ptr, KMEMLEAK_BLACK);
  637. }
  638. /*
  639. * Add a scanning area to the object. If at least one such area is added,
  640. * kmemleak will only scan these ranges rather than the whole memory block.
  641. */
  642. static void add_scan_area(unsigned long ptr, unsigned long offset,
  643. size_t length, gfp_t gfp)
  644. {
  645. unsigned long flags;
  646. struct kmemleak_object *object;
  647. struct kmemleak_scan_area *area;
  648. object = find_and_get_object(ptr, 0);
  649. if (!object) {
  650. kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
  651. ptr);
  652. return;
  653. }
  654. area = kmem_cache_alloc(scan_area_cache, gfp & GFP_KMEMLEAK_MASK);
  655. if (!area) {
  656. kmemleak_warn("Cannot allocate a scan area\n");
  657. goto out;
  658. }
  659. spin_lock_irqsave(&object->lock, flags);
  660. if (offset + length > object->size) {
  661. kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
  662. dump_object_info(object);
  663. kmem_cache_free(scan_area_cache, area);
  664. goto out_unlock;
  665. }
  666. INIT_HLIST_NODE(&area->node);
  667. area->offset = offset;
  668. area->length = length;
  669. hlist_add_head(&area->node, &object->area_list);
  670. out_unlock:
  671. spin_unlock_irqrestore(&object->lock, flags);
  672. out:
  673. put_object(object);
  674. }
  675. /*
  676. * Set the OBJECT_NO_SCAN flag for the object corresponding to the give
  677. * pointer. Such object will not be scanned by kmemleak but references to it
  678. * are searched.
  679. */
  680. static void object_no_scan(unsigned long ptr)
  681. {
  682. unsigned long flags;
  683. struct kmemleak_object *object;
  684. object = find_and_get_object(ptr, 0);
  685. if (!object) {
  686. kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
  687. return;
  688. }
  689. spin_lock_irqsave(&object->lock, flags);
  690. object->flags |= OBJECT_NO_SCAN;
  691. spin_unlock_irqrestore(&object->lock, flags);
  692. put_object(object);
  693. }
  694. /*
  695. * Log an early kmemleak_* call to the early_log buffer. These calls will be
  696. * processed later once kmemleak is fully initialized.
  697. */
  698. static void __init log_early(int op_type, const void *ptr, size_t size,
  699. int min_count, unsigned long offset, size_t length)
  700. {
  701. unsigned long flags;
  702. struct early_log *log;
  703. if (crt_early_log >= ARRAY_SIZE(early_log)) {
  704. pr_warning("Early log buffer exceeded\n");
  705. kmemleak_disable();
  706. return;
  707. }
  708. /*
  709. * There is no need for locking since the kernel is still in UP mode
  710. * at this stage. Disabling the IRQs is enough.
  711. */
  712. local_irq_save(flags);
  713. log = &early_log[crt_early_log];
  714. log->op_type = op_type;
  715. log->ptr = ptr;
  716. log->size = size;
  717. log->min_count = min_count;
  718. log->offset = offset;
  719. log->length = length;
  720. if (op_type == KMEMLEAK_ALLOC)
  721. log->trace_len = __save_stack_trace(log->trace);
  722. crt_early_log++;
  723. local_irq_restore(flags);
  724. }
  725. /*
  726. * Log an early allocated block and populate the stack trace.
  727. */
  728. static void early_alloc(struct early_log *log)
  729. {
  730. struct kmemleak_object *object;
  731. unsigned long flags;
  732. int i;
  733. if (!atomic_read(&kmemleak_enabled) || !log->ptr || IS_ERR(log->ptr))
  734. return;
  735. /*
  736. * RCU locking needed to ensure object is not freed via put_object().
  737. */
  738. rcu_read_lock();
  739. object = create_object((unsigned long)log->ptr, log->size,
  740. log->min_count, GFP_KERNEL);
  741. spin_lock_irqsave(&object->lock, flags);
  742. for (i = 0; i < log->trace_len; i++)
  743. object->trace[i] = log->trace[i];
  744. object->trace_len = log->trace_len;
  745. spin_unlock_irqrestore(&object->lock, flags);
  746. rcu_read_unlock();
  747. }
  748. /*
  749. * Memory allocation function callback. This function is called from the
  750. * kernel allocators when a new block is allocated (kmem_cache_alloc, kmalloc,
  751. * vmalloc etc.).
  752. */
  753. void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
  754. gfp_t gfp)
  755. {
  756. pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);
  757. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  758. create_object((unsigned long)ptr, size, min_count, gfp);
  759. else if (atomic_read(&kmemleak_early_log))
  760. log_early(KMEMLEAK_ALLOC, ptr, size, min_count, 0, 0);
  761. }
  762. EXPORT_SYMBOL_GPL(kmemleak_alloc);
  763. /*
  764. * Memory freeing function callback. This function is called from the kernel
  765. * allocators when a block is freed (kmem_cache_free, kfree, vfree etc.).
  766. */
  767. void __ref kmemleak_free(const void *ptr)
  768. {
  769. pr_debug("%s(0x%p)\n", __func__, ptr);
  770. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  771. delete_object_full((unsigned long)ptr);
  772. else if (atomic_read(&kmemleak_early_log))
  773. log_early(KMEMLEAK_FREE, ptr, 0, 0, 0, 0);
  774. }
  775. EXPORT_SYMBOL_GPL(kmemleak_free);
  776. /*
  777. * Partial memory freeing function callback. This function is usually called
  778. * from bootmem allocator when (part of) a memory block is freed.
  779. */
  780. void __ref kmemleak_free_part(const void *ptr, size_t size)
  781. {
  782. pr_debug("%s(0x%p)\n", __func__, ptr);
  783. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  784. delete_object_part((unsigned long)ptr, size);
  785. else if (atomic_read(&kmemleak_early_log))
  786. log_early(KMEMLEAK_FREE_PART, ptr, size, 0, 0, 0);
  787. }
  788. EXPORT_SYMBOL_GPL(kmemleak_free_part);
  789. /*
  790. * Mark an already allocated memory block as a false positive. This will cause
  791. * the block to no longer be reported as leak and always be scanned.
  792. */
  793. void __ref kmemleak_not_leak(const void *ptr)
  794. {
  795. pr_debug("%s(0x%p)\n", __func__, ptr);
  796. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  797. make_gray_object((unsigned long)ptr);
  798. else if (atomic_read(&kmemleak_early_log))
  799. log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0, 0, 0);
  800. }
  801. EXPORT_SYMBOL(kmemleak_not_leak);
  802. /*
  803. * Ignore a memory block. This is usually done when it is known that the
  804. * corresponding block is not a leak and does not contain any references to
  805. * other allocated memory blocks.
  806. */
  807. void __ref kmemleak_ignore(const void *ptr)
  808. {
  809. pr_debug("%s(0x%p)\n", __func__, ptr);
  810. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  811. make_black_object((unsigned long)ptr);
  812. else if (atomic_read(&kmemleak_early_log))
  813. log_early(KMEMLEAK_IGNORE, ptr, 0, 0, 0, 0);
  814. }
  815. EXPORT_SYMBOL(kmemleak_ignore);
  816. /*
  817. * Limit the range to be scanned in an allocated memory block.
  818. */
  819. void __ref kmemleak_scan_area(const void *ptr, unsigned long offset,
  820. size_t length, gfp_t gfp)
  821. {
  822. pr_debug("%s(0x%p)\n", __func__, ptr);
  823. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  824. add_scan_area((unsigned long)ptr, offset, length, gfp);
  825. else if (atomic_read(&kmemleak_early_log))
  826. log_early(KMEMLEAK_SCAN_AREA, ptr, 0, 0, offset, length);
  827. }
  828. EXPORT_SYMBOL(kmemleak_scan_area);
  829. /*
  830. * Inform kmemleak not to scan the given memory block.
  831. */
  832. void __ref kmemleak_no_scan(const void *ptr)
  833. {
  834. pr_debug("%s(0x%p)\n", __func__, ptr);
  835. if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  836. object_no_scan((unsigned long)ptr);
  837. else if (atomic_read(&kmemleak_early_log))
  838. log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0, 0, 0);
  839. }
  840. EXPORT_SYMBOL(kmemleak_no_scan);
  841. /*
  842. * Memory scanning is a long process and it needs to be interruptable. This
  843. * function checks whether such interrupt condition occured.
  844. */
  845. static int scan_should_stop(void)
  846. {
  847. if (!atomic_read(&kmemleak_enabled))
  848. return 1;
  849. /*
  850. * This function may be called from either process or kthread context,
  851. * hence the need to check for both stop conditions.
  852. */
  853. if (current->mm)
  854. return signal_pending(current);
  855. else
  856. return kthread_should_stop();
  857. return 0;
  858. }
  859. /*
  860. * Scan a memory block (exclusive range) for valid pointers and add those
  861. * found to the gray list.
  862. */
  863. static void scan_block(void *_start, void *_end,
  864. struct kmemleak_object *scanned, int allow_resched)
  865. {
  866. unsigned long *ptr;
  867. unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
  868. unsigned long *end = _end - (BYTES_PER_POINTER - 1);
  869. for (ptr = start; ptr < end; ptr++) {
  870. struct kmemleak_object *object;
  871. unsigned long flags;
  872. unsigned long pointer;
  873. if (allow_resched)
  874. cond_resched();
  875. if (scan_should_stop())
  876. break;
  877. /* don't scan uninitialized memory */
  878. if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
  879. BYTES_PER_POINTER))
  880. continue;
  881. pointer = *ptr;
  882. object = find_and_get_object(pointer, 1);
  883. if (!object)
  884. continue;
  885. if (object == scanned) {
  886. /* self referenced, ignore */
  887. put_object(object);
  888. continue;
  889. }
  890. /*
  891. * Avoid the lockdep recursive warning on object->lock being
  892. * previously acquired in scan_object(). These locks are
  893. * enclosed by scan_mutex.
  894. */
  895. spin_lock_irqsave_nested(&object->lock, flags,
  896. SINGLE_DEPTH_NESTING);
  897. if (!color_white(object)) {
  898. /* non-orphan, ignored or new */
  899. spin_unlock_irqrestore(&object->lock, flags);
  900. put_object(object);
  901. continue;
  902. }
  903. /*
  904. * Increase the object's reference count (number of pointers
  905. * to the memory block). If this count reaches the required
  906. * minimum, the object's color will become gray and it will be
  907. * added to the gray_list.
  908. */
  909. object->count++;
  910. if (color_gray(object))
  911. list_add_tail(&object->gray_list, &gray_list);
  912. else
  913. put_object(object);
  914. spin_unlock_irqrestore(&object->lock, flags);
  915. }
  916. }
  917. /*
  918. * Scan a memory block corresponding to a kmemleak_object. A condition is
  919. * that object->use_count >= 1.
  920. */
  921. static void scan_object(struct kmemleak_object *object)
  922. {
  923. struct kmemleak_scan_area *area;
  924. struct hlist_node *elem;
  925. unsigned long flags;
  926. /*
  927. * Once the object->lock is aquired, the corresponding memory block
  928. * cannot be freed (the same lock is aquired in delete_object).
  929. */
  930. spin_lock_irqsave(&object->lock, flags);
  931. if (object->flags & OBJECT_NO_SCAN)
  932. goto out;
  933. if (!(object->flags & OBJECT_ALLOCATED))
  934. /* already freed object */
  935. goto out;
  936. if (hlist_empty(&object->area_list)) {
  937. void *start = (void *)object->pointer;
  938. void *end = (void *)(object->pointer + object->size);
  939. while (start < end && (object->flags & OBJECT_ALLOCATED) &&
  940. !(object->flags & OBJECT_NO_SCAN)) {
  941. scan_block(start, min(start + MAX_SCAN_SIZE, end),
  942. object, 0);
  943. start += MAX_SCAN_SIZE;
  944. spin_unlock_irqrestore(&object->lock, flags);
  945. cond_resched();
  946. spin_lock_irqsave(&object->lock, flags);
  947. }
  948. } else
  949. hlist_for_each_entry(area, elem, &object->area_list, node)
  950. scan_block((void *)(object->pointer + area->offset),
  951. (void *)(object->pointer + area->offset
  952. + area->length), object, 0);
  953. out:
  954. spin_unlock_irqrestore(&object->lock, flags);
  955. }
  956. /*
  957. * Scan data sections and all the referenced memory blocks allocated via the
  958. * kernel's standard allocators. This function must be called with the
  959. * scan_mutex held.
  960. */
  961. static void kmemleak_scan(void)
  962. {
  963. unsigned long flags;
  964. struct kmemleak_object *object, *tmp;
  965. int i;
  966. int new_leaks = 0;
  967. int gray_list_pass = 0;
  968. jiffies_last_scan = jiffies;
  969. /* prepare the kmemleak_object's */
  970. rcu_read_lock();
  971. list_for_each_entry_rcu(object, &object_list, object_list) {
  972. spin_lock_irqsave(&object->lock, flags);
  973. #ifdef DEBUG
  974. /*
  975. * With a few exceptions there should be a maximum of
  976. * 1 reference to any object at this point.
  977. */
  978. if (atomic_read(&object->use_count) > 1) {
  979. pr_debug("object->use_count = %d\n",
  980. atomic_read(&object->use_count));
  981. dump_object_info(object);
  982. }
  983. #endif
  984. /* reset the reference count (whiten the object) */
  985. object->count = 0;
  986. object->flags &= ~OBJECT_NEW;
  987. if (color_gray(object) && get_object(object))
  988. list_add_tail(&object->gray_list, &gray_list);
  989. spin_unlock_irqrestore(&object->lock, flags);
  990. }
  991. rcu_read_unlock();
  992. /* data/bss scanning */
  993. scan_block(_sdata, _edata, NULL, 1);
  994. scan_block(__bss_start, __bss_stop, NULL, 1);
  995. #ifdef CONFIG_SMP
  996. /* per-cpu sections scanning */
  997. for_each_possible_cpu(i)
  998. scan_block(__per_cpu_start + per_cpu_offset(i),
  999. __per_cpu_end + per_cpu_offset(i), NULL, 1);
  1000. #endif
  1001. /*
  1002. * Struct page scanning for each node. The code below is not yet safe
  1003. * with MEMORY_HOTPLUG.
  1004. */
  1005. for_each_online_node(i) {
  1006. pg_data_t *pgdat = NODE_DATA(i);
  1007. unsigned long start_pfn = pgdat->node_start_pfn;
  1008. unsigned long end_pfn = start_pfn + pgdat->node_spanned_pages;
  1009. unsigned long pfn;
  1010. for (pfn = start_pfn; pfn < end_pfn; pfn++) {
  1011. struct page *page;
  1012. if (!pfn_valid(pfn))
  1013. continue;
  1014. page = pfn_to_page(pfn);
  1015. /* only scan if page is in use */
  1016. if (page_count(page) == 0)
  1017. continue;
  1018. scan_block(page, page + 1, NULL, 1);
  1019. }
  1020. }
  1021. /*
  1022. * Scanning the task stacks (may introduce false negatives).
  1023. */
  1024. if (kmemleak_stack_scan) {
  1025. struct task_struct *p, *g;
  1026. read_lock(&tasklist_lock);
  1027. do_each_thread(g, p) {
  1028. scan_block(task_stack_page(p), task_stack_page(p) +
  1029. THREAD_SIZE, NULL, 0);
  1030. } while_each_thread(g, p);
  1031. read_unlock(&tasklist_lock);
  1032. }
  1033. /*
  1034. * Scan the objects already referenced from the sections scanned
  1035. * above. More objects will be referenced and, if there are no memory
  1036. * leaks, all the objects will be scanned. The list traversal is safe
  1037. * for both tail additions and removals from inside the loop. The
  1038. * kmemleak objects cannot be freed from outside the loop because their
  1039. * use_count was increased.
  1040. */
  1041. repeat:
  1042. object = list_entry(gray_list.next, typeof(*object), gray_list);
  1043. while (&object->gray_list != &gray_list) {
  1044. cond_resched();
  1045. /* may add new objects to the list */
  1046. if (!scan_should_stop())
  1047. scan_object(object);
  1048. tmp = list_entry(object->gray_list.next, typeof(*object),
  1049. gray_list);
  1050. /* remove the object from the list and release it */
  1051. list_del(&object->gray_list);
  1052. put_object(object);
  1053. object = tmp;
  1054. }
  1055. if (scan_should_stop() || ++gray_list_pass >= GRAY_LIST_PASSES)
  1056. goto scan_end;
  1057. /*
  1058. * Check for new objects allocated during this scanning and add them
  1059. * to the gray list.
  1060. */
  1061. rcu_read_lock();
  1062. list_for_each_entry_rcu(object, &object_list, object_list) {
  1063. spin_lock_irqsave(&object->lock, flags);
  1064. if ((object->flags & OBJECT_NEW) && !color_black(object) &&
  1065. get_object(object)) {
  1066. object->flags &= ~OBJECT_NEW;
  1067. list_add_tail(&object->gray_list, &gray_list);
  1068. }
  1069. spin_unlock_irqrestore(&object->lock, flags);
  1070. }
  1071. rcu_read_unlock();
  1072. if (!list_empty(&gray_list))
  1073. goto repeat;
  1074. scan_end:
  1075. WARN_ON(!list_empty(&gray_list));
  1076. /*
  1077. * If scanning was stopped or new objects were being allocated at a
  1078. * higher rate than gray list scanning, do not report any new
  1079. * unreferenced objects.
  1080. */
  1081. if (scan_should_stop() || gray_list_pass >= GRAY_LIST_PASSES)
  1082. return;
  1083. /*
  1084. * Scanning result reporting.
  1085. */
  1086. rcu_read_lock();
  1087. list_for_each_entry_rcu(object, &object_list, object_list) {
  1088. spin_lock_irqsave(&object->lock, flags);
  1089. if (unreferenced_object(object) &&
  1090. !(object->flags & OBJECT_REPORTED)) {
  1091. object->flags |= OBJECT_REPORTED;
  1092. new_leaks++;
  1093. }
  1094. spin_unlock_irqrestore(&object->lock, flags);
  1095. }
  1096. rcu_read_unlock();
  1097. if (new_leaks)
  1098. pr_info("%d new suspected memory leaks (see "
  1099. "/sys/kernel/debug/kmemleak)\n", new_leaks);
  1100. }
  1101. /*
  1102. * Thread function performing automatic memory scanning. Unreferenced objects
  1103. * at the end of a memory scan are reported but only the first time.
  1104. */
  1105. static int kmemleak_scan_thread(void *arg)
  1106. {
  1107. static int first_run = 1;
  1108. pr_info("Automatic memory scanning thread started\n");
  1109. set_user_nice(current, 10);
  1110. /*
  1111. * Wait before the first scan to allow the system to fully initialize.
  1112. */
  1113. if (first_run) {
  1114. first_run = 0;
  1115. ssleep(SECS_FIRST_SCAN);
  1116. }
  1117. while (!kthread_should_stop()) {
  1118. signed long timeout = jiffies_scan_wait;
  1119. mutex_lock(&scan_mutex);
  1120. kmemleak_scan();
  1121. mutex_unlock(&scan_mutex);
  1122. /* wait before the next scan */
  1123. while (timeout && !kthread_should_stop())
  1124. timeout = schedule_timeout_interruptible(timeout);
  1125. }
  1126. pr_info("Automatic memory scanning thread ended\n");
  1127. return 0;
  1128. }
  1129. /*
  1130. * Start the automatic memory scanning thread. This function must be called
  1131. * with the scan_mutex held.
  1132. */
  1133. void start_scan_thread(void)
  1134. {
  1135. if (scan_thread)
  1136. return;
  1137. scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
  1138. if (IS_ERR(scan_thread)) {
  1139. pr_warning("Failed to create the scan thread\n");
  1140. scan_thread = NULL;
  1141. }
  1142. }
  1143. /*
  1144. * Stop the automatic memory scanning thread. This function must be called
  1145. * with the scan_mutex held.
  1146. */
  1147. void stop_scan_thread(void)
  1148. {
  1149. if (scan_thread) {
  1150. kthread_stop(scan_thread);
  1151. scan_thread = NULL;
  1152. }
  1153. }
  1154. /*
  1155. * Iterate over the object_list and return the first valid object at or after
  1156. * the required position with its use_count incremented. The function triggers
  1157. * a memory scanning when the pos argument points to the first position.
  1158. */
  1159. static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
  1160. {
  1161. struct kmemleak_object *object;
  1162. loff_t n = *pos;
  1163. int err;
  1164. err = mutex_lock_interruptible(&scan_mutex);
  1165. if (err < 0)
  1166. return ERR_PTR(err);
  1167. rcu_read_lock();
  1168. list_for_each_entry_rcu(object, &object_list, object_list) {
  1169. if (n-- > 0)
  1170. continue;
  1171. if (get_object(object))
  1172. goto out;
  1173. }
  1174. object = NULL;
  1175. out:
  1176. return object;
  1177. }
  1178. /*
  1179. * Return the next object in the object_list. The function decrements the
  1180. * use_count of the previous object and increases that of the next one.
  1181. */
  1182. static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
  1183. {
  1184. struct kmemleak_object *prev_obj = v;
  1185. struct kmemleak_object *next_obj = NULL;
  1186. struct list_head *n = &prev_obj->object_list;
  1187. ++(*pos);
  1188. list_for_each_continue_rcu(n, &object_list) {
  1189. next_obj = list_entry(n, struct kmemleak_object, object_list);
  1190. if (get_object(next_obj))
  1191. break;
  1192. }
  1193. put_object(prev_obj);
  1194. return next_obj;
  1195. }
  1196. /*
  1197. * Decrement the use_count of the last object required, if any.
  1198. */
  1199. static void kmemleak_seq_stop(struct seq_file *seq, void *v)
  1200. {
  1201. if (!IS_ERR(v)) {
  1202. /*
  1203. * kmemleak_seq_start may return ERR_PTR if the scan_mutex
  1204. * waiting was interrupted, so only release it if !IS_ERR.
  1205. */
  1206. rcu_read_unlock();
  1207. mutex_unlock(&scan_mutex);
  1208. if (v)
  1209. put_object(v);
  1210. }
  1211. }
  1212. /*
  1213. * Print the information for an unreferenced object to the seq file.
  1214. */
  1215. static int kmemleak_seq_show(struct seq_file *seq, void *v)
  1216. {
  1217. struct kmemleak_object *object = v;
  1218. unsigned long flags;
  1219. spin_lock_irqsave(&object->lock, flags);
  1220. if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
  1221. print_unreferenced(seq, object);
  1222. spin_unlock_irqrestore(&object->lock, flags);
  1223. return 0;
  1224. }
  1225. static const struct seq_operations kmemleak_seq_ops = {
  1226. .start = kmemleak_seq_start,
  1227. .next = kmemleak_seq_next,
  1228. .stop = kmemleak_seq_stop,
  1229. .show = kmemleak_seq_show,
  1230. };
  1231. static int kmemleak_open(struct inode *inode, struct file *file)
  1232. {
  1233. if (!atomic_read(&kmemleak_enabled))
  1234. return -EBUSY;
  1235. return seq_open(file, &kmemleak_seq_ops);
  1236. }
  1237. static int kmemleak_release(struct inode *inode, struct file *file)
  1238. {
  1239. return seq_release(inode, file);
  1240. }
  1241. static int dump_str_object_info(const char *str)
  1242. {
  1243. unsigned long flags;
  1244. struct kmemleak_object *object;
  1245. unsigned long addr;
  1246. addr= simple_strtoul(str, NULL, 0);
  1247. object = find_and_get_object(addr, 0);
  1248. if (!object) {
  1249. pr_info("Unknown object at 0x%08lx\n", addr);
  1250. return -EINVAL;
  1251. }
  1252. spin_lock_irqsave(&object->lock, flags);
  1253. dump_object_info(object);
  1254. spin_unlock_irqrestore(&object->lock, flags);
  1255. put_object(object);
  1256. return 0;
  1257. }
  1258. /*
  1259. * We use grey instead of black to ensure we can do future scans on the same
  1260. * objects. If we did not do future scans these black objects could
  1261. * potentially contain references to newly allocated objects in the future and
  1262. * we'd end up with false positives.
  1263. */
  1264. static void kmemleak_clear(void)
  1265. {
  1266. struct kmemleak_object *object;
  1267. unsigned long flags;
  1268. rcu_read_lock();
  1269. list_for_each_entry_rcu(object, &object_list, object_list) {
  1270. spin_lock_irqsave(&object->lock, flags);
  1271. if ((object->flags & OBJECT_REPORTED) &&
  1272. unreferenced_object(object))
  1273. __paint_it(object, KMEMLEAK_GREY);
  1274. spin_unlock_irqrestore(&object->lock, flags);
  1275. }
  1276. rcu_read_unlock();
  1277. }
  1278. /*
  1279. * File write operation to configure kmemleak at run-time. The following
  1280. * commands can be written to the /sys/kernel/debug/kmemleak file:
  1281. * off - disable kmemleak (irreversible)
  1282. * stack=on - enable the task stacks scanning
  1283. * stack=off - disable the tasks stacks scanning
  1284. * scan=on - start the automatic memory scanning thread
  1285. * scan=off - stop the automatic memory scanning thread
  1286. * scan=... - set the automatic memory scanning period in seconds (0 to
  1287. * disable it)
  1288. * scan - trigger a memory scan
  1289. * clear - mark all current reported unreferenced kmemleak objects as
  1290. * grey to ignore printing them
  1291. * dump=... - dump information about the object found at the given address
  1292. */
  1293. static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
  1294. size_t size, loff_t *ppos)
  1295. {
  1296. char buf[64];
  1297. int buf_size;
  1298. int ret;
  1299. buf_size = min(size, (sizeof(buf) - 1));
  1300. if (strncpy_from_user(buf, user_buf, buf_size) < 0)
  1301. return -EFAULT;
  1302. buf[buf_size] = 0;
  1303. ret = mutex_lock_interruptible(&scan_mutex);
  1304. if (ret < 0)
  1305. return ret;
  1306. if (strncmp(buf, "off", 3) == 0)
  1307. kmemleak_disable();
  1308. else if (strncmp(buf, "stack=on", 8) == 0)
  1309. kmemleak_stack_scan = 1;
  1310. else if (strncmp(buf, "stack=off", 9) == 0)
  1311. kmemleak_stack_scan = 0;
  1312. else if (strncmp(buf, "scan=on", 7) == 0)
  1313. start_scan_thread();
  1314. else if (strncmp(buf, "scan=off", 8) == 0)
  1315. stop_scan_thread();
  1316. else if (strncmp(buf, "scan=", 5) == 0) {
  1317. unsigned long secs;
  1318. ret = strict_strtoul(buf + 5, 0, &secs);
  1319. if (ret < 0)
  1320. goto out;
  1321. stop_scan_thread();
  1322. if (secs) {
  1323. jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
  1324. start_scan_thread();
  1325. }
  1326. } else if (strncmp(buf, "scan", 4) == 0)
  1327. kmemleak_scan();
  1328. else if (strncmp(buf, "clear", 5) == 0)
  1329. kmemleak_clear();
  1330. else if (strncmp(buf, "dump=", 5) == 0)
  1331. ret = dump_str_object_info(buf + 5);
  1332. else
  1333. ret = -EINVAL;
  1334. out:
  1335. mutex_unlock(&scan_mutex);
  1336. if (ret < 0)
  1337. return ret;
  1338. /* ignore the rest of the buffer, only one command at a time */
  1339. *ppos += size;
  1340. return size;
  1341. }
  1342. static const struct file_operations kmemleak_fops = {
  1343. .owner = THIS_MODULE,
  1344. .open = kmemleak_open,
  1345. .read = seq_read,
  1346. .write = kmemleak_write,
  1347. .llseek = seq_lseek,
  1348. .release = kmemleak_release,
  1349. };
  1350. /*
  1351. * Perform the freeing of the kmemleak internal objects after waiting for any
  1352. * current memory scan to complete.
  1353. */
  1354. static void kmemleak_do_cleanup(struct work_struct *work)
  1355. {
  1356. struct kmemleak_object *object;
  1357. mutex_lock(&scan_mutex);
  1358. stop_scan_thread();
  1359. rcu_read_lock();
  1360. list_for_each_entry_rcu(object, &object_list, object_list)
  1361. delete_object_full(object->pointer);
  1362. rcu_read_unlock();
  1363. mutex_unlock(&scan_mutex);
  1364. }
  1365. static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
  1366. /*
  1367. * Disable kmemleak. No memory allocation/freeing will be traced once this
  1368. * function is called. Disabling kmemleak is an irreversible operation.
  1369. */
  1370. static void kmemleak_disable(void)
  1371. {
  1372. /* atomically check whether it was already invoked */
  1373. if (atomic_cmpxchg(&kmemleak_error, 0, 1))
  1374. return;
  1375. /* stop any memory operation tracing */
  1376. atomic_set(&kmemleak_early_log, 0);
  1377. atomic_set(&kmemleak_enabled, 0);
  1378. /* check whether it is too early for a kernel thread */
  1379. if (atomic_read(&kmemleak_initialized))
  1380. schedule_work(&cleanup_work);
  1381. pr_info("Kernel memory leak detector disabled\n");
  1382. }
  1383. /*
  1384. * Allow boot-time kmemleak disabling (enabled by default).
  1385. */
  1386. static int kmemleak_boot_config(char *str)
  1387. {
  1388. if (!str)
  1389. return -EINVAL;
  1390. if (strcmp(str, "off") == 0)
  1391. kmemleak_disable();
  1392. else if (strcmp(str, "on") != 0)
  1393. return -EINVAL;
  1394. return 0;
  1395. }
  1396. early_param("kmemleak", kmemleak_boot_config);
  1397. /*
  1398. * Kmemleak initialization.
  1399. */
  1400. void __init kmemleak_init(void)
  1401. {
  1402. int i;
  1403. unsigned long flags;
  1404. jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
  1405. jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);
  1406. object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
  1407. scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
  1408. INIT_PRIO_TREE_ROOT(&object_tree_root);
  1409. /* the kernel is still in UP mode, so disabling the IRQs is enough */
  1410. local_irq_save(flags);
  1411. if (!atomic_read(&kmemleak_error)) {
  1412. atomic_set(&kmemleak_enabled, 1);
  1413. atomic_set(&kmemleak_early_log, 0);
  1414. }
  1415. local_irq_restore(flags);
  1416. /*
  1417. * This is the point where tracking allocations is safe. Automatic
  1418. * scanning is started during the late initcall. Add the early logged
  1419. * callbacks to the kmemleak infrastructure.
  1420. */
  1421. for (i = 0; i < crt_early_log; i++) {
  1422. struct early_log *log = &early_log[i];
  1423. switch (log->op_type) {
  1424. case KMEMLEAK_ALLOC:
  1425. early_alloc(log);
  1426. break;
  1427. case KMEMLEAK_FREE:
  1428. kmemleak_free(log->ptr);
  1429. break;
  1430. case KMEMLEAK_FREE_PART:
  1431. kmemleak_free_part(log->ptr, log->size);
  1432. break;
  1433. case KMEMLEAK_NOT_LEAK:
  1434. kmemleak_not_leak(log->ptr);
  1435. break;
  1436. case KMEMLEAK_IGNORE:
  1437. kmemleak_ignore(log->ptr);
  1438. break;
  1439. case KMEMLEAK_SCAN_AREA:
  1440. kmemleak_scan_area(log->ptr, log->offset, log->length,
  1441. GFP_KERNEL);
  1442. break;
  1443. case KMEMLEAK_NO_SCAN:
  1444. kmemleak_no_scan(log->ptr);
  1445. break;
  1446. default:
  1447. WARN_ON(1);
  1448. }
  1449. }
  1450. }
  1451. /*
  1452. * Late initialization function.
  1453. */
  1454. static int __init kmemleak_late_init(void)
  1455. {
  1456. struct dentry *dentry;
  1457. atomic_set(&kmemleak_initialized, 1);
  1458. if (atomic_read(&kmemleak_error)) {
  1459. /*
  1460. * Some error occured and kmemleak was disabled. There is a
  1461. * small chance that kmemleak_disable() was called immediately
  1462. * after setting kmemleak_initialized and we may end up with
  1463. * two clean-up threads but serialized by scan_mutex.
  1464. */
  1465. schedule_work(&cleanup_work);
  1466. return -ENOMEM;
  1467. }
  1468. dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
  1469. &kmemleak_fops);
  1470. if (!dentry)
  1471. pr_warning("Failed to create the debugfs kmemleak file\n");
  1472. mutex_lock(&scan_mutex);
  1473. start_scan_thread();
  1474. mutex_unlock(&scan_mutex);
  1475. pr_info("Kernel memory leak detector initialized\n");
  1476. return 0;
  1477. }
  1478. late_initcall(kmemleak_late_init);