futex: bugfix for futex-key conflict when futex use hugepage
Subsystems (2)
PATCH 1/1 futex: bugfix for futex-key conflict when futex use hugepage
The futex-keys of processes share futex determined by page-offset, mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Assume there are two or more futexes in diffrent normal pages of the hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
This patch adds the normal page index in the compound page into the pgoff of futex-key.
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address as the 1st mutex's address, and use the return address with PAGE_SIZE added as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute, and lock the two mutexes.
3. The 1st thread create the 2nd thread, and the 2nd thread block on the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take the 2nd mutex, and may block forever.
include/linux/hugetlb.h +16 -0
@@ -358,6 +358,17 @@ static inline int hstate_index(struct hs return h - hstates; } +pgoff_t __basepage_index (struct page *page); + +/* Return page->index in PAGE_SIZE units */ +static inline pgoff_t basepage_index (struct page *page) +{ +if (!PageCompound (page)) +return page->index; + +return __basepage_index (page); +} +#else /* CONFIG_HUGETLB_PAGE */ struct hstate {};#define alloc_huge_page_node (h, nid) NULL
@@ -378,6 +389,11 @@ static inline unsigned int pages_per_hug }#define hstate_index_to_shift (index) 0#define hstate_index (h) 0 + +static inline pgoff_t basepage_index (struct page *page) +{ +return page->index; +}#endif /* CONFIG_HUGETLB_PAGE */ #endif /* _LINUX_HUGETLB_H */
kernel/futex.c +2 -1
@@ -61,6 +61,7 @@#include <linux/nsproxy.h> #include <linux/ptrace.h> #include <linux/sched/rt.h> +#include <linux/hugetlb.h> #include <asm/futex.h>
@@ -365,7 +366,7 @@ again: }else { key->both.offset |=FUT_OFF_INODE ;/* inode-based key */ key->shared.inode = page_head->mapping->host; - key->shared.pgoff = page_head->index; + key->shared.pgoff =basepage_index (page); }get_futex_key_refs (key);
mm/hugetlb.c +17 -0
@@ -690,6 +690,23 @@ int PageHuge(struct page *page) }EXPORT_SYMBOL_GPL (PageHuge); +pgoff_t __basepage_index (struct page *page) +{ +struct page *page_head =compound_head (page); +pgoff_t index =page_index (page_head); +int compound_idx; + +if (!PageHuge (page_head)) +return page_index (page); + +if (compound_order (page_head) >=MAX_ORDER ) + compound_idx =page_to_pfn (page) -page_to_pfn (page_head); +else + compound_idx = page - page_head; + +return (index <<compound_order (page_head)) + compound_idx; +} +static struct page *alloc_fresh_huge_page_node (struct hstate *h,int nid) {struct page *page;
Quoted 25 lines · Zhang Yi
The futex-keys of processes share futex determined by page-offset, mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Assume there are two or more futexes in diffrent normal pages of the hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
This patch adds the normal page index in the compound page into the pgoff of futex-key.
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address as the 1st mutex's address, and use the return address withPAGE_SIZEadded as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute, and lock the two mutexes.
3. The 1st thread create the 2nd thread, and the 2nd thread block on the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take the 2nd mutex, and may block forever.
Quoted 11 lines
Signed-off-by Zhang Yi <[email protected]>Tested-by Ma Chenggong <[email protected]>Reviewed-by Thomas Gleixner <[email protected]>Reviewed-by Darren Hart <[email protected]>Reviewed-by Dave Hansen <[email protected]>Reviewed-by Mel Gorman <[email protected]>Reviewed-by Liu Dong <[email protected]>Reviewed-by Cui Yunfeng <[email protected]>Reviewed-by Lu Zhongjun <[email protected]>Reviewed-by Jiang Biao <[email protected]>
Did all these people really review it? I just whinged about the last patch and didn't put a Reviewed-by on it. That said, I don't actually have a problem with this patch and I assumed it passed your testing so
The others might not agree though.
I note the conversion from int offset to long offset in futex_key appears to have gotten lost. Is that in a separate cleanup patch now?
Signature · 2 lines
Mel Gorman SUSE Labs
Mel Gorman <[email protected]> wrote on 2013/05/15 22:20:35:
Quoted 40 lines
Re: [PATCH] futex: bugfix for futex-key conflict when futex use hugepage
Quoted 25 lines · Zhang Yi
The futex-keys of processes share futex determined by page-offset, mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Assume there are two or more futexes in diffrent normal pages of the hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
This patch adds the normal page index in the compound page into the pgoff of futex-key.
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address as the 1st mutex's address, and use the return address withPAGE_SIZEadded as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute, and lock the two mutexes.
3. The 1st thread create the 2nd thread, and the 2nd thread block on the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take the 2nd mutex, and may block forever.Quoted 11 lines
Signed-off-by Zhang Yi <[email protected]>Tested-by Ma Chenggong <[email protected]>Reviewed-by Thomas Gleixner <[email protected]>Reviewed-by Darren Hart <[email protected]>Reviewed-by Dave Hansen <[email protected]>Reviewed-by Mel Gorman <[email protected]>Reviewed-by Liu Dong <[email protected]>Reviewed-by Cui Yunfeng <[email protected]>Reviewed-by Lu Zhongjun <[email protected]>Reviewed-by Jiang Biao <[email protected]>
Quoted 1 line
Did all these people really review it? I just whinged about the last
patch
Quoted 3 lines
and didn't put a Reviewed-by on it. That said, I don't actually have a problem with this patch and I assumed it passed your testing so
I mistakenly think that I should list all the people here. : ) Shall I cleanup the name list and send the patch again?
Quoted 6 lines
Reviewed-by Mel Gorman <[email protected]>The others might not agree though.
I note the conversion from int offset to long offset in
futex_keyappears to have gotten lost. Is that in a separate cleanup patch now?
In old patch, I add the compound index into offset, so I make the offset from int
to long. It is unnecessary for this patch.
Quoted 4 lines
--
Mel Gorman
SUSE Labs
BTW, Does anyone have other advices for the patch?
Quoted 45 lines · On 05/15/2013 06:16 PM, [email protected] wrote:
Mel Gorman <[email protected]> wrote on 2013/05/15 22:20:35:
Quoted 40 lines
Re: [PATCH] futex: bugfix for futex-key conflict when futex use hugepage
Quoted 36 lines · Zhang Yi
The futex-keys of processes share futex determined by page-offset, mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Assume there are two or more futexes in diffrent normal pages of the hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
This patch adds the normal page index in the compound page into the pgoff of futex-key.
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address as the 1st mutex's address, and use the return address withPAGE_SIZEadded as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute, and lock the two mutexes.
3. The 1st thread create the 2nd thread, and the 2nd thread block on the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take the 2nd mutex, and may block forever.Signed-off-by Zhang Yi <[email protected]>Tested-by Ma Chenggong <[email protected]>Reviewed-by Thomas Gleixner <[email protected]>Reviewed-by Darren Hart <[email protected]>Reviewed-by Dave Hansen <[email protected]>Reviewed-by Mel Gorman <[email protected]>Reviewed-by Liu Dong <[email protected]>Reviewed-by Cui Yunfeng <[email protected]>Reviewed-by Lu Zhongjun <[email protected]>Reviewed-by Jiang Biao <[email protected]>
Quoted 14 lines
Quoted 1 line
Did all these people really review it? I just whinged about the last
patch
Quoted 3 lines
and didn't put a Reviewed-by on it. That said, I don't actually have a problem with this patch and I assumed it passed your testing so
I mistakenly think that I should list all the people here. : ) Shall I cleanup the name list and send the patch again?
Quoted 6 lines
Reviewed-by Mel Gorman <[email protected]>The others might not agree though.
I note the conversion from int offset to long offset in
futex_keyappears to have gotten lost. Is that in a separate cleanup patch now?
In general, you should not add someone's signature unless they gave it first or explicitly gave you permission to do so. If you want to indicate they were contacted, you can use the "Cc:" tag instead of "Reviewed-by".
Quoted 3 lines
In old patch, I add the compound index into offset, so I make the offset from int to long. It is unnecessary for this patch.
pgoff_t is an unsigned long, and page_to_pfn() returns an unsigned long. Since compound_idx can be assigned from page_to_pfn() and it is added with index in the return value, unsigned long seems like a better choice to me. Is there a specific reason you prefer an int? It might be "fine" but it is likely to raise eyebrows whenever someone read through it.
Thanks,
Signature · 3 lines
Darren Hart Intel Open Source Technology Center Yocto Project - Technical Lead - Linux Kernel
Darren Hart <[email protected]> wrote on 2013/05/16 09:30:31:
Quoted 7 lines
pgoff_tis an unsigned long, andpage_to_pfn()returns an unsigned long. Sincecompound_idxcan be assigned frompage_to_pfn()and it is added with index in the return value, unsigned long seems like a better choice to me. Is there a specific reason you prefer an int? It might be "fine" but it is likely to raise eyebrows whenever someone read through it.
No other specific reason. I just think that int is enough.
Quoted 11 lines · On Thu, 2013-05-16 at 10:00 +0800, [email protected] wrote:
Darren Hart <[email protected]> wrote on 2013/05/16 09:30:31:
Quoted 7 lines
pgoff_tis an unsigned long, andpage_to_pfn()returns an unsigned long. Sincecompound_idxcan be assigned frompage_to_pfn()and it is added with index in the return value, unsigned long seems like a better choice to me. Is there a specific reason you prefer an int? It might be "fine" but it is likely to raise eyebrows whenever someone read through it.No other specific reason. I just think that int is enough.
Hi Yi,
I believe this patch is still pending a final version from you. Mel and I both asked after the change of compound_idx from int to unsigned long. While "int" may be adequate, for consistency with the return type assigned and such, the unsigned long is preferred. Could you respin and send along the patch so Thomas can pull it in?
Thanks,
Signature · 3 lines
Darren Hart Intel Open Source Technology Center Yocto Project - Technical Lead - Linux Kernel
The futex-keys of processes share futex determined by page-offset, mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Assume there are two or more futexes in diffrent normal pages of the hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
This patch adds the normal page index in the compound page into the pgoff of futex-key.
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address as the 1st mutex's address, and use the return address with PAGE_SIZE added as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute, and lock the two mutexes.
3. The 1st thread create the 2nd thread, and the 2nd thread block on the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take the 2nd mutex, and may block forever.
include/linux/hugetlb.h +16 -0
@@ -358,6 +358,17 @@ static inline int hstate_index(struct hs return h - hstates; } +pgoff_t __basepage_index (struct page *page); + +/* Return page->index in PAGE_SIZE units */ +static inline pgoff_t basepage_index (struct page *page) +{ +if (!PageCompound (page)) +return page->index; + +return __basepage_index (page); +} +#else /* CONFIG_HUGETLB_PAGE */ struct hstate {};#define alloc_huge_page_node (h, nid) NULL
@@ -378,6 +389,11 @@ static inline unsigned int pages_per_hug }#define hstate_index_to_shift (index) 0#define hstate_index (h) 0 + +static inline pgoff_t basepage_index (struct page *page) +{ +return page->index; +}#endif /* CONFIG_HUGETLB_PAGE */ #endif /* _LINUX_HUGETLB_H */
kernel/futex.c +2 -1
@@ -61,6 +61,7 @@#include <linux/nsproxy.h> #include <linux/ptrace.h> #include <linux/sched/rt.h> +#include <linux/hugetlb.h> #include <asm/futex.h>
@@ -365,7 +366,7 @@ again: }else { key->both.offset |=FUT_OFF_INODE ;/* inode-based key */ key->shared.inode = page_head->mapping->host; - key->shared.pgoff = page_head->index; + key->shared.pgoff =basepage_index (page); }get_futex_key_refs (key);
mm/hugetlb.c +17 -0
@@ -690,6 +690,23 @@ int PageHuge(struct page *page) }EXPORT_SYMBOL_GPL (PageHuge); +pgoff_t __basepage_index (struct page *page) +{ +struct page *page_head =compound_head (page); +pgoff_t index =page_index (page_head); +unsigned long compound_idx; + +if (!PageHuge (page_head)) +return page_index (page); + +if (compound_order (page_head) >=MAX_ORDER ) + compound_idx =page_to_pfn (page) -page_to_pfn (page_head); +else + compound_idx = page - page_head; + +return (index <<compound_order (page_head)) + compound_idx; +} +static struct page *alloc_fresh_huge_page_node (struct hstate *h,int nid) {struct page *page;
Darren Hart
Acked-byHi Zhang Yi,
Thanks for turning around an update so quickly. The code itself looks ready to me. We try to maintain a high level of quality in the commit message as well to help with understanding complex systems such as futexes.
Quoted 1 line · Zhang Yi
The futex-keys of processes share futex determined by page-offset,
"share futex" is rather confusing to me. Maybe:
The futex-key is determined by page-offset, ...
Quoted 2 lines
mapping-host, and mapping-index of the user space address. User appications using hugepage for futex may lead to futex-key conflict.
Please take care with spelling. Grammar issues aren't as critical, but please enable spell checking in your editor.
applications
hugepages for futexes
conflicts
Quoted 2 lines
Assume there are two or more futexes in diffrent normal pages of the
different
Quoted 2 lines
hugepage, and each futex has the same offset in its normal page, causing all the futexes have the same futex-key.
then all the futexes will have the same futex-key.
Quoted 3 lines
This patch adds the normal page index in the compound page into the pgoff of futex-key.
of the futex_key.
Quoted 3 lines
Steps to reproduce the bug:
1. The 1st thread map a file of hugetlbfs, and use the return address
maps
uses
Quoted 1 line
as the 1st mutex's address, and use the return address with
PAGE_SIZE
uses
Quoted 2 lines
added as the 2nd mutex's address.
2. The 1st thread initialize the two mutexes with pshared attribute,
initializes
the pshared attribute,
Quoted 1 line
and lock the two mutexes.
locks
Quoted 1 line
3. The 1st thread create the 2nd thread, and the 2nd thread block on
creates
blocks
Quoted 2 lines
the 1st mutex.
4. The 1st thread create the 3rd thread, and the 3rd thread block on
creates
blocks
Quoted 2 lines
the 2nd mutex.
5. The 1st thread unlock the 2nd mutex, the 3rd thread cannot take
unlocks
Quoted 6 lines
the 2nd mutex, and may block forever.
Signed-off-by Zhang Yi <[email protected]>Tested-by Ma Chenggong <[email protected]>Reviewed-by Jiang Biao <[email protected]>
Otherwise this looks ready to me. Thomas, do you want a resend with commit message corrections or do you prefer to integrate those yourself?
With the above fixes:
Quoted 82 lines
diff -uprN
linux-3.10-rc7.org/include/linux/hugetlb.hlinux-3.10-rc7/include/linux/hugetlb.hinclude/linux/hugetlb.h +16
-0@@ -358,6 +358,17 @@ static inline int hstate_index(struct hs return h - hstates; } +pgoff_t __basepage_index (struct page *page); + +/* Return page->index in PAGE_SIZE units */ +static inline pgoff_t basepage_index (struct page *page) +{ +if (!PageCompound (page)) +return page->index; + +return __basepage_index (page); +} +#else /* CONFIG_HUGETLB_PAGE */ struct hstate {};#define alloc_huge_page_node (h, nid) NULL@@ -378,6 +389,11 @@ static inline unsigned int pages_per_hug }#define hstate_index_to_shift (index) 0#define hstate_index (h) 0 + +static inline pgoff_t basepage_index (struct page *page) +{ +return page->index; +}#endif /* CONFIG_HUGETLB_PAGE */ #endif /* _LINUX_HUGETLB_H */ diff -uprN
linux-3.10-rc7.org/kernel/futex.clinux-3.10-rc7/kernel/futex.ckernel/futex.c +2
-1@@ -61,6 +61,7 @@#include <linux/nsproxy.h> #include <linux/ptrace.h> #include <linux/sched/rt.h> +#include <linux/hugetlb.h> #include <asm/futex.h> @@ -365,7 +366,7 @@ again: }else { key->both.offset |=FUT_OFF_INODE ;/* inode-based key */ key->shared.inode = page_head->mapping->host; - key->shared.pgoff = page_head->index; + key->shared.pgoff =basepage_index (page); }get_futex_key_refs (key);diff -uprN
linux-3.10-rc7.org/mm/hugetlb.clinux-3.10-rc7/mm/hugetlb.cmm/hugetlb.c +17
-0@@ -690,6 +690,23 @@ int PageHuge(struct page *page) }EXPORT_SYMBOL_GPL (PageHuge); +pgoff_t __basepage_index (struct page *page) +{ +struct page *page_head =compound_head (page); +pgoff_t index =page_index (page_head); +unsigned long compound_idx; + +if (!PageHuge (page_head)) +return page_index (page); + +if (compound_order (page_head) >=MAX_ORDER ) + compound_idx =page_to_pfn (page) -page_to_pfn (page_head); +else + compound_idx = page - page_head; + +return (index <<compound_order (page_head)) + compound_idx; +} +static struct page *alloc_fresh_huge_page_node (struct hstate *h,int nid) {struct page *page;
Signature · 3 lines
Darren Hart Intel Open Source Technology Center Yocto Project - Technical Lead - Linux Kernel
Quoted 7 lines · Darren Hart
Otherwise this looks ready to me. Thomas, do you want a resend with commit message corrections or do you prefer to integrate those yourself?
With the above fixes:
Acked-by Darren Hart <[email protected]>
I pick it up and fix it. We delayed it long enough already.
Thanks,
tglx
tip-bot for Zhang Yi
merge bot[tip:core/locking] futex: Take hugepages into account when generating futex_key
In reply to Zhang Yifutex: Take hugepages into account when generating futex_key
Commit-ID: 13d60f4b6ab5b702dc8d2ee20999f98a93728aec Gitweb: http://git.kernel.org/tip/13d60f4b6ab5b702dc8d2ee20999f98a93728aec Author: Zhang Yi <[email protected]> AuthorDate: Tue, 25 Jun 2013 21:19:31 +0800 Committer: Thomas Gleixner <[email protected]> CommitDate: Tue, 25 Jun 2013 23:11:19 +0200
futex: Take hugepages into account when generating futex_key
The futex_keys of process shared futexes are generated from the page offset, the mapping host and the mapping index of the futex user space address. This should result in an unique identifier for each futex.
Though this is not true when futexes are located in different subpages of an hugepage. The reason is, that the mapping index for all those futexes evaluates to the index of the base page of the hugetlbfs mapping. So a futex at offset 0 of the hugepage mapping and another one at offset PAGE_SIZE of the same hugepage mapping have identical futex_keys. This happens because the futex code blindly uses page->index.
Steps to reproduce the bug:
1. Map a file from hugetlbfs. Initialize pthread_mutex1 at offset 0 and pthread_mutex2 at offset PAGE_SIZE of the hugetlbfs mapping.
The mutexes must be initialized as PTHREAD_PROCESS_SHARED because PTHREAD_PROCESS_PRIVATE mutexes are not affected by this issue as their keys solely depend on the user space address.
2. Lock mutex1 and mutex2
3. Create thread1 and in the thread function lock mutex1, which results in thread1 blocking on the locked mutex1.
4. Create thread2 and in the thread function lock mutex2, which results in thread2 blocking on the locked mutex2.
5. Unlock mutex2. Despite the fact that mutex2 got unlocked, thread2 still blocks on mutex2 because the futex_key points to mutex1.
To solve this issue we need to take the normal page index of the page which contains the futex into account, if the futex is in an hugetlbfs mapping. In other words, we calculate the normal page mapping index of the subpage in the hugetlbfs mapping.
Mappings which are not based on hugetlbfs are not affected and still use page->index.
Thanks to Mel Gorman who provided a patch for adding proper evaluation functions to the hugetlbfs code to avoid exposing hugetlbfs specific details to the futex code.
[ tglx: Massaged changelog ]
--- include/linux/hugetlb.h | 16 ++++++++++++++++ kernel/futex.c | 3 ++- mm/hugetlb.c | 17 +++++++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-)
include/linux/hugetlb.h +16 -0
@@ -358,6 +358,17 @@ static inline int hstate_index(struct hstate *h) return h - hstates; } +pgoff_t __basepage_index (struct page *page); + +/* Return page->index in PAGE_SIZE units */ +static inline pgoff_t basepage_index (struct page *page) +{ +if (!PageCompound (page)) +return page->index; + +return __basepage_index (page); +} +#else /* CONFIG_HUGETLB_PAGE */ struct hstate {};#define alloc_huge_page_node (h, nid) NULL
@@ -378,6 +389,11 @@ static inline unsigned int pages_per_huge_page(struct hstate *h) }#define hstate_index_to_shift (index) 0#define hstate_index (h) 0 + +static inline pgoff_t basepage_index (struct page *page) +{ +return page->index; +}#endif /* CONFIG_HUGETLB_PAGE */ #endif /* _LINUX_HUGETLB_H */
kernel/futex.c +2 -1
@@ -61,6 +61,7 @@#include <linux/nsproxy.h> #include <linux/ptrace.h> #include <linux/sched/rt.h> +#include <linux/hugetlb.h> #include <asm/futex.h>
@@ -365,7 +366,7 @@ again: }else { key->both.offset |=FUT_OFF_INODE ;/* inode-based key */ key->shared.inode = page_head->mapping->host; - key->shared.pgoff = page_head->index; + key->shared.pgoff =basepage_index (page); }get_futex_key_refs (key);
mm/hugetlb.c +17 -0
@@ -690,6 +690,23 @@ int PageHuge(struct page *page) }EXPORT_SYMBOL_GPL (PageHuge); +pgoff_t __basepage_index (struct page *page) +{ +struct page *page_head =compound_head (page); +pgoff_t index =page_index (page_head); +unsigned long compound_idx; + +if (!PageHuge (page_head)) +return page_index (page); + +if (compound_order (page_head) >=MAX_ORDER ) + compound_idx =page_to_pfn (page) -page_to_pfn (page_head); +else + compound_idx = page - page_head; + +return (index <<compound_order (page_head)) + compound_idx; +} +static struct page *alloc_fresh_huge_page_node (struct hstate *h,int nid) {struct page *page;