Loading...
1/*
2 * drivers/base/devres.c - device resource management
3 *
4 * Copyright (c) 2006 SUSE Linux Products GmbH
5 * Copyright (c) 2006 Tejun Heo <teheo@suse.de>
6 *
7 * This file is released under the GPLv2.
8 */
9
10#include <linux/device.h>
11#include <linux/module.h>
12#include <linux/slab.h>
13#include <linux/percpu.h>
14
15#include "base.h"
16
17struct devres_node {
18 struct list_head entry;
19 dr_release_t release;
20#ifdef CONFIG_DEBUG_DEVRES
21 const char *name;
22 size_t size;
23#endif
24};
25
26struct devres {
27 struct devres_node node;
28 /* -- 3 pointers */
29 unsigned long long data[]; /* guarantee ull alignment */
30};
31
32struct devres_group {
33 struct devres_node node[2];
34 void *id;
35 int color;
36 /* -- 8 pointers */
37};
38
39#ifdef CONFIG_DEBUG_DEVRES
40static int log_devres = 0;
41module_param_named(log, log_devres, int, S_IRUGO | S_IWUSR);
42
43static void set_node_dbginfo(struct devres_node *node, const char *name,
44 size_t size)
45{
46 node->name = name;
47 node->size = size;
48}
49
50static void devres_log(struct device *dev, struct devres_node *node,
51 const char *op)
52{
53 if (unlikely(log_devres))
54 dev_err(dev, "DEVRES %3s %p %s (%lu bytes)\n",
55 op, node, node->name, (unsigned long)node->size);
56}
57#else /* CONFIG_DEBUG_DEVRES */
58#define set_node_dbginfo(node, n, s) do {} while (0)
59#define devres_log(dev, node, op) do {} while (0)
60#endif /* CONFIG_DEBUG_DEVRES */
61
62/*
63 * Release functions for devres group. These callbacks are used only
64 * for identification.
65 */
66static void group_open_release(struct device *dev, void *res)
67{
68 /* noop */
69}
70
71static void group_close_release(struct device *dev, void *res)
72{
73 /* noop */
74}
75
76static struct devres_group * node_to_group(struct devres_node *node)
77{
78 if (node->release == &group_open_release)
79 return container_of(node, struct devres_group, node[0]);
80 if (node->release == &group_close_release)
81 return container_of(node, struct devres_group, node[1]);
82 return NULL;
83}
84
85static __always_inline struct devres * alloc_dr(dr_release_t release,
86 size_t size, gfp_t gfp, int nid)
87{
88 size_t tot_size = sizeof(struct devres) + size;
89 struct devres *dr;
90
91 dr = kmalloc_node_track_caller(tot_size, gfp, nid);
92 if (unlikely(!dr))
93 return NULL;
94
95 memset(dr, 0, offsetof(struct devres, data));
96
97 INIT_LIST_HEAD(&dr->node.entry);
98 dr->node.release = release;
99 return dr;
100}
101
102static void add_dr(struct device *dev, struct devres_node *node)
103{
104 devres_log(dev, node, "ADD");
105 BUG_ON(!list_empty(&node->entry));
106 list_add_tail(&node->entry, &dev->devres_head);
107}
108
109#ifdef CONFIG_DEBUG_DEVRES
110void * __devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid,
111 const char *name)
112{
113 struct devres *dr;
114
115 dr = alloc_dr(release, size, gfp | __GFP_ZERO, nid);
116 if (unlikely(!dr))
117 return NULL;
118 set_node_dbginfo(&dr->node, name, size);
119 return dr->data;
120}
121EXPORT_SYMBOL_GPL(__devres_alloc_node);
122#else
123/**
124 * devres_alloc - Allocate device resource data
125 * @release: Release function devres will be associated with
126 * @size: Allocation size
127 * @gfp: Allocation flags
128 * @nid: NUMA node
129 *
130 * Allocate devres of @size bytes. The allocated area is zeroed, then
131 * associated with @release. The returned pointer can be passed to
132 * other devres_*() functions.
133 *
134 * RETURNS:
135 * Pointer to allocated devres on success, NULL on failure.
136 */
137void * devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid)
138{
139 struct devres *dr;
140
141 dr = alloc_dr(release, size, gfp | __GFP_ZERO, nid);
142 if (unlikely(!dr))
143 return NULL;
144 return dr->data;
145}
146EXPORT_SYMBOL_GPL(devres_alloc_node);
147#endif
148
149/**
150 * devres_for_each_res - Resource iterator
151 * @dev: Device to iterate resource from
152 * @release: Look for resources associated with this release function
153 * @match: Match function (optional)
154 * @match_data: Data for the match function
155 * @fn: Function to be called for each matched resource.
156 * @data: Data for @fn, the 3rd parameter of @fn
157 *
158 * Call @fn for each devres of @dev which is associated with @release
159 * and for which @match returns 1.
160 *
161 * RETURNS:
162 * void
163 */
164void devres_for_each_res(struct device *dev, dr_release_t release,
165 dr_match_t match, void *match_data,
166 void (*fn)(struct device *, void *, void *),
167 void *data)
168{
169 struct devres_node *node;
170 struct devres_node *tmp;
171 unsigned long flags;
172
173 if (!fn)
174 return;
175
176 spin_lock_irqsave(&dev->devres_lock, flags);
177 list_for_each_entry_safe_reverse(node, tmp,
178 &dev->devres_head, entry) {
179 struct devres *dr = container_of(node, struct devres, node);
180
181 if (node->release != release)
182 continue;
183 if (match && !match(dev, dr->data, match_data))
184 continue;
185 fn(dev, dr->data, data);
186 }
187 spin_unlock_irqrestore(&dev->devres_lock, flags);
188}
189EXPORT_SYMBOL_GPL(devres_for_each_res);
190
191/**
192 * devres_free - Free device resource data
193 * @res: Pointer to devres data to free
194 *
195 * Free devres created with devres_alloc().
196 */
197void devres_free(void *res)
198{
199 if (res) {
200 struct devres *dr = container_of(res, struct devres, data);
201
202 BUG_ON(!list_empty(&dr->node.entry));
203 kfree(dr);
204 }
205}
206EXPORT_SYMBOL_GPL(devres_free);
207
208/**
209 * devres_add - Register device resource
210 * @dev: Device to add resource to
211 * @res: Resource to register
212 *
213 * Register devres @res to @dev. @res should have been allocated
214 * using devres_alloc(). On driver detach, the associated release
215 * function will be invoked and devres will be freed automatically.
216 */
217void devres_add(struct device *dev, void *res)
218{
219 struct devres *dr = container_of(res, struct devres, data);
220 unsigned long flags;
221
222 spin_lock_irqsave(&dev->devres_lock, flags);
223 add_dr(dev, &dr->node);
224 spin_unlock_irqrestore(&dev->devres_lock, flags);
225}
226EXPORT_SYMBOL_GPL(devres_add);
227
228static struct devres *find_dr(struct device *dev, dr_release_t release,
229 dr_match_t match, void *match_data)
230{
231 struct devres_node *node;
232
233 list_for_each_entry_reverse(node, &dev->devres_head, entry) {
234 struct devres *dr = container_of(node, struct devres, node);
235
236 if (node->release != release)
237 continue;
238 if (match && !match(dev, dr->data, match_data))
239 continue;
240 return dr;
241 }
242
243 return NULL;
244}
245
246/**
247 * devres_find - Find device resource
248 * @dev: Device to lookup resource from
249 * @release: Look for resources associated with this release function
250 * @match: Match function (optional)
251 * @match_data: Data for the match function
252 *
253 * Find the latest devres of @dev which is associated with @release
254 * and for which @match returns 1. If @match is NULL, it's considered
255 * to match all.
256 *
257 * RETURNS:
258 * Pointer to found devres, NULL if not found.
259 */
260void * devres_find(struct device *dev, dr_release_t release,
261 dr_match_t match, void *match_data)
262{
263 struct devres *dr;
264 unsigned long flags;
265
266 spin_lock_irqsave(&dev->devres_lock, flags);
267 dr = find_dr(dev, release, match, match_data);
268 spin_unlock_irqrestore(&dev->devres_lock, flags);
269
270 if (dr)
271 return dr->data;
272 return NULL;
273}
274EXPORT_SYMBOL_GPL(devres_find);
275
276/**
277 * devres_get - Find devres, if non-existent, add one atomically
278 * @dev: Device to lookup or add devres for
279 * @new_res: Pointer to new initialized devres to add if not found
280 * @match: Match function (optional)
281 * @match_data: Data for the match function
282 *
283 * Find the latest devres of @dev which has the same release function
284 * as @new_res and for which @match return 1. If found, @new_res is
285 * freed; otherwise, @new_res is added atomically.
286 *
287 * RETURNS:
288 * Pointer to found or added devres.
289 */
290void * devres_get(struct device *dev, void *new_res,
291 dr_match_t match, void *match_data)
292{
293 struct devres *new_dr = container_of(new_res, struct devres, data);
294 struct devres *dr;
295 unsigned long flags;
296
297 spin_lock_irqsave(&dev->devres_lock, flags);
298 dr = find_dr(dev, new_dr->node.release, match, match_data);
299 if (!dr) {
300 add_dr(dev, &new_dr->node);
301 dr = new_dr;
302 new_res = NULL;
303 }
304 spin_unlock_irqrestore(&dev->devres_lock, flags);
305 devres_free(new_res);
306
307 return dr->data;
308}
309EXPORT_SYMBOL_GPL(devres_get);
310
311/**
312 * devres_remove - Find a device resource and remove it
313 * @dev: Device to find resource from
314 * @release: Look for resources associated with this release function
315 * @match: Match function (optional)
316 * @match_data: Data for the match function
317 *
318 * Find the latest devres of @dev associated with @release and for
319 * which @match returns 1. If @match is NULL, it's considered to
320 * match all. If found, the resource is removed atomically and
321 * returned.
322 *
323 * RETURNS:
324 * Pointer to removed devres on success, NULL if not found.
325 */
326void * devres_remove(struct device *dev, dr_release_t release,
327 dr_match_t match, void *match_data)
328{
329 struct devres *dr;
330 unsigned long flags;
331
332 spin_lock_irqsave(&dev->devres_lock, flags);
333 dr = find_dr(dev, release, match, match_data);
334 if (dr) {
335 list_del_init(&dr->node.entry);
336 devres_log(dev, &dr->node, "REM");
337 }
338 spin_unlock_irqrestore(&dev->devres_lock, flags);
339
340 if (dr)
341 return dr->data;
342 return NULL;
343}
344EXPORT_SYMBOL_GPL(devres_remove);
345
346/**
347 * devres_destroy - Find a device resource and destroy it
348 * @dev: Device to find resource from
349 * @release: Look for resources associated with this release function
350 * @match: Match function (optional)
351 * @match_data: Data for the match function
352 *
353 * Find the latest devres of @dev associated with @release and for
354 * which @match returns 1. If @match is NULL, it's considered to
355 * match all. If found, the resource is removed atomically and freed.
356 *
357 * Note that the release function for the resource will not be called,
358 * only the devres-allocated data will be freed. The caller becomes
359 * responsible for freeing any other data.
360 *
361 * RETURNS:
362 * 0 if devres is found and freed, -ENOENT if not found.
363 */
364int devres_destroy(struct device *dev, dr_release_t release,
365 dr_match_t match, void *match_data)
366{
367 void *res;
368
369 res = devres_remove(dev, release, match, match_data);
370 if (unlikely(!res))
371 return -ENOENT;
372
373 devres_free(res);
374 return 0;
375}
376EXPORT_SYMBOL_GPL(devres_destroy);
377
378
379/**
380 * devres_release - Find a device resource and destroy it, calling release
381 * @dev: Device to find resource from
382 * @release: Look for resources associated with this release function
383 * @match: Match function (optional)
384 * @match_data: Data for the match function
385 *
386 * Find the latest devres of @dev associated with @release and for
387 * which @match returns 1. If @match is NULL, it's considered to
388 * match all. If found, the resource is removed atomically, the
389 * release function called and the resource freed.
390 *
391 * RETURNS:
392 * 0 if devres is found and freed, -ENOENT if not found.
393 */
394int devres_release(struct device *dev, dr_release_t release,
395 dr_match_t match, void *match_data)
396{
397 void *res;
398
399 res = devres_remove(dev, release, match, match_data);
400 if (unlikely(!res))
401 return -ENOENT;
402
403 (*release)(dev, res);
404 devres_free(res);
405 return 0;
406}
407EXPORT_SYMBOL_GPL(devres_release);
408
409static int remove_nodes(struct device *dev,
410 struct list_head *first, struct list_head *end,
411 struct list_head *todo)
412{
413 int cnt = 0, nr_groups = 0;
414 struct list_head *cur;
415
416 /* First pass - move normal devres entries to @todo and clear
417 * devres_group colors.
418 */
419 cur = first;
420 while (cur != end) {
421 struct devres_node *node;
422 struct devres_group *grp;
423
424 node = list_entry(cur, struct devres_node, entry);
425 cur = cur->next;
426
427 grp = node_to_group(node);
428 if (grp) {
429 /* clear color of group markers in the first pass */
430 grp->color = 0;
431 nr_groups++;
432 } else {
433 /* regular devres entry */
434 if (&node->entry == first)
435 first = first->next;
436 list_move_tail(&node->entry, todo);
437 cnt++;
438 }
439 }
440
441 if (!nr_groups)
442 return cnt;
443
444 /* Second pass - Scan groups and color them. A group gets
445 * color value of two iff the group is wholly contained in
446 * [cur, end). That is, for a closed group, both opening and
447 * closing markers should be in the range, while just the
448 * opening marker is enough for an open group.
449 */
450 cur = first;
451 while (cur != end) {
452 struct devres_node *node;
453 struct devres_group *grp;
454
455 node = list_entry(cur, struct devres_node, entry);
456 cur = cur->next;
457
458 grp = node_to_group(node);
459 BUG_ON(!grp || list_empty(&grp->node[0].entry));
460
461 grp->color++;
462 if (list_empty(&grp->node[1].entry))
463 grp->color++;
464
465 BUG_ON(grp->color <= 0 || grp->color > 2);
466 if (grp->color == 2) {
467 /* No need to update cur or end. The removed
468 * nodes are always before both.
469 */
470 list_move_tail(&grp->node[0].entry, todo);
471 list_del_init(&grp->node[1].entry);
472 }
473 }
474
475 return cnt;
476}
477
478static int release_nodes(struct device *dev, struct list_head *first,
479 struct list_head *end, unsigned long flags)
480 __releases(&dev->devres_lock)
481{
482 LIST_HEAD(todo);
483 int cnt;
484 struct devres *dr, *tmp;
485
486 cnt = remove_nodes(dev, first, end, &todo);
487
488 spin_unlock_irqrestore(&dev->devres_lock, flags);
489
490 /* Release. Note that both devres and devres_group are
491 * handled as devres in the following loop. This is safe.
492 */
493 list_for_each_entry_safe_reverse(dr, tmp, &todo, node.entry) {
494 devres_log(dev, &dr->node, "REL");
495 dr->node.release(dev, dr->data);
496 kfree(dr);
497 }
498
499 return cnt;
500}
501
502/**
503 * devres_release_all - Release all managed resources
504 * @dev: Device to release resources for
505 *
506 * Release all resources associated with @dev. This function is
507 * called on driver detach.
508 */
509int devres_release_all(struct device *dev)
510{
511 unsigned long flags;
512
513 /* Looks like an uninitialized device structure */
514 if (WARN_ON(dev->devres_head.next == NULL))
515 return -ENODEV;
516 spin_lock_irqsave(&dev->devres_lock, flags);
517 return release_nodes(dev, dev->devres_head.next, &dev->devres_head,
518 flags);
519}
520
521/**
522 * devres_open_group - Open a new devres group
523 * @dev: Device to open devres group for
524 * @id: Separator ID
525 * @gfp: Allocation flags
526 *
527 * Open a new devres group for @dev with @id. For @id, using a
528 * pointer to an object which won't be used for another group is
529 * recommended. If @id is NULL, address-wise unique ID is created.
530 *
531 * RETURNS:
532 * ID of the new group, NULL on failure.
533 */
534void * devres_open_group(struct device *dev, void *id, gfp_t gfp)
535{
536 struct devres_group *grp;
537 unsigned long flags;
538
539 grp = kmalloc(sizeof(*grp), gfp);
540 if (unlikely(!grp))
541 return NULL;
542
543 grp->node[0].release = &group_open_release;
544 grp->node[1].release = &group_close_release;
545 INIT_LIST_HEAD(&grp->node[0].entry);
546 INIT_LIST_HEAD(&grp->node[1].entry);
547 set_node_dbginfo(&grp->node[0], "grp<", 0);
548 set_node_dbginfo(&grp->node[1], "grp>", 0);
549 grp->id = grp;
550 if (id)
551 grp->id = id;
552
553 spin_lock_irqsave(&dev->devres_lock, flags);
554 add_dr(dev, &grp->node[0]);
555 spin_unlock_irqrestore(&dev->devres_lock, flags);
556 return grp->id;
557}
558EXPORT_SYMBOL_GPL(devres_open_group);
559
560/* Find devres group with ID @id. If @id is NULL, look for the latest. */
561static struct devres_group * find_group(struct device *dev, void *id)
562{
563 struct devres_node *node;
564
565 list_for_each_entry_reverse(node, &dev->devres_head, entry) {
566 struct devres_group *grp;
567
568 if (node->release != &group_open_release)
569 continue;
570
571 grp = container_of(node, struct devres_group, node[0]);
572
573 if (id) {
574 if (grp->id == id)
575 return grp;
576 } else if (list_empty(&grp->node[1].entry))
577 return grp;
578 }
579
580 return NULL;
581}
582
583/**
584 * devres_close_group - Close a devres group
585 * @dev: Device to close devres group for
586 * @id: ID of target group, can be NULL
587 *
588 * Close the group identified by @id. If @id is NULL, the latest open
589 * group is selected.
590 */
591void devres_close_group(struct device *dev, void *id)
592{
593 struct devres_group *grp;
594 unsigned long flags;
595
596 spin_lock_irqsave(&dev->devres_lock, flags);
597
598 grp = find_group(dev, id);
599 if (grp)
600 add_dr(dev, &grp->node[1]);
601 else
602 WARN_ON(1);
603
604 spin_unlock_irqrestore(&dev->devres_lock, flags);
605}
606EXPORT_SYMBOL_GPL(devres_close_group);
607
608/**
609 * devres_remove_group - Remove a devres group
610 * @dev: Device to remove group for
611 * @id: ID of target group, can be NULL
612 *
613 * Remove the group identified by @id. If @id is NULL, the latest
614 * open group is selected. Note that removing a group doesn't affect
615 * any other resources.
616 */
617void devres_remove_group(struct device *dev, void *id)
618{
619 struct devres_group *grp;
620 unsigned long flags;
621
622 spin_lock_irqsave(&dev->devres_lock, flags);
623
624 grp = find_group(dev, id);
625 if (grp) {
626 list_del_init(&grp->node[0].entry);
627 list_del_init(&grp->node[1].entry);
628 devres_log(dev, &grp->node[0], "REM");
629 } else
630 WARN_ON(1);
631
632 spin_unlock_irqrestore(&dev->devres_lock, flags);
633
634 kfree(grp);
635}
636EXPORT_SYMBOL_GPL(devres_remove_group);
637
638/**
639 * devres_release_group - Release resources in a devres group
640 * @dev: Device to release group for
641 * @id: ID of target group, can be NULL
642 *
643 * Release all resources in the group identified by @id. If @id is
644 * NULL, the latest open group is selected. The selected group and
645 * groups properly nested inside the selected group are removed.
646 *
647 * RETURNS:
648 * The number of released non-group resources.
649 */
650int devres_release_group(struct device *dev, void *id)
651{
652 struct devres_group *grp;
653 unsigned long flags;
654 int cnt = 0;
655
656 spin_lock_irqsave(&dev->devres_lock, flags);
657
658 grp = find_group(dev, id);
659 if (grp) {
660 struct list_head *first = &grp->node[0].entry;
661 struct list_head *end = &dev->devres_head;
662
663 if (!list_empty(&grp->node[1].entry))
664 end = grp->node[1].entry.next;
665
666 cnt = release_nodes(dev, first, end, flags);
667 } else {
668 WARN_ON(1);
669 spin_unlock_irqrestore(&dev->devres_lock, flags);
670 }
671
672 return cnt;
673}
674EXPORT_SYMBOL_GPL(devres_release_group);
675
676/*
677 * Custom devres actions allow inserting a simple function call
678 * into the teadown sequence.
679 */
680
681struct action_devres {
682 void *data;
683 void (*action)(void *);
684};
685
686static int devm_action_match(struct device *dev, void *res, void *p)
687{
688 struct action_devres *devres = res;
689 struct action_devres *target = p;
690
691 return devres->action == target->action &&
692 devres->data == target->data;
693}
694
695static void devm_action_release(struct device *dev, void *res)
696{
697 struct action_devres *devres = res;
698
699 devres->action(devres->data);
700}
701
702/**
703 * devm_add_action() - add a custom action to list of managed resources
704 * @dev: Device that owns the action
705 * @action: Function that should be called
706 * @data: Pointer to data passed to @action implementation
707 *
708 * This adds a custom action to the list of managed resources so that
709 * it gets executed as part of standard resource unwinding.
710 */
711int devm_add_action(struct device *dev, void (*action)(void *), void *data)
712{
713 struct action_devres *devres;
714
715 devres = devres_alloc(devm_action_release,
716 sizeof(struct action_devres), GFP_KERNEL);
717 if (!devres)
718 return -ENOMEM;
719
720 devres->data = data;
721 devres->action = action;
722
723 devres_add(dev, devres);
724 return 0;
725}
726EXPORT_SYMBOL_GPL(devm_add_action);
727
728/**
729 * devm_remove_action() - removes previously added custom action
730 * @dev: Device that owns the action
731 * @action: Function implementing the action
732 * @data: Pointer to data passed to @action implementation
733 *
734 * Removes instance of @action previously added by devm_add_action().
735 * Both action and data should match one of the existing entries.
736 */
737void devm_remove_action(struct device *dev, void (*action)(void *), void *data)
738{
739 struct action_devres devres = {
740 .data = data,
741 .action = action,
742 };
743
744 WARN_ON(devres_destroy(dev, devm_action_release, devm_action_match,
745 &devres));
746
747}
748EXPORT_SYMBOL_GPL(devm_remove_action);
749
750/*
751 * Managed kmalloc/kfree
752 */
753static void devm_kmalloc_release(struct device *dev, void *res)
754{
755 /* noop */
756}
757
758static int devm_kmalloc_match(struct device *dev, void *res, void *data)
759{
760 return res == data;
761}
762
763/**
764 * devm_kmalloc - Resource-managed kmalloc
765 * @dev: Device to allocate memory for
766 * @size: Allocation size
767 * @gfp: Allocation gfp flags
768 *
769 * Managed kmalloc. Memory allocated with this function is
770 * automatically freed on driver detach. Like all other devres
771 * resources, guaranteed alignment is unsigned long long.
772 *
773 * RETURNS:
774 * Pointer to allocated memory on success, NULL on failure.
775 */
776void * devm_kmalloc(struct device *dev, size_t size, gfp_t gfp)
777{
778 struct devres *dr;
779
780 /* use raw alloc_dr for kmalloc caller tracing */
781 dr = alloc_dr(devm_kmalloc_release, size, gfp, dev_to_node(dev));
782 if (unlikely(!dr))
783 return NULL;
784
785 /*
786 * This is named devm_kzalloc_release for historical reasons
787 * The initial implementation did not support kmalloc, only kzalloc
788 */
789 set_node_dbginfo(&dr->node, "devm_kzalloc_release", size);
790 devres_add(dev, dr->data);
791 return dr->data;
792}
793EXPORT_SYMBOL_GPL(devm_kmalloc);
794
795/**
796 * devm_kstrdup - Allocate resource managed space and
797 * copy an existing string into that.
798 * @dev: Device to allocate memory for
799 * @s: the string to duplicate
800 * @gfp: the GFP mask used in the devm_kmalloc() call when
801 * allocating memory
802 * RETURNS:
803 * Pointer to allocated string on success, NULL on failure.
804 */
805char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp)
806{
807 size_t size;
808 char *buf;
809
810 if (!s)
811 return NULL;
812
813 size = strlen(s) + 1;
814 buf = devm_kmalloc(dev, size, gfp);
815 if (buf)
816 memcpy(buf, s, size);
817 return buf;
818}
819EXPORT_SYMBOL_GPL(devm_kstrdup);
820
821/**
822 * devm_kvasprintf - Allocate resource managed space and format a string
823 * into that.
824 * @dev: Device to allocate memory for
825 * @gfp: the GFP mask used in the devm_kmalloc() call when
826 * allocating memory
827 * @fmt: The printf()-style format string
828 * @ap: Arguments for the format string
829 * RETURNS:
830 * Pointer to allocated string on success, NULL on failure.
831 */
832char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
833 va_list ap)
834{
835 unsigned int len;
836 char *p;
837 va_list aq;
838
839 va_copy(aq, ap);
840 len = vsnprintf(NULL, 0, fmt, aq);
841 va_end(aq);
842
843 p = devm_kmalloc(dev, len+1, gfp);
844 if (!p)
845 return NULL;
846
847 vsnprintf(p, len+1, fmt, ap);
848
849 return p;
850}
851EXPORT_SYMBOL(devm_kvasprintf);
852
853/**
854 * devm_kasprintf - Allocate resource managed space and format a string
855 * into that.
856 * @dev: Device to allocate memory for
857 * @gfp: the GFP mask used in the devm_kmalloc() call when
858 * allocating memory
859 * @fmt: The printf()-style format string
860 * @...: Arguments for the format string
861 * RETURNS:
862 * Pointer to allocated string on success, NULL on failure.
863 */
864char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...)
865{
866 va_list ap;
867 char *p;
868
869 va_start(ap, fmt);
870 p = devm_kvasprintf(dev, gfp, fmt, ap);
871 va_end(ap);
872
873 return p;
874}
875EXPORT_SYMBOL_GPL(devm_kasprintf);
876
877/**
878 * devm_kfree - Resource-managed kfree
879 * @dev: Device this memory belongs to
880 * @p: Memory to free
881 *
882 * Free memory allocated with devm_kmalloc().
883 */
884void devm_kfree(struct device *dev, void *p)
885{
886 int rc;
887
888 rc = devres_destroy(dev, devm_kmalloc_release, devm_kmalloc_match, p);
889 WARN_ON(rc);
890}
891EXPORT_SYMBOL_GPL(devm_kfree);
892
893/**
894 * devm_kmemdup - Resource-managed kmemdup
895 * @dev: Device this memory belongs to
896 * @src: Memory region to duplicate
897 * @len: Memory region length
898 * @gfp: GFP mask to use
899 *
900 * Duplicate region of a memory using resource managed kmalloc
901 */
902void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp)
903{
904 void *p;
905
906 p = devm_kmalloc(dev, len, gfp);
907 if (p)
908 memcpy(p, src, len);
909
910 return p;
911}
912EXPORT_SYMBOL_GPL(devm_kmemdup);
913
914struct pages_devres {
915 unsigned long addr;
916 unsigned int order;
917};
918
919static int devm_pages_match(struct device *dev, void *res, void *p)
920{
921 struct pages_devres *devres = res;
922 struct pages_devres *target = p;
923
924 return devres->addr == target->addr;
925}
926
927static void devm_pages_release(struct device *dev, void *res)
928{
929 struct pages_devres *devres = res;
930
931 free_pages(devres->addr, devres->order);
932}
933
934/**
935 * devm_get_free_pages - Resource-managed __get_free_pages
936 * @dev: Device to allocate memory for
937 * @gfp_mask: Allocation gfp flags
938 * @order: Allocation size is (1 << order) pages
939 *
940 * Managed get_free_pages. Memory allocated with this function is
941 * automatically freed on driver detach.
942 *
943 * RETURNS:
944 * Address of allocated memory on success, 0 on failure.
945 */
946
947unsigned long devm_get_free_pages(struct device *dev,
948 gfp_t gfp_mask, unsigned int order)
949{
950 struct pages_devres *devres;
951 unsigned long addr;
952
953 addr = __get_free_pages(gfp_mask, order);
954
955 if (unlikely(!addr))
956 return 0;
957
958 devres = devres_alloc(devm_pages_release,
959 sizeof(struct pages_devres), GFP_KERNEL);
960 if (unlikely(!devres)) {
961 free_pages(addr, order);
962 return 0;
963 }
964
965 devres->addr = addr;
966 devres->order = order;
967
968 devres_add(dev, devres);
969 return addr;
970}
971EXPORT_SYMBOL_GPL(devm_get_free_pages);
972
973/**
974 * devm_free_pages - Resource-managed free_pages
975 * @dev: Device this memory belongs to
976 * @addr: Memory to free
977 *
978 * Free memory allocated with devm_get_free_pages(). Unlike free_pages,
979 * there is no need to supply the @order.
980 */
981void devm_free_pages(struct device *dev, unsigned long addr)
982{
983 struct pages_devres devres = { .addr = addr };
984
985 WARN_ON(devres_release(dev, devm_pages_release, devm_pages_match,
986 &devres));
987}
988EXPORT_SYMBOL_GPL(devm_free_pages);
989
990static void devm_percpu_release(struct device *dev, void *pdata)
991{
992 void __percpu *p;
993
994 p = *(void __percpu **)pdata;
995 free_percpu(p);
996}
997
998static int devm_percpu_match(struct device *dev, void *data, void *p)
999{
1000 struct devres *devr = container_of(data, struct devres, data);
1001
1002 return *(void **)devr->data == p;
1003}
1004
1005/**
1006 * __devm_alloc_percpu - Resource-managed alloc_percpu
1007 * @dev: Device to allocate per-cpu memory for
1008 * @size: Size of per-cpu memory to allocate
1009 * @align: Alignment of per-cpu memory to allocate
1010 *
1011 * Managed alloc_percpu. Per-cpu memory allocated with this function is
1012 * automatically freed on driver detach.
1013 *
1014 * RETURNS:
1015 * Pointer to allocated memory on success, NULL on failure.
1016 */
1017void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
1018 size_t align)
1019{
1020 void *p;
1021 void __percpu *pcpu;
1022
1023 pcpu = __alloc_percpu(size, align);
1024 if (!pcpu)
1025 return NULL;
1026
1027 p = devres_alloc(devm_percpu_release, sizeof(void *), GFP_KERNEL);
1028 if (!p) {
1029 free_percpu(pcpu);
1030 return NULL;
1031 }
1032
1033 *(void __percpu **)p = pcpu;
1034
1035 devres_add(dev, p);
1036
1037 return pcpu;
1038}
1039EXPORT_SYMBOL_GPL(__devm_alloc_percpu);
1040
1041/**
1042 * devm_free_percpu - Resource-managed free_percpu
1043 * @dev: Device this memory belongs to
1044 * @pdata: Per-cpu memory to free
1045 *
1046 * Free memory allocated with devm_alloc_percpu().
1047 */
1048void devm_free_percpu(struct device *dev, void __percpu *pdata)
1049{
1050 WARN_ON(devres_destroy(dev, devm_percpu_release, devm_percpu_match,
1051 (void *)pdata));
1052}
1053EXPORT_SYMBOL_GPL(devm_free_percpu);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/base/devres.c - device resource management
4 *
5 * Copyright (c) 2006 SUSE Linux Products GmbH
6 * Copyright (c) 2006 Tejun Heo <teheo@suse.de>
7 */
8
9#include <linux/device.h>
10#include <linux/module.h>
11#include <linux/slab.h>
12#include <linux/percpu.h>
13
14#include <asm/sections.h>
15
16#include "base.h"
17
18struct devres_node {
19 struct list_head entry;
20 dr_release_t release;
21#ifdef CONFIG_DEBUG_DEVRES
22 const char *name;
23 size_t size;
24#endif
25};
26
27struct devres {
28 struct devres_node node;
29 /*
30 * Some archs want to perform DMA into kmalloc caches
31 * and need a guaranteed alignment larger than
32 * the alignment of a 64-bit integer.
33 * Thus we use ARCH_KMALLOC_MINALIGN here and get exactly the same
34 * buffer alignment as if it was allocated by plain kmalloc().
35 */
36 u8 __aligned(ARCH_KMALLOC_MINALIGN) data[];
37};
38
39struct devres_group {
40 struct devres_node node[2];
41 void *id;
42 int color;
43 /* -- 8 pointers */
44};
45
46#ifdef CONFIG_DEBUG_DEVRES
47static int log_devres = 0;
48module_param_named(log, log_devres, int, S_IRUGO | S_IWUSR);
49
50static void set_node_dbginfo(struct devres_node *node, const char *name,
51 size_t size)
52{
53 node->name = name;
54 node->size = size;
55}
56
57static void devres_log(struct device *dev, struct devres_node *node,
58 const char *op)
59{
60 if (unlikely(log_devres))
61 dev_err(dev, "DEVRES %3s %p %s (%lu bytes)\n",
62 op, node, node->name, (unsigned long)node->size);
63}
64#else /* CONFIG_DEBUG_DEVRES */
65#define set_node_dbginfo(node, n, s) do {} while (0)
66#define devres_log(dev, node, op) do {} while (0)
67#endif /* CONFIG_DEBUG_DEVRES */
68
69/*
70 * Release functions for devres group. These callbacks are used only
71 * for identification.
72 */
73static void group_open_release(struct device *dev, void *res)
74{
75 /* noop */
76}
77
78static void group_close_release(struct device *dev, void *res)
79{
80 /* noop */
81}
82
83static struct devres_group * node_to_group(struct devres_node *node)
84{
85 if (node->release == &group_open_release)
86 return container_of(node, struct devres_group, node[0]);
87 if (node->release == &group_close_release)
88 return container_of(node, struct devres_group, node[1]);
89 return NULL;
90}
91
92static __always_inline struct devres * alloc_dr(dr_release_t release,
93 size_t size, gfp_t gfp, int nid)
94{
95 size_t tot_size;
96 struct devres *dr;
97
98 /* We must catch any near-SIZE_MAX cases that could overflow. */
99 if (unlikely(check_add_overflow(sizeof(struct devres), size,
100 &tot_size)))
101 return NULL;
102
103 dr = kmalloc_node_track_caller(tot_size, gfp, nid);
104 if (unlikely(!dr))
105 return NULL;
106
107 memset(dr, 0, offsetof(struct devres, data));
108
109 INIT_LIST_HEAD(&dr->node.entry);
110 dr->node.release = release;
111 return dr;
112}
113
114static void add_dr(struct device *dev, struct devres_node *node)
115{
116 devres_log(dev, node, "ADD");
117 BUG_ON(!list_empty(&node->entry));
118 list_add_tail(&node->entry, &dev->devres_head);
119}
120
121#ifdef CONFIG_DEBUG_DEVRES
122void * __devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid,
123 const char *name)
124{
125 struct devres *dr;
126
127 dr = alloc_dr(release, size, gfp | __GFP_ZERO, nid);
128 if (unlikely(!dr))
129 return NULL;
130 set_node_dbginfo(&dr->node, name, size);
131 return dr->data;
132}
133EXPORT_SYMBOL_GPL(__devres_alloc_node);
134#else
135/**
136 * devres_alloc - Allocate device resource data
137 * @release: Release function devres will be associated with
138 * @size: Allocation size
139 * @gfp: Allocation flags
140 * @nid: NUMA node
141 *
142 * Allocate devres of @size bytes. The allocated area is zeroed, then
143 * associated with @release. The returned pointer can be passed to
144 * other devres_*() functions.
145 *
146 * RETURNS:
147 * Pointer to allocated devres on success, NULL on failure.
148 */
149void * devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid)
150{
151 struct devres *dr;
152
153 dr = alloc_dr(release, size, gfp | __GFP_ZERO, nid);
154 if (unlikely(!dr))
155 return NULL;
156 return dr->data;
157}
158EXPORT_SYMBOL_GPL(devres_alloc_node);
159#endif
160
161/**
162 * devres_for_each_res - Resource iterator
163 * @dev: Device to iterate resource from
164 * @release: Look for resources associated with this release function
165 * @match: Match function (optional)
166 * @match_data: Data for the match function
167 * @fn: Function to be called for each matched resource.
168 * @data: Data for @fn, the 3rd parameter of @fn
169 *
170 * Call @fn for each devres of @dev which is associated with @release
171 * and for which @match returns 1.
172 *
173 * RETURNS:
174 * void
175 */
176void devres_for_each_res(struct device *dev, dr_release_t release,
177 dr_match_t match, void *match_data,
178 void (*fn)(struct device *, void *, void *),
179 void *data)
180{
181 struct devres_node *node;
182 struct devres_node *tmp;
183 unsigned long flags;
184
185 if (!fn)
186 return;
187
188 spin_lock_irqsave(&dev->devres_lock, flags);
189 list_for_each_entry_safe_reverse(node, tmp,
190 &dev->devres_head, entry) {
191 struct devres *dr = container_of(node, struct devres, node);
192
193 if (node->release != release)
194 continue;
195 if (match && !match(dev, dr->data, match_data))
196 continue;
197 fn(dev, dr->data, data);
198 }
199 spin_unlock_irqrestore(&dev->devres_lock, flags);
200}
201EXPORT_SYMBOL_GPL(devres_for_each_res);
202
203/**
204 * devres_free - Free device resource data
205 * @res: Pointer to devres data to free
206 *
207 * Free devres created with devres_alloc().
208 */
209void devres_free(void *res)
210{
211 if (res) {
212 struct devres *dr = container_of(res, struct devres, data);
213
214 BUG_ON(!list_empty(&dr->node.entry));
215 kfree(dr);
216 }
217}
218EXPORT_SYMBOL_GPL(devres_free);
219
220/**
221 * devres_add - Register device resource
222 * @dev: Device to add resource to
223 * @res: Resource to register
224 *
225 * Register devres @res to @dev. @res should have been allocated
226 * using devres_alloc(). On driver detach, the associated release
227 * function will be invoked and devres will be freed automatically.
228 */
229void devres_add(struct device *dev, void *res)
230{
231 struct devres *dr = container_of(res, struct devres, data);
232 unsigned long flags;
233
234 spin_lock_irqsave(&dev->devres_lock, flags);
235 add_dr(dev, &dr->node);
236 spin_unlock_irqrestore(&dev->devres_lock, flags);
237}
238EXPORT_SYMBOL_GPL(devres_add);
239
240static struct devres *find_dr(struct device *dev, dr_release_t release,
241 dr_match_t match, void *match_data)
242{
243 struct devres_node *node;
244
245 list_for_each_entry_reverse(node, &dev->devres_head, entry) {
246 struct devres *dr = container_of(node, struct devres, node);
247
248 if (node->release != release)
249 continue;
250 if (match && !match(dev, dr->data, match_data))
251 continue;
252 return dr;
253 }
254
255 return NULL;
256}
257
258/**
259 * devres_find - Find device resource
260 * @dev: Device to lookup resource from
261 * @release: Look for resources associated with this release function
262 * @match: Match function (optional)
263 * @match_data: Data for the match function
264 *
265 * Find the latest devres of @dev which is associated with @release
266 * and for which @match returns 1. If @match is NULL, it's considered
267 * to match all.
268 *
269 * RETURNS:
270 * Pointer to found devres, NULL if not found.
271 */
272void * devres_find(struct device *dev, dr_release_t release,
273 dr_match_t match, void *match_data)
274{
275 struct devres *dr;
276 unsigned long flags;
277
278 spin_lock_irqsave(&dev->devres_lock, flags);
279 dr = find_dr(dev, release, match, match_data);
280 spin_unlock_irqrestore(&dev->devres_lock, flags);
281
282 if (dr)
283 return dr->data;
284 return NULL;
285}
286EXPORT_SYMBOL_GPL(devres_find);
287
288/**
289 * devres_get - Find devres, if non-existent, add one atomically
290 * @dev: Device to lookup or add devres for
291 * @new_res: Pointer to new initialized devres to add if not found
292 * @match: Match function (optional)
293 * @match_data: Data for the match function
294 *
295 * Find the latest devres of @dev which has the same release function
296 * as @new_res and for which @match return 1. If found, @new_res is
297 * freed; otherwise, @new_res is added atomically.
298 *
299 * RETURNS:
300 * Pointer to found or added devres.
301 */
302void * devres_get(struct device *dev, void *new_res,
303 dr_match_t match, void *match_data)
304{
305 struct devres *new_dr = container_of(new_res, struct devres, data);
306 struct devres *dr;
307 unsigned long flags;
308
309 spin_lock_irqsave(&dev->devres_lock, flags);
310 dr = find_dr(dev, new_dr->node.release, match, match_data);
311 if (!dr) {
312 add_dr(dev, &new_dr->node);
313 dr = new_dr;
314 new_res = NULL;
315 }
316 spin_unlock_irqrestore(&dev->devres_lock, flags);
317 devres_free(new_res);
318
319 return dr->data;
320}
321EXPORT_SYMBOL_GPL(devres_get);
322
323/**
324 * devres_remove - Find a device resource and remove it
325 * @dev: Device to find resource from
326 * @release: Look for resources associated with this release function
327 * @match: Match function (optional)
328 * @match_data: Data for the match function
329 *
330 * Find the latest devres of @dev associated with @release and for
331 * which @match returns 1. If @match is NULL, it's considered to
332 * match all. If found, the resource is removed atomically and
333 * returned.
334 *
335 * RETURNS:
336 * Pointer to removed devres on success, NULL if not found.
337 */
338void * devres_remove(struct device *dev, dr_release_t release,
339 dr_match_t match, void *match_data)
340{
341 struct devres *dr;
342 unsigned long flags;
343
344 spin_lock_irqsave(&dev->devres_lock, flags);
345 dr = find_dr(dev, release, match, match_data);
346 if (dr) {
347 list_del_init(&dr->node.entry);
348 devres_log(dev, &dr->node, "REM");
349 }
350 spin_unlock_irqrestore(&dev->devres_lock, flags);
351
352 if (dr)
353 return dr->data;
354 return NULL;
355}
356EXPORT_SYMBOL_GPL(devres_remove);
357
358/**
359 * devres_destroy - Find a device resource and destroy it
360 * @dev: Device to find resource from
361 * @release: Look for resources associated with this release function
362 * @match: Match function (optional)
363 * @match_data: Data for the match function
364 *
365 * Find the latest devres of @dev associated with @release and for
366 * which @match returns 1. If @match is NULL, it's considered to
367 * match all. If found, the resource is removed atomically and freed.
368 *
369 * Note that the release function for the resource will not be called,
370 * only the devres-allocated data will be freed. The caller becomes
371 * responsible for freeing any other data.
372 *
373 * RETURNS:
374 * 0 if devres is found and freed, -ENOENT if not found.
375 */
376int devres_destroy(struct device *dev, dr_release_t release,
377 dr_match_t match, void *match_data)
378{
379 void *res;
380
381 res = devres_remove(dev, release, match, match_data);
382 if (unlikely(!res))
383 return -ENOENT;
384
385 devres_free(res);
386 return 0;
387}
388EXPORT_SYMBOL_GPL(devres_destroy);
389
390
391/**
392 * devres_release - Find a device resource and destroy it, calling release
393 * @dev: Device to find resource from
394 * @release: Look for resources associated with this release function
395 * @match: Match function (optional)
396 * @match_data: Data for the match function
397 *
398 * Find the latest devres of @dev associated with @release and for
399 * which @match returns 1. If @match is NULL, it's considered to
400 * match all. If found, the resource is removed atomically, the
401 * release function called and the resource freed.
402 *
403 * RETURNS:
404 * 0 if devres is found and freed, -ENOENT if not found.
405 */
406int devres_release(struct device *dev, dr_release_t release,
407 dr_match_t match, void *match_data)
408{
409 void *res;
410
411 res = devres_remove(dev, release, match, match_data);
412 if (unlikely(!res))
413 return -ENOENT;
414
415 (*release)(dev, res);
416 devres_free(res);
417 return 0;
418}
419EXPORT_SYMBOL_GPL(devres_release);
420
421static int remove_nodes(struct device *dev,
422 struct list_head *first, struct list_head *end,
423 struct list_head *todo)
424{
425 int cnt = 0, nr_groups = 0;
426 struct list_head *cur;
427
428 /* First pass - move normal devres entries to @todo and clear
429 * devres_group colors.
430 */
431 cur = first;
432 while (cur != end) {
433 struct devres_node *node;
434 struct devres_group *grp;
435
436 node = list_entry(cur, struct devres_node, entry);
437 cur = cur->next;
438
439 grp = node_to_group(node);
440 if (grp) {
441 /* clear color of group markers in the first pass */
442 grp->color = 0;
443 nr_groups++;
444 } else {
445 /* regular devres entry */
446 if (&node->entry == first)
447 first = first->next;
448 list_move_tail(&node->entry, todo);
449 cnt++;
450 }
451 }
452
453 if (!nr_groups)
454 return cnt;
455
456 /* Second pass - Scan groups and color them. A group gets
457 * color value of two iff the group is wholly contained in
458 * [cur, end). That is, for a closed group, both opening and
459 * closing markers should be in the range, while just the
460 * opening marker is enough for an open group.
461 */
462 cur = first;
463 while (cur != end) {
464 struct devres_node *node;
465 struct devres_group *grp;
466
467 node = list_entry(cur, struct devres_node, entry);
468 cur = cur->next;
469
470 grp = node_to_group(node);
471 BUG_ON(!grp || list_empty(&grp->node[0].entry));
472
473 grp->color++;
474 if (list_empty(&grp->node[1].entry))
475 grp->color++;
476
477 BUG_ON(grp->color <= 0 || grp->color > 2);
478 if (grp->color == 2) {
479 /* No need to update cur or end. The removed
480 * nodes are always before both.
481 */
482 list_move_tail(&grp->node[0].entry, todo);
483 list_del_init(&grp->node[1].entry);
484 }
485 }
486
487 return cnt;
488}
489
490static int release_nodes(struct device *dev, struct list_head *first,
491 struct list_head *end, unsigned long flags)
492 __releases(&dev->devres_lock)
493{
494 LIST_HEAD(todo);
495 int cnt;
496 struct devres *dr, *tmp;
497
498 cnt = remove_nodes(dev, first, end, &todo);
499
500 spin_unlock_irqrestore(&dev->devres_lock, flags);
501
502 /* Release. Note that both devres and devres_group are
503 * handled as devres in the following loop. This is safe.
504 */
505 list_for_each_entry_safe_reverse(dr, tmp, &todo, node.entry) {
506 devres_log(dev, &dr->node, "REL");
507 dr->node.release(dev, dr->data);
508 kfree(dr);
509 }
510
511 return cnt;
512}
513
514/**
515 * devres_release_all - Release all managed resources
516 * @dev: Device to release resources for
517 *
518 * Release all resources associated with @dev. This function is
519 * called on driver detach.
520 */
521int devres_release_all(struct device *dev)
522{
523 unsigned long flags;
524
525 /* Looks like an uninitialized device structure */
526 if (WARN_ON(dev->devres_head.next == NULL))
527 return -ENODEV;
528 spin_lock_irqsave(&dev->devres_lock, flags);
529 return release_nodes(dev, dev->devres_head.next, &dev->devres_head,
530 flags);
531}
532
533/**
534 * devres_open_group - Open a new devres group
535 * @dev: Device to open devres group for
536 * @id: Separator ID
537 * @gfp: Allocation flags
538 *
539 * Open a new devres group for @dev with @id. For @id, using a
540 * pointer to an object which won't be used for another group is
541 * recommended. If @id is NULL, address-wise unique ID is created.
542 *
543 * RETURNS:
544 * ID of the new group, NULL on failure.
545 */
546void * devres_open_group(struct device *dev, void *id, gfp_t gfp)
547{
548 struct devres_group *grp;
549 unsigned long flags;
550
551 grp = kmalloc(sizeof(*grp), gfp);
552 if (unlikely(!grp))
553 return NULL;
554
555 grp->node[0].release = &group_open_release;
556 grp->node[1].release = &group_close_release;
557 INIT_LIST_HEAD(&grp->node[0].entry);
558 INIT_LIST_HEAD(&grp->node[1].entry);
559 set_node_dbginfo(&grp->node[0], "grp<", 0);
560 set_node_dbginfo(&grp->node[1], "grp>", 0);
561 grp->id = grp;
562 if (id)
563 grp->id = id;
564
565 spin_lock_irqsave(&dev->devres_lock, flags);
566 add_dr(dev, &grp->node[0]);
567 spin_unlock_irqrestore(&dev->devres_lock, flags);
568 return grp->id;
569}
570EXPORT_SYMBOL_GPL(devres_open_group);
571
572/* Find devres group with ID @id. If @id is NULL, look for the latest. */
573static struct devres_group * find_group(struct device *dev, void *id)
574{
575 struct devres_node *node;
576
577 list_for_each_entry_reverse(node, &dev->devres_head, entry) {
578 struct devres_group *grp;
579
580 if (node->release != &group_open_release)
581 continue;
582
583 grp = container_of(node, struct devres_group, node[0]);
584
585 if (id) {
586 if (grp->id == id)
587 return grp;
588 } else if (list_empty(&grp->node[1].entry))
589 return grp;
590 }
591
592 return NULL;
593}
594
595/**
596 * devres_close_group - Close a devres group
597 * @dev: Device to close devres group for
598 * @id: ID of target group, can be NULL
599 *
600 * Close the group identified by @id. If @id is NULL, the latest open
601 * group is selected.
602 */
603void devres_close_group(struct device *dev, void *id)
604{
605 struct devres_group *grp;
606 unsigned long flags;
607
608 spin_lock_irqsave(&dev->devres_lock, flags);
609
610 grp = find_group(dev, id);
611 if (grp)
612 add_dr(dev, &grp->node[1]);
613 else
614 WARN_ON(1);
615
616 spin_unlock_irqrestore(&dev->devres_lock, flags);
617}
618EXPORT_SYMBOL_GPL(devres_close_group);
619
620/**
621 * devres_remove_group - Remove a devres group
622 * @dev: Device to remove group for
623 * @id: ID of target group, can be NULL
624 *
625 * Remove the group identified by @id. If @id is NULL, the latest
626 * open group is selected. Note that removing a group doesn't affect
627 * any other resources.
628 */
629void devres_remove_group(struct device *dev, void *id)
630{
631 struct devres_group *grp;
632 unsigned long flags;
633
634 spin_lock_irqsave(&dev->devres_lock, flags);
635
636 grp = find_group(dev, id);
637 if (grp) {
638 list_del_init(&grp->node[0].entry);
639 list_del_init(&grp->node[1].entry);
640 devres_log(dev, &grp->node[0], "REM");
641 } else
642 WARN_ON(1);
643
644 spin_unlock_irqrestore(&dev->devres_lock, flags);
645
646 kfree(grp);
647}
648EXPORT_SYMBOL_GPL(devres_remove_group);
649
650/**
651 * devres_release_group - Release resources in a devres group
652 * @dev: Device to release group for
653 * @id: ID of target group, can be NULL
654 *
655 * Release all resources in the group identified by @id. If @id is
656 * NULL, the latest open group is selected. The selected group and
657 * groups properly nested inside the selected group are removed.
658 *
659 * RETURNS:
660 * The number of released non-group resources.
661 */
662int devres_release_group(struct device *dev, void *id)
663{
664 struct devres_group *grp;
665 unsigned long flags;
666 int cnt = 0;
667
668 spin_lock_irqsave(&dev->devres_lock, flags);
669
670 grp = find_group(dev, id);
671 if (grp) {
672 struct list_head *first = &grp->node[0].entry;
673 struct list_head *end = &dev->devres_head;
674
675 if (!list_empty(&grp->node[1].entry))
676 end = grp->node[1].entry.next;
677
678 cnt = release_nodes(dev, first, end, flags);
679 } else {
680 WARN_ON(1);
681 spin_unlock_irqrestore(&dev->devres_lock, flags);
682 }
683
684 return cnt;
685}
686EXPORT_SYMBOL_GPL(devres_release_group);
687
688/*
689 * Custom devres actions allow inserting a simple function call
690 * into the teadown sequence.
691 */
692
693struct action_devres {
694 void *data;
695 void (*action)(void *);
696};
697
698static int devm_action_match(struct device *dev, void *res, void *p)
699{
700 struct action_devres *devres = res;
701 struct action_devres *target = p;
702
703 return devres->action == target->action &&
704 devres->data == target->data;
705}
706
707static void devm_action_release(struct device *dev, void *res)
708{
709 struct action_devres *devres = res;
710
711 devres->action(devres->data);
712}
713
714/**
715 * devm_add_action() - add a custom action to list of managed resources
716 * @dev: Device that owns the action
717 * @action: Function that should be called
718 * @data: Pointer to data passed to @action implementation
719 *
720 * This adds a custom action to the list of managed resources so that
721 * it gets executed as part of standard resource unwinding.
722 */
723int devm_add_action(struct device *dev, void (*action)(void *), void *data)
724{
725 struct action_devres *devres;
726
727 devres = devres_alloc(devm_action_release,
728 sizeof(struct action_devres), GFP_KERNEL);
729 if (!devres)
730 return -ENOMEM;
731
732 devres->data = data;
733 devres->action = action;
734
735 devres_add(dev, devres);
736 return 0;
737}
738EXPORT_SYMBOL_GPL(devm_add_action);
739
740/**
741 * devm_remove_action() - removes previously added custom action
742 * @dev: Device that owns the action
743 * @action: Function implementing the action
744 * @data: Pointer to data passed to @action implementation
745 *
746 * Removes instance of @action previously added by devm_add_action().
747 * Both action and data should match one of the existing entries.
748 */
749void devm_remove_action(struct device *dev, void (*action)(void *), void *data)
750{
751 struct action_devres devres = {
752 .data = data,
753 .action = action,
754 };
755
756 WARN_ON(devres_destroy(dev, devm_action_release, devm_action_match,
757 &devres));
758}
759EXPORT_SYMBOL_GPL(devm_remove_action);
760
761/**
762 * devm_release_action() - release previously added custom action
763 * @dev: Device that owns the action
764 * @action: Function implementing the action
765 * @data: Pointer to data passed to @action implementation
766 *
767 * Releases and removes instance of @action previously added by
768 * devm_add_action(). Both action and data should match one of the
769 * existing entries.
770 */
771void devm_release_action(struct device *dev, void (*action)(void *), void *data)
772{
773 struct action_devres devres = {
774 .data = data,
775 .action = action,
776 };
777
778 WARN_ON(devres_release(dev, devm_action_release, devm_action_match,
779 &devres));
780
781}
782EXPORT_SYMBOL_GPL(devm_release_action);
783
784/*
785 * Managed kmalloc/kfree
786 */
787static void devm_kmalloc_release(struct device *dev, void *res)
788{
789 /* noop */
790}
791
792static int devm_kmalloc_match(struct device *dev, void *res, void *data)
793{
794 return res == data;
795}
796
797/**
798 * devm_kmalloc - Resource-managed kmalloc
799 * @dev: Device to allocate memory for
800 * @size: Allocation size
801 * @gfp: Allocation gfp flags
802 *
803 * Managed kmalloc. Memory allocated with this function is
804 * automatically freed on driver detach. Like all other devres
805 * resources, guaranteed alignment is unsigned long long.
806 *
807 * RETURNS:
808 * Pointer to allocated memory on success, NULL on failure.
809 */
810void * devm_kmalloc(struct device *dev, size_t size, gfp_t gfp)
811{
812 struct devres *dr;
813
814 /* use raw alloc_dr for kmalloc caller tracing */
815 dr = alloc_dr(devm_kmalloc_release, size, gfp, dev_to_node(dev));
816 if (unlikely(!dr))
817 return NULL;
818
819 /*
820 * This is named devm_kzalloc_release for historical reasons
821 * The initial implementation did not support kmalloc, only kzalloc
822 */
823 set_node_dbginfo(&dr->node, "devm_kzalloc_release", size);
824 devres_add(dev, dr->data);
825 return dr->data;
826}
827EXPORT_SYMBOL_GPL(devm_kmalloc);
828
829/**
830 * devm_kstrdup - Allocate resource managed space and
831 * copy an existing string into that.
832 * @dev: Device to allocate memory for
833 * @s: the string to duplicate
834 * @gfp: the GFP mask used in the devm_kmalloc() call when
835 * allocating memory
836 * RETURNS:
837 * Pointer to allocated string on success, NULL on failure.
838 */
839char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp)
840{
841 size_t size;
842 char *buf;
843
844 if (!s)
845 return NULL;
846
847 size = strlen(s) + 1;
848 buf = devm_kmalloc(dev, size, gfp);
849 if (buf)
850 memcpy(buf, s, size);
851 return buf;
852}
853EXPORT_SYMBOL_GPL(devm_kstrdup);
854
855/**
856 * devm_kstrdup_const - resource managed conditional string duplication
857 * @dev: device for which to duplicate the string
858 * @s: the string to duplicate
859 * @gfp: the GFP mask used in the kmalloc() call when allocating memory
860 *
861 * Strings allocated by devm_kstrdup_const will be automatically freed when
862 * the associated device is detached.
863 *
864 * RETURNS:
865 * Source string if it is in .rodata section otherwise it falls back to
866 * devm_kstrdup.
867 */
868const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp)
869{
870 if (is_kernel_rodata((unsigned long)s))
871 return s;
872
873 return devm_kstrdup(dev, s, gfp);
874}
875EXPORT_SYMBOL_GPL(devm_kstrdup_const);
876
877/**
878 * devm_kvasprintf - Allocate resource managed space and format a string
879 * into that.
880 * @dev: Device to allocate memory for
881 * @gfp: the GFP mask used in the devm_kmalloc() call when
882 * allocating memory
883 * @fmt: The printf()-style format string
884 * @ap: Arguments for the format string
885 * RETURNS:
886 * Pointer to allocated string on success, NULL on failure.
887 */
888char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
889 va_list ap)
890{
891 unsigned int len;
892 char *p;
893 va_list aq;
894
895 va_copy(aq, ap);
896 len = vsnprintf(NULL, 0, fmt, aq);
897 va_end(aq);
898
899 p = devm_kmalloc(dev, len+1, gfp);
900 if (!p)
901 return NULL;
902
903 vsnprintf(p, len+1, fmt, ap);
904
905 return p;
906}
907EXPORT_SYMBOL(devm_kvasprintf);
908
909/**
910 * devm_kasprintf - Allocate resource managed space and format a string
911 * into that.
912 * @dev: Device to allocate memory for
913 * @gfp: the GFP mask used in the devm_kmalloc() call when
914 * allocating memory
915 * @fmt: The printf()-style format string
916 * @...: Arguments for the format string
917 * RETURNS:
918 * Pointer to allocated string on success, NULL on failure.
919 */
920char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...)
921{
922 va_list ap;
923 char *p;
924
925 va_start(ap, fmt);
926 p = devm_kvasprintf(dev, gfp, fmt, ap);
927 va_end(ap);
928
929 return p;
930}
931EXPORT_SYMBOL_GPL(devm_kasprintf);
932
933/**
934 * devm_kfree - Resource-managed kfree
935 * @dev: Device this memory belongs to
936 * @p: Memory to free
937 *
938 * Free memory allocated with devm_kmalloc().
939 */
940void devm_kfree(struct device *dev, const void *p)
941{
942 int rc;
943
944 /*
945 * Special case: pointer to a string in .rodata returned by
946 * devm_kstrdup_const().
947 */
948 if (unlikely(is_kernel_rodata((unsigned long)p)))
949 return;
950
951 rc = devres_destroy(dev, devm_kmalloc_release,
952 devm_kmalloc_match, (void *)p);
953 WARN_ON(rc);
954}
955EXPORT_SYMBOL_GPL(devm_kfree);
956
957/**
958 * devm_kmemdup - Resource-managed kmemdup
959 * @dev: Device this memory belongs to
960 * @src: Memory region to duplicate
961 * @len: Memory region length
962 * @gfp: GFP mask to use
963 *
964 * Duplicate region of a memory using resource managed kmalloc
965 */
966void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp)
967{
968 void *p;
969
970 p = devm_kmalloc(dev, len, gfp);
971 if (p)
972 memcpy(p, src, len);
973
974 return p;
975}
976EXPORT_SYMBOL_GPL(devm_kmemdup);
977
978struct pages_devres {
979 unsigned long addr;
980 unsigned int order;
981};
982
983static int devm_pages_match(struct device *dev, void *res, void *p)
984{
985 struct pages_devres *devres = res;
986 struct pages_devres *target = p;
987
988 return devres->addr == target->addr;
989}
990
991static void devm_pages_release(struct device *dev, void *res)
992{
993 struct pages_devres *devres = res;
994
995 free_pages(devres->addr, devres->order);
996}
997
998/**
999 * devm_get_free_pages - Resource-managed __get_free_pages
1000 * @dev: Device to allocate memory for
1001 * @gfp_mask: Allocation gfp flags
1002 * @order: Allocation size is (1 << order) pages
1003 *
1004 * Managed get_free_pages. Memory allocated with this function is
1005 * automatically freed on driver detach.
1006 *
1007 * RETURNS:
1008 * Address of allocated memory on success, 0 on failure.
1009 */
1010
1011unsigned long devm_get_free_pages(struct device *dev,
1012 gfp_t gfp_mask, unsigned int order)
1013{
1014 struct pages_devres *devres;
1015 unsigned long addr;
1016
1017 addr = __get_free_pages(gfp_mask, order);
1018
1019 if (unlikely(!addr))
1020 return 0;
1021
1022 devres = devres_alloc(devm_pages_release,
1023 sizeof(struct pages_devres), GFP_KERNEL);
1024 if (unlikely(!devres)) {
1025 free_pages(addr, order);
1026 return 0;
1027 }
1028
1029 devres->addr = addr;
1030 devres->order = order;
1031
1032 devres_add(dev, devres);
1033 return addr;
1034}
1035EXPORT_SYMBOL_GPL(devm_get_free_pages);
1036
1037/**
1038 * devm_free_pages - Resource-managed free_pages
1039 * @dev: Device this memory belongs to
1040 * @addr: Memory to free
1041 *
1042 * Free memory allocated with devm_get_free_pages(). Unlike free_pages,
1043 * there is no need to supply the @order.
1044 */
1045void devm_free_pages(struct device *dev, unsigned long addr)
1046{
1047 struct pages_devres devres = { .addr = addr };
1048
1049 WARN_ON(devres_release(dev, devm_pages_release, devm_pages_match,
1050 &devres));
1051}
1052EXPORT_SYMBOL_GPL(devm_free_pages);
1053
1054static void devm_percpu_release(struct device *dev, void *pdata)
1055{
1056 void __percpu *p;
1057
1058 p = *(void __percpu **)pdata;
1059 free_percpu(p);
1060}
1061
1062static int devm_percpu_match(struct device *dev, void *data, void *p)
1063{
1064 struct devres *devr = container_of(data, struct devres, data);
1065
1066 return *(void **)devr->data == p;
1067}
1068
1069/**
1070 * __devm_alloc_percpu - Resource-managed alloc_percpu
1071 * @dev: Device to allocate per-cpu memory for
1072 * @size: Size of per-cpu memory to allocate
1073 * @align: Alignment of per-cpu memory to allocate
1074 *
1075 * Managed alloc_percpu. Per-cpu memory allocated with this function is
1076 * automatically freed on driver detach.
1077 *
1078 * RETURNS:
1079 * Pointer to allocated memory on success, NULL on failure.
1080 */
1081void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
1082 size_t align)
1083{
1084 void *p;
1085 void __percpu *pcpu;
1086
1087 pcpu = __alloc_percpu(size, align);
1088 if (!pcpu)
1089 return NULL;
1090
1091 p = devres_alloc(devm_percpu_release, sizeof(void *), GFP_KERNEL);
1092 if (!p) {
1093 free_percpu(pcpu);
1094 return NULL;
1095 }
1096
1097 *(void __percpu **)p = pcpu;
1098
1099 devres_add(dev, p);
1100
1101 return pcpu;
1102}
1103EXPORT_SYMBOL_GPL(__devm_alloc_percpu);
1104
1105/**
1106 * devm_free_percpu - Resource-managed free_percpu
1107 * @dev: Device this memory belongs to
1108 * @pdata: Per-cpu memory to free
1109 *
1110 * Free memory allocated with devm_alloc_percpu().
1111 */
1112void devm_free_percpu(struct device *dev, void __percpu *pdata)
1113{
1114 WARN_ON(devres_destroy(dev, devm_percpu_release, devm_percpu_match,
1115 (void *)pdata));
1116}
1117EXPORT_SYMBOL_GPL(devm_free_percpu);