dax : Fix documentation with respect to struct pages
Subsystems (2)
PATCH 1/1 dax : Fix documentation with respect to struct pages
The documentation for dax is not up to date with respect to the struct page support available in some of the device drivers that utilize it.
Signed-off-by Stephen Bates <[email protected]>
--- Documentation/filesystems/dax.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)
Documentation/filesystems/dax.txt +9 -6
@@ -123,9 +123,12 @@ The DAX code does not work correctly on architectures which have virtually mapped caches such as ARM, MIPS and SPARC. Calling get_user_pages() on a range of user memory that has been mmaped -from a DAX file will fail as there are no 'struct page' to describe -those pages. This problem is being worked on. That means that O_DIRECT -reads/writes to those memory ranges from a non-DAX file will fail (note -that O_DIRECT reads/writes _of a DAX file_ do work, it is the memory -that is being accessed that is key here). Other things that will not -work include RDMA, sendfile() and splice(). +from a DAX file will fail when there are no 'struct page' to describe +those pages. This problem has been addressed in some device drivers +by adding optional struct page support for pages under the control of +the driver (see CONFIG_NVDIMM_PFN in drivers/nvdimm for an example of +how to do this). In the non struct page cases O_DIRECT reads/writes to +those memory ranges from a non-DAX file will fail (note that O_DIRECT +reads/writes _of a DAX file_ do work, it is the memory that is being +accessed that is key here). Other things that will not work in the +non struct page case include RDMA, sendfile() and splice().
Signature · 1 line
2.5.0
Quoted 5 lines · Stephen Bates
The documentation for dax is not up to date with respect to the struct page support available in some of the device drivers that utilize it.
Signed-off-by Stephen Bates <[email protected]>
Great, thanks for updating this.
Acked-by Ross Zwisler <[email protected]>
Quoted 30 lines
--- Documentation/filesystems/dax.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)Documentation/filesystems/dax.txt +9
-6@@ -123,9 +123,12 @@ The DAX code does not work correctly on architectures which have virtually mapped caches such as ARM, MIPS and SPARC. Calling get_user_pages() on a range of user memory that has been mmaped -from a DAX file will fail as there are no 'struct page' to describe -those pages. This problem is being worked on. That means that O_DIRECT -reads/writes to those memory ranges from a non-DAX file will fail (note -that O_DIRECT reads/writes _of a DAX file_ do work, it is the memory -that is being accessed that is key here). Other things that will not -work include RDMA, sendfile() and splice(). +from a DAX file will fail when there are no 'struct page' to describe +those pages. This problem has been addressed in some device drivers +by adding optional struct page support for pages under the control of +the driver (see CONFIG_NVDIMM_PFN in drivers/nvdimm for an example of +how to do this). In the non struct page cases O_DIRECT reads/writes to +those memory ranges from a non-DAX file will fail (note that O_DIRECT +reads/writes _of a DAX file_ do work, it is the memory that is being +accessed that is key here). Other things that will not work in the +non struct page case include RDMA, sendfile() and splice().Signature · 1 line
2.5.0
Quoted 10 lines · On Tue, 27 Sep 2016 10:52:48 -0600 Ross Zwisler <[email protected]>…
Quoted 5 lines · Stephen Bates
The documentation for dax is not up to date with respect to the struct page support available in some of the device drivers that utilize it.
Signed-off-by Stephen Bates <[email protected]>Great, thanks for updating this.
Acked-by Ross Zwisler <[email protected]>
Applied to the docs tree, thanks.
jon