mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-05 02:19:51 +00:00
![Joonsoo Kim](/assets/img/avatar_default.png)
Many developers already know that field for reference count of the struct page is _count and atomic type. They would try to handle it directly and this could break the purpose of page reference count tracepoint. To prevent direct _count modification, this patch rename it to _refcount and add warning message on the code. After that, developer who need to handle reference count will find that field should not be accessed directly. [akpm@linux-foundation.org: fix comments, per Vlastimil] [akpm@linux-foundation.org: Documentation/vm/transhuge.txt too] [sfr@canb.auug.org.au: sync ethernet driver changes] Signed-off-by: Joonsoo Kim <iamjoonsoo.kim@lge.com> Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au> Cc: Vlastimil Babka <vbabka@suse.cz> Cc: Hugh Dickins <hughd@google.com> Cc: Johannes Berg <johannes@sipsolutions.net> Cc: "David S. Miller" <davem@davemloft.net> Cc: Sunil Goutham <sgoutham@cavium.com> Cc: Chris Metcalf <cmetcalf@mellanox.com> Cc: Manish Chopra <manish.chopra@qlogic.com> Cc: Yuval Mintz <yuval.mintz@qlogic.com> Cc: Tariq Toukan <tariqt@mellanox.com> Cc: Saeed Mahameed <saeedm@mellanox.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
173 lines
4.7 KiB
C
173 lines
4.7 KiB
C
#ifndef _LINUX_PAGE_REF_H
|
|
#define _LINUX_PAGE_REF_H
|
|
|
|
#include <linux/atomic.h>
|
|
#include <linux/mm_types.h>
|
|
#include <linux/page-flags.h>
|
|
#include <linux/tracepoint-defs.h>
|
|
|
|
extern struct tracepoint __tracepoint_page_ref_set;
|
|
extern struct tracepoint __tracepoint_page_ref_mod;
|
|
extern struct tracepoint __tracepoint_page_ref_mod_and_test;
|
|
extern struct tracepoint __tracepoint_page_ref_mod_and_return;
|
|
extern struct tracepoint __tracepoint_page_ref_mod_unless;
|
|
extern struct tracepoint __tracepoint_page_ref_freeze;
|
|
extern struct tracepoint __tracepoint_page_ref_unfreeze;
|
|
|
|
#ifdef CONFIG_DEBUG_PAGE_REF
|
|
|
|
/*
|
|
* Ideally we would want to use the trace_<tracepoint>_enabled() helper
|
|
* functions. But due to include header file issues, that is not
|
|
* feasible. Instead we have to open code the static key functions.
|
|
*
|
|
* See trace_##name##_enabled(void) in include/linux/tracepoint.h
|
|
*/
|
|
#define page_ref_tracepoint_active(t) static_key_false(&(t).key)
|
|
|
|
extern void __page_ref_set(struct page *page, int v);
|
|
extern void __page_ref_mod(struct page *page, int v);
|
|
extern void __page_ref_mod_and_test(struct page *page, int v, int ret);
|
|
extern void __page_ref_mod_and_return(struct page *page, int v, int ret);
|
|
extern void __page_ref_mod_unless(struct page *page, int v, int u);
|
|
extern void __page_ref_freeze(struct page *page, int v, int ret);
|
|
extern void __page_ref_unfreeze(struct page *page, int v);
|
|
|
|
#else
|
|
|
|
#define page_ref_tracepoint_active(t) false
|
|
|
|
static inline void __page_ref_set(struct page *page, int v)
|
|
{
|
|
}
|
|
static inline void __page_ref_mod(struct page *page, int v)
|
|
{
|
|
}
|
|
static inline void __page_ref_mod_and_test(struct page *page, int v, int ret)
|
|
{
|
|
}
|
|
static inline void __page_ref_mod_and_return(struct page *page, int v, int ret)
|
|
{
|
|
}
|
|
static inline void __page_ref_mod_unless(struct page *page, int v, int u)
|
|
{
|
|
}
|
|
static inline void __page_ref_freeze(struct page *page, int v, int ret)
|
|
{
|
|
}
|
|
static inline void __page_ref_unfreeze(struct page *page, int v)
|
|
{
|
|
}
|
|
|
|
#endif
|
|
|
|
static inline int page_ref_count(struct page *page)
|
|
{
|
|
return atomic_read(&page->_refcount);
|
|
}
|
|
|
|
static inline int page_count(struct page *page)
|
|
{
|
|
return atomic_read(&compound_head(page)->_refcount);
|
|
}
|
|
|
|
static inline void set_page_count(struct page *page, int v)
|
|
{
|
|
atomic_set(&page->_refcount, v);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_set))
|
|
__page_ref_set(page, v);
|
|
}
|
|
|
|
/*
|
|
* Setup the page count before being freed into the page allocator for
|
|
* the first time (boot or memory hotplug)
|
|
*/
|
|
static inline void init_page_count(struct page *page)
|
|
{
|
|
set_page_count(page, 1);
|
|
}
|
|
|
|
static inline void page_ref_add(struct page *page, int nr)
|
|
{
|
|
atomic_add(nr, &page->_refcount);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod))
|
|
__page_ref_mod(page, nr);
|
|
}
|
|
|
|
static inline void page_ref_sub(struct page *page, int nr)
|
|
{
|
|
atomic_sub(nr, &page->_refcount);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod))
|
|
__page_ref_mod(page, -nr);
|
|
}
|
|
|
|
static inline void page_ref_inc(struct page *page)
|
|
{
|
|
atomic_inc(&page->_refcount);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod))
|
|
__page_ref_mod(page, 1);
|
|
}
|
|
|
|
static inline void page_ref_dec(struct page *page)
|
|
{
|
|
atomic_dec(&page->_refcount);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod))
|
|
__page_ref_mod(page, -1);
|
|
}
|
|
|
|
static inline int page_ref_sub_and_test(struct page *page, int nr)
|
|
{
|
|
int ret = atomic_sub_and_test(nr, &page->_refcount);
|
|
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod_and_test))
|
|
__page_ref_mod_and_test(page, -nr, ret);
|
|
return ret;
|
|
}
|
|
|
|
static inline int page_ref_dec_and_test(struct page *page)
|
|
{
|
|
int ret = atomic_dec_and_test(&page->_refcount);
|
|
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod_and_test))
|
|
__page_ref_mod_and_test(page, -1, ret);
|
|
return ret;
|
|
}
|
|
|
|
static inline int page_ref_dec_return(struct page *page)
|
|
{
|
|
int ret = atomic_dec_return(&page->_refcount);
|
|
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod_and_return))
|
|
__page_ref_mod_and_return(page, -1, ret);
|
|
return ret;
|
|
}
|
|
|
|
static inline int page_ref_add_unless(struct page *page, int nr, int u)
|
|
{
|
|
int ret = atomic_add_unless(&page->_refcount, nr, u);
|
|
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_mod_unless))
|
|
__page_ref_mod_unless(page, nr, ret);
|
|
return ret;
|
|
}
|
|
|
|
static inline int page_ref_freeze(struct page *page, int count)
|
|
{
|
|
int ret = likely(atomic_cmpxchg(&page->_refcount, count, 0) == count);
|
|
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_freeze))
|
|
__page_ref_freeze(page, count, ret);
|
|
return ret;
|
|
}
|
|
|
|
static inline void page_ref_unfreeze(struct page *page, int count)
|
|
{
|
|
VM_BUG_ON_PAGE(page_count(page) != 0, page);
|
|
VM_BUG_ON(count == 0);
|
|
|
|
atomic_set(&page->_refcount, count);
|
|
if (page_ref_tracepoint_active(__tracepoint_page_ref_unfreeze))
|
|
__page_ref_unfreeze(page, count);
|
|
}
|
|
|
|
#endif
|