2 * drivers/base/devres.c - device resource management
4 * Copyright (c) 2006 SUSE Linux Products GmbH
5 * Copyright (c) 2006 Tejun Heo <teheo@suse.de>
7 * This file is released under the GPLv2.
10 #include <linux/device.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
17 struct list_head entry
;
19 #ifdef CONFIG_DEBUG_DEVRES
26 struct devres_node node
;
28 unsigned long long data
[]; /* guarantee ull alignment */
32 struct devres_node node
[2];
38 #ifdef CONFIG_DEBUG_DEVRES
39 static int log_devres
= 0;
40 module_param_named(log
, log_devres
, int, S_IRUGO
| S_IWUSR
);
42 static void set_node_dbginfo(struct devres_node
*node
, const char *name
,
49 static void devres_log(struct device
*dev
, struct devres_node
*node
,
52 if (unlikely(log_devres
))
53 dev_err(dev
, "DEVRES %3s %p %s (%lu bytes)\n",
54 op
, node
, node
->name
, (unsigned long)node
->size
);
56 #else /* CONFIG_DEBUG_DEVRES */
57 #define set_node_dbginfo(node, n, s) do {} while (0)
58 #define devres_log(dev, node, op) do {} while (0)
59 #endif /* CONFIG_DEBUG_DEVRES */
62 * Release functions for devres group. These callbacks are used only
65 static void group_open_release(struct device
*dev
, void *res
)
70 static void group_close_release(struct device
*dev
, void *res
)
75 static struct devres_group
* node_to_group(struct devres_node
*node
)
77 if (node
->release
== &group_open_release
)
78 return container_of(node
, struct devres_group
, node
[0]);
79 if (node
->release
== &group_close_release
)
80 return container_of(node
, struct devres_group
, node
[1]);
84 static __always_inline
struct devres
* alloc_dr(dr_release_t release
,
85 size_t size
, gfp_t gfp
, int nid
)
87 size_t tot_size
= sizeof(struct devres
) + size
;
90 dr
= kmalloc_node_track_caller(tot_size
, gfp
, nid
);
94 memset(dr
, 0, offsetof(struct devres
, data
));
96 INIT_LIST_HEAD(&dr
->node
.entry
);
97 dr
->node
.release
= release
;
101 static void add_dr(struct device
*dev
, struct devres_node
*node
)
103 devres_log(dev
, node
, "ADD");
104 BUG_ON(!list_empty(&node
->entry
));
105 list_add_tail(&node
->entry
, &dev
->devres_head
);
108 #ifdef CONFIG_DEBUG_DEVRES
109 void * __devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
, int nid
,
114 dr
= alloc_dr(release
, size
, gfp
| __GFP_ZERO
, nid
);
117 set_node_dbginfo(&dr
->node
, name
, size
);
120 EXPORT_SYMBOL_GPL(__devres_alloc_node
);
123 * devres_alloc - Allocate device resource data
124 * @release: Release function devres will be associated with
125 * @size: Allocation size
126 * @gfp: Allocation flags
129 * Allocate devres of @size bytes. The allocated area is zeroed, then
130 * associated with @release. The returned pointer can be passed to
131 * other devres_*() functions.
134 * Pointer to allocated devres on success, NULL on failure.
136 void * devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
, int nid
)
140 dr
= alloc_dr(release
, size
, gfp
| __GFP_ZERO
, nid
);
145 EXPORT_SYMBOL_GPL(devres_alloc_node
);
149 * devres_for_each_res - Resource iterator
150 * @dev: Device to iterate resource from
151 * @release: Look for resources associated with this release function
152 * @match: Match function (optional)
153 * @match_data: Data for the match function
154 * @fn: Function to be called for each matched resource.
155 * @data: Data for @fn, the 3rd parameter of @fn
157 * Call @fn for each devres of @dev which is associated with @release
158 * and for which @match returns 1.
163 void devres_for_each_res(struct device
*dev
, dr_release_t release
,
164 dr_match_t match
, void *match_data
,
165 void (*fn
)(struct device
*, void *, void *),
168 struct devres_node
*node
;
169 struct devres_node
*tmp
;
175 spin_lock_irqsave(&dev
->devres_lock
, flags
);
176 list_for_each_entry_safe_reverse(node
, tmp
,
177 &dev
->devres_head
, entry
) {
178 struct devres
*dr
= container_of(node
, struct devres
, node
);
180 if (node
->release
!= release
)
182 if (match
&& !match(dev
, dr
->data
, match_data
))
184 fn(dev
, dr
->data
, data
);
186 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
188 EXPORT_SYMBOL_GPL(devres_for_each_res
);
191 * devres_free - Free device resource data
192 * @res: Pointer to devres data to free
194 * Free devres created with devres_alloc().
196 void devres_free(void *res
)
199 struct devres
*dr
= container_of(res
, struct devres
, data
);
201 BUG_ON(!list_empty(&dr
->node
.entry
));
205 EXPORT_SYMBOL_GPL(devres_free
);
208 * devres_add - Register device resource
209 * @dev: Device to add resource to
210 * @res: Resource to register
212 * Register devres @res to @dev. @res should have been allocated
213 * using devres_alloc(). On driver detach, the associated release
214 * function will be invoked and devres will be freed automatically.
216 void devres_add(struct device
*dev
, void *res
)
218 struct devres
*dr
= container_of(res
, struct devres
, data
);
221 spin_lock_irqsave(&dev
->devres_lock
, flags
);
222 add_dr(dev
, &dr
->node
);
223 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
225 EXPORT_SYMBOL_GPL(devres_add
);
227 static struct devres
*find_dr(struct device
*dev
, dr_release_t release
,
228 dr_match_t match
, void *match_data
)
230 struct devres_node
*node
;
232 list_for_each_entry_reverse(node
, &dev
->devres_head
, entry
) {
233 struct devres
*dr
= container_of(node
, struct devres
, node
);
235 if (node
->release
!= release
)
237 if (match
&& !match(dev
, dr
->data
, match_data
))
246 * devres_find - Find device resource
247 * @dev: Device to lookup resource from
248 * @release: Look for resources associated with this release function
249 * @match: Match function (optional)
250 * @match_data: Data for the match function
252 * Find the latest devres of @dev which is associated with @release
253 * and for which @match returns 1. If @match is NULL, it's considered
257 * Pointer to found devres, NULL if not found.
259 void * devres_find(struct device
*dev
, dr_release_t release
,
260 dr_match_t match
, void *match_data
)
265 spin_lock_irqsave(&dev
->devres_lock
, flags
);
266 dr
= find_dr(dev
, release
, match
, match_data
);
267 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
273 EXPORT_SYMBOL_GPL(devres_find
);
276 * devres_get - Find devres, if non-existent, add one atomically
277 * @dev: Device to lookup or add devres for
278 * @new_res: Pointer to new initialized devres to add if not found
279 * @match: Match function (optional)
280 * @match_data: Data for the match function
282 * Find the latest devres of @dev which has the same release function
283 * as @new_res and for which @match return 1. If found, @new_res is
284 * freed; otherwise, @new_res is added atomically.
287 * Pointer to found or added devres.
289 void * devres_get(struct device
*dev
, void *new_res
,
290 dr_match_t match
, void *match_data
)
292 struct devres
*new_dr
= container_of(new_res
, struct devres
, data
);
296 spin_lock_irqsave(&dev
->devres_lock
, flags
);
297 dr
= find_dr(dev
, new_dr
->node
.release
, match
, match_data
);
299 add_dr(dev
, &new_dr
->node
);
303 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
304 devres_free(new_res
);
308 EXPORT_SYMBOL_GPL(devres_get
);
311 * devres_remove - Find a device resource and remove it
312 * @dev: Device to find resource from
313 * @release: Look for resources associated with this release function
314 * @match: Match function (optional)
315 * @match_data: Data for the match function
317 * Find the latest devres of @dev associated with @release and for
318 * which @match returns 1. If @match is NULL, it's considered to
319 * match all. If found, the resource is removed atomically and
323 * Pointer to removed devres on success, NULL if not found.
325 void * devres_remove(struct device
*dev
, dr_release_t release
,
326 dr_match_t match
, void *match_data
)
331 spin_lock_irqsave(&dev
->devres_lock
, flags
);
332 dr
= find_dr(dev
, release
, match
, match_data
);
334 list_del_init(&dr
->node
.entry
);
335 devres_log(dev
, &dr
->node
, "REM");
337 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
343 EXPORT_SYMBOL_GPL(devres_remove
);
346 * devres_destroy - Find a device resource and destroy it
347 * @dev: Device to find resource from
348 * @release: Look for resources associated with this release function
349 * @match: Match function (optional)
350 * @match_data: Data for the match function
352 * Find the latest devres of @dev associated with @release and for
353 * which @match returns 1. If @match is NULL, it's considered to
354 * match all. If found, the resource is removed atomically and freed.
356 * Note that the release function for the resource will not be called,
357 * only the devres-allocated data will be freed. The caller becomes
358 * responsible for freeing any other data.
361 * 0 if devres is found and freed, -ENOENT if not found.
363 int devres_destroy(struct device
*dev
, dr_release_t release
,
364 dr_match_t match
, void *match_data
)
368 res
= devres_remove(dev
, release
, match
, match_data
);
375 EXPORT_SYMBOL_GPL(devres_destroy
);
379 * devres_release - Find a device resource and destroy it, calling release
380 * @dev: Device to find resource from
381 * @release: Look for resources associated with this release function
382 * @match: Match function (optional)
383 * @match_data: Data for the match function
385 * Find the latest devres of @dev associated with @release and for
386 * which @match returns 1. If @match is NULL, it's considered to
387 * match all. If found, the resource is removed atomically, the
388 * release function called and the resource freed.
391 * 0 if devres is found and freed, -ENOENT if not found.
393 int devres_release(struct device
*dev
, dr_release_t release
,
394 dr_match_t match
, void *match_data
)
398 res
= devres_remove(dev
, release
, match
, match_data
);
402 (*release
)(dev
, res
);
406 EXPORT_SYMBOL_GPL(devres_release
);
408 static int remove_nodes(struct device
*dev
,
409 struct list_head
*first
, struct list_head
*end
,
410 struct list_head
*todo
)
412 int cnt
= 0, nr_groups
= 0;
413 struct list_head
*cur
;
415 /* First pass - move normal devres entries to @todo and clear
416 * devres_group colors.
420 struct devres_node
*node
;
421 struct devres_group
*grp
;
423 node
= list_entry(cur
, struct devres_node
, entry
);
426 grp
= node_to_group(node
);
428 /* clear color of group markers in the first pass */
432 /* regular devres entry */
433 if (&node
->entry
== first
)
435 list_move_tail(&node
->entry
, todo
);
443 /* Second pass - Scan groups and color them. A group gets
444 * color value of two iff the group is wholly contained in
445 * [cur, end). That is, for a closed group, both opening and
446 * closing markers should be in the range, while just the
447 * opening marker is enough for an open group.
451 struct devres_node
*node
;
452 struct devres_group
*grp
;
454 node
= list_entry(cur
, struct devres_node
, entry
);
457 grp
= node_to_group(node
);
458 BUG_ON(!grp
|| list_empty(&grp
->node
[0].entry
));
461 if (list_empty(&grp
->node
[1].entry
))
464 BUG_ON(grp
->color
<= 0 || grp
->color
> 2);
465 if (grp
->color
== 2) {
466 /* No need to update cur or end. The removed
467 * nodes are always before both.
469 list_move_tail(&grp
->node
[0].entry
, todo
);
470 list_del_init(&grp
->node
[1].entry
);
477 static int release_nodes(struct device
*dev
, struct list_head
*first
,
478 struct list_head
*end
, unsigned long flags
)
479 __releases(&dev
->devres_lock
)
483 struct devres
*dr
, *tmp
;
485 cnt
= remove_nodes(dev
, first
, end
, &todo
);
487 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
489 /* Release. Note that both devres and devres_group are
490 * handled as devres in the following loop. This is safe.
492 list_for_each_entry_safe_reverse(dr
, tmp
, &todo
, node
.entry
) {
493 devres_log(dev
, &dr
->node
, "REL");
494 dr
->node
.release(dev
, dr
->data
);
502 * devres_release_all - Release all managed resources
503 * @dev: Device to release resources for
505 * Release all resources associated with @dev. This function is
506 * called on driver detach.
508 int devres_release_all(struct device
*dev
)
512 /* Looks like an uninitialized device structure */
513 if (WARN_ON(dev
->devres_head
.next
== NULL
))
515 spin_lock_irqsave(&dev
->devres_lock
, flags
);
516 return release_nodes(dev
, dev
->devres_head
.next
, &dev
->devres_head
,
521 * devres_open_group - Open a new devres group
522 * @dev: Device to open devres group for
524 * @gfp: Allocation flags
526 * Open a new devres group for @dev with @id. For @id, using a
527 * pointer to an object which won't be used for another group is
528 * recommended. If @id is NULL, address-wise unique ID is created.
531 * ID of the new group, NULL on failure.
533 void * devres_open_group(struct device
*dev
, void *id
, gfp_t gfp
)
535 struct devres_group
*grp
;
538 grp
= kmalloc(sizeof(*grp
), gfp
);
542 grp
->node
[0].release
= &group_open_release
;
543 grp
->node
[1].release
= &group_close_release
;
544 INIT_LIST_HEAD(&grp
->node
[0].entry
);
545 INIT_LIST_HEAD(&grp
->node
[1].entry
);
546 set_node_dbginfo(&grp
->node
[0], "grp<", 0);
547 set_node_dbginfo(&grp
->node
[1], "grp>", 0);
552 spin_lock_irqsave(&dev
->devres_lock
, flags
);
553 add_dr(dev
, &grp
->node
[0]);
554 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
557 EXPORT_SYMBOL_GPL(devres_open_group
);
559 /* Find devres group with ID @id. If @id is NULL, look for the latest. */
560 static struct devres_group
* find_group(struct device
*dev
, void *id
)
562 struct devres_node
*node
;
564 list_for_each_entry_reverse(node
, &dev
->devres_head
, entry
) {
565 struct devres_group
*grp
;
567 if (node
->release
!= &group_open_release
)
570 grp
= container_of(node
, struct devres_group
, node
[0]);
575 } else if (list_empty(&grp
->node
[1].entry
))
583 * devres_close_group - Close a devres group
584 * @dev: Device to close devres group for
585 * @id: ID of target group, can be NULL
587 * Close the group identified by @id. If @id is NULL, the latest open
590 void devres_close_group(struct device
*dev
, void *id
)
592 struct devres_group
*grp
;
595 spin_lock_irqsave(&dev
->devres_lock
, flags
);
597 grp
= find_group(dev
, id
);
599 add_dr(dev
, &grp
->node
[1]);
603 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
605 EXPORT_SYMBOL_GPL(devres_close_group
);
608 * devres_remove_group - Remove a devres group
609 * @dev: Device to remove group for
610 * @id: ID of target group, can be NULL
612 * Remove the group identified by @id. If @id is NULL, the latest
613 * open group is selected. Note that removing a group doesn't affect
614 * any other resources.
616 void devres_remove_group(struct device
*dev
, void *id
)
618 struct devres_group
*grp
;
621 spin_lock_irqsave(&dev
->devres_lock
, flags
);
623 grp
= find_group(dev
, id
);
625 list_del_init(&grp
->node
[0].entry
);
626 list_del_init(&grp
->node
[1].entry
);
627 devres_log(dev
, &grp
->node
[0], "REM");
631 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
635 EXPORT_SYMBOL_GPL(devres_remove_group
);
638 * devres_release_group - Release resources in a devres group
639 * @dev: Device to release group for
640 * @id: ID of target group, can be NULL
642 * Release all resources in the group identified by @id. If @id is
643 * NULL, the latest open group is selected. The selected group and
644 * groups properly nested inside the selected group are removed.
647 * The number of released non-group resources.
649 int devres_release_group(struct device
*dev
, void *id
)
651 struct devres_group
*grp
;
655 spin_lock_irqsave(&dev
->devres_lock
, flags
);
657 grp
= find_group(dev
, id
);
659 struct list_head
*first
= &grp
->node
[0].entry
;
660 struct list_head
*end
= &dev
->devres_head
;
662 if (!list_empty(&grp
->node
[1].entry
))
663 end
= grp
->node
[1].entry
.next
;
665 cnt
= release_nodes(dev
, first
, end
, flags
);
668 spin_unlock_irqrestore(&dev
->devres_lock
, flags
);
673 EXPORT_SYMBOL_GPL(devres_release_group
);
676 * Custom devres actions allow inserting a simple function call
677 * into the teadown sequence.
680 struct action_devres
{
682 void (*action
)(void *);
685 static int devm_action_match(struct device
*dev
, void *res
, void *p
)
687 struct action_devres
*devres
= res
;
688 struct action_devres
*target
= p
;
690 return devres
->action
== target
->action
&&
691 devres
->data
== target
->data
;
694 static void devm_action_release(struct device
*dev
, void *res
)
696 struct action_devres
*devres
= res
;
698 devres
->action(devres
->data
);
702 * devm_add_action() - add a custom action to list of managed resources
703 * @dev: Device that owns the action
704 * @action: Function that should be called
705 * @data: Pointer to data passed to @action implementation
707 * This adds a custom action to the list of managed resources so that
708 * it gets executed as part of standard resource unwinding.
710 int devm_add_action(struct device
*dev
, void (*action
)(void *), void *data
)
712 struct action_devres
*devres
;
714 devres
= devres_alloc(devm_action_release
,
715 sizeof(struct action_devres
), GFP_KERNEL
);
720 devres
->action
= action
;
722 devres_add(dev
, devres
);
725 EXPORT_SYMBOL_GPL(devm_add_action
);
728 * devm_remove_action() - removes previously added custom action
729 * @dev: Device that owns the action
730 * @action: Function implementing the action
731 * @data: Pointer to data passed to @action implementation
733 * Removes instance of @action previously added by devm_add_action().
734 * Both action and data should match one of the existing entries.
736 void devm_remove_action(struct device
*dev
, void (*action
)(void *), void *data
)
738 struct action_devres devres
= {
743 WARN_ON(devres_destroy(dev
, devm_action_release
, devm_action_match
,
747 EXPORT_SYMBOL_GPL(devm_remove_action
);
750 * Managed kmalloc/kfree
752 static void devm_kmalloc_release(struct device
*dev
, void *res
)
757 static int devm_kmalloc_match(struct device
*dev
, void *res
, void *data
)
763 * devm_kmalloc - Resource-managed kmalloc
764 * @dev: Device to allocate memory for
765 * @size: Allocation size
766 * @gfp: Allocation gfp flags
768 * Managed kmalloc. Memory allocated with this function is
769 * automatically freed on driver detach. Like all other devres
770 * resources, guaranteed alignment is unsigned long long.
773 * Pointer to allocated memory on success, NULL on failure.
775 void * devm_kmalloc(struct device
*dev
, size_t size
, gfp_t gfp
)
779 /* use raw alloc_dr for kmalloc caller tracing */
780 dr
= alloc_dr(devm_kmalloc_release
, size
, gfp
, dev_to_node(dev
));
785 * This is named devm_kzalloc_release for historical reasons
786 * The initial implementation did not support kmalloc, only kzalloc
788 set_node_dbginfo(&dr
->node
, "devm_kzalloc_release", size
);
789 devres_add(dev
, dr
->data
);
792 EXPORT_SYMBOL_GPL(devm_kmalloc
);
795 * devm_kstrdup - Allocate resource managed space and
796 * copy an existing string into that.
797 * @dev: Device to allocate memory for
798 * @s: the string to duplicate
799 * @gfp: the GFP mask used in the devm_kmalloc() call when
802 * Pointer to allocated string on success, NULL on failure.
804 char *devm_kstrdup(struct device
*dev
, const char *s
, gfp_t gfp
)
812 size
= strlen(s
) + 1;
813 buf
= devm_kmalloc(dev
, size
, gfp
);
815 memcpy(buf
, s
, size
);
818 EXPORT_SYMBOL_GPL(devm_kstrdup
);
821 * devm_kvasprintf - Allocate resource managed space and format a string
823 * @dev: Device to allocate memory for
824 * @gfp: the GFP mask used in the devm_kmalloc() call when
826 * @fmt: The printf()-style format string
827 * @ap: Arguments for the format string
829 * Pointer to allocated string on success, NULL on failure.
831 char *devm_kvasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
,
839 len
= vsnprintf(NULL
, 0, fmt
, aq
);
842 p
= devm_kmalloc(dev
, len
+1, gfp
);
846 vsnprintf(p
, len
+1, fmt
, ap
);
850 EXPORT_SYMBOL(devm_kvasprintf
);
853 * devm_kasprintf - Allocate resource managed space and format a string
855 * @dev: Device to allocate memory for
856 * @gfp: the GFP mask used in the devm_kmalloc() call when
858 * @fmt: The printf()-style format string
859 * @...: Arguments for the format string
861 * Pointer to allocated string on success, NULL on failure.
863 char *devm_kasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
, ...)
869 p
= devm_kvasprintf(dev
, gfp
, fmt
, ap
);
874 EXPORT_SYMBOL_GPL(devm_kasprintf
);
877 * devm_kfree - Resource-managed kfree
878 * @dev: Device this memory belongs to
881 * Free memory allocated with devm_kmalloc().
883 void devm_kfree(struct device
*dev
, void *p
)
887 rc
= devres_destroy(dev
, devm_kmalloc_release
, devm_kmalloc_match
, p
);
890 EXPORT_SYMBOL_GPL(devm_kfree
);
893 * devm_kmemdup - Resource-managed kmemdup
894 * @dev: Device this memory belongs to
895 * @src: Memory region to duplicate
896 * @len: Memory region length
897 * @gfp: GFP mask to use
899 * Duplicate region of a memory using resource managed kmalloc
901 void *devm_kmemdup(struct device
*dev
, const void *src
, size_t len
, gfp_t gfp
)
905 p
= devm_kmalloc(dev
, len
, gfp
);
911 EXPORT_SYMBOL_GPL(devm_kmemdup
);
913 struct pages_devres
{
918 static int devm_pages_match(struct device
*dev
, void *res
, void *p
)
920 struct pages_devres
*devres
= res
;
921 struct pages_devres
*target
= p
;
923 return devres
->addr
== target
->addr
;
926 static void devm_pages_release(struct device
*dev
, void *res
)
928 struct pages_devres
*devres
= res
;
930 free_pages(devres
->addr
, devres
->order
);
934 * devm_get_free_pages - Resource-managed __get_free_pages
935 * @dev: Device to allocate memory for
936 * @gfp_mask: Allocation gfp flags
937 * @order: Allocation size is (1 << order) pages
939 * Managed get_free_pages. Memory allocated with this function is
940 * automatically freed on driver detach.
943 * Address of allocated memory on success, 0 on failure.
946 unsigned long devm_get_free_pages(struct device
*dev
,
947 gfp_t gfp_mask
, unsigned int order
)
949 struct pages_devres
*devres
;
952 addr
= __get_free_pages(gfp_mask
, order
);
957 devres
= devres_alloc(devm_pages_release
,
958 sizeof(struct pages_devres
), GFP_KERNEL
);
959 if (unlikely(!devres
)) {
960 free_pages(addr
, order
);
965 devres
->order
= order
;
967 devres_add(dev
, devres
);
970 EXPORT_SYMBOL_GPL(devm_get_free_pages
);
973 * devm_free_pages - Resource-managed free_pages
974 * @dev: Device this memory belongs to
975 * @addr: Memory to free
977 * Free memory allocated with devm_get_free_pages(). Unlike free_pages,
978 * there is no need to supply the @order.
980 void devm_free_pages(struct device
*dev
, unsigned long addr
)
982 struct pages_devres devres
= { .addr
= addr
};
984 WARN_ON(devres_release(dev
, devm_pages_release
, devm_pages_match
,
987 EXPORT_SYMBOL_GPL(devm_free_pages
);