[mirror_ubuntu-jammy-kernel.git] / mm / gup_test.c

#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <linux/ktime.h>
#include <linux/debugfs.h>
#include "gup_test.h"

static void put_back_pages(unsigned int cmd, struct page **pages,
			   unsigned long nr_pages, unsigned int gup_test_flags)
{
	unsigned long i;

	switch (cmd) {
	case GUP_FAST_BENCHMARK:
	case GUP_BASIC_TEST:
		for (i = 0; i < nr_pages; i++)
			put_page(pages[i]);
		break;

	case PIN_FAST_BENCHMARK:
	case PIN_BASIC_TEST:
	case PIN_LONGTERM_BENCHMARK:
		unpin_user_pages(pages, nr_pages);
		break;
	case DUMP_USER_PAGES_TEST:
		if (gup_test_flags & GUP_TEST_FLAG_DUMP_PAGES_USE_PIN) {
			unpin_user_pages(pages, nr_pages);
		} else {
			for (i = 0; i < nr_pages; i++)
				put_page(pages[i]);

		}
		break;
	}
}

static void verify_dma_pinned(unsigned int cmd, struct page **pages,
			      unsigned long nr_pages)
{
	unsigned long i;
	struct page *page;

	switch (cmd) {
	case PIN_FAST_BENCHMARK:
	case PIN_BASIC_TEST:
	case PIN_LONGTERM_BENCHMARK:
		for (i = 0; i < nr_pages; i++) {
			page = pages[i];
			if (WARN(!page_maybe_dma_pinned(page),
				 "pages[%lu] is NOT dma-pinned\n", i)) {

				dump_page(page, "gup_test failure");
				break;
			} else if (cmd == PIN_LONGTERM_BENCHMARK &&
				WARN(!is_pinnable_page(page),
				     "pages[%lu] is NOT pinnable but pinned\n",
				     i)) {
				dump_page(page, "gup_test failure");
				break;
			}
		}
		break;
	}
}

static void dump_pages_test(struct gup_test *gup, struct page **pages,
			    unsigned long nr_pages)
{
	unsigned int index_to_dump;
	unsigned int i;

	/*
	 * Zero out any user-supplied page index that is out of range. Remember:
	 * .which_pages[] contains a 1-based set of page indices.
	 */
	for (i = 0; i < GUP_TEST_MAX_PAGES_TO_DUMP; i++) {
		if (gup->which_pages[i] > nr_pages) {
			pr_warn("ZEROING due to out of range: .which_pages[%u]: %u\n",
				i, gup->which_pages[i]);
			gup->which_pages[i] = 0;
		}
	}

	for (i = 0; i < GUP_TEST_MAX_PAGES_TO_DUMP; i++) {
		index_to_dump = gup->which_pages[i];

		if (index_to_dump) {
			index_to_dump--; // Decode from 1-based, to 0-based
			pr_info("---- page #%u, starting from user virt addr: 0x%llx\n",
				index_to_dump, gup->addr);
			dump_page(pages[index_to_dump],
				  "gup_test: dump_pages() test");
		}
	}
}

static int __gup_test_ioctl(unsigned int cmd,
		struct gup_test *gup)
{
	ktime_t start_time, end_time;
	unsigned long i, nr_pages, addr, next;
	long nr;
	struct page **pages;
	int ret = 0;
	bool needs_mmap_lock =
		cmd != GUP_FAST_BENCHMARK && cmd != PIN_FAST_BENCHMARK;

	if (gup->size > ULONG_MAX)
		return -EINVAL;

	nr_pages = gup->size / PAGE_SIZE;
	pages = kvcalloc(nr_pages, sizeof(void *), GFP_KERNEL);
	if (!pages)
		return -ENOMEM;

	if (needs_mmap_lock && mmap_read_lock_killable(current->mm)) {
		ret = -EINTR;
		goto free_pages;
	}

	i = 0;
	nr = gup->nr_pages_per_call;
	start_time = ktime_get();
	for (addr = gup->addr; addr < gup->addr + gup->size; addr = next) {
		if (nr != gup->nr_pages_per_call)
			break;

		next = addr + nr * PAGE_SIZE;
		if (next > gup->addr + gup->size) {
			next = gup->addr + gup->size;
			nr = (next - addr) / PAGE_SIZE;
		}

		switch (cmd) {
		case GUP_FAST_BENCHMARK:
			nr = get_user_pages_fast(addr, nr, gup->gup_flags,
						 pages + i);
			break;
		case GUP_BASIC_TEST:
			nr = get_user_pages(addr, nr, gup->gup_flags, pages + i,
					    NULL);
			break;
		case PIN_FAST_BENCHMARK:
			nr = pin_user_pages_fast(addr, nr, gup->gup_flags,
						 pages + i);
			break;
		case PIN_BASIC_TEST:
			nr = pin_user_pages(addr, nr, gup->gup_flags, pages + i,
					    NULL);
			break;
		case PIN_LONGTERM_BENCHMARK:
			nr = pin_user_pages(addr, nr,
					    gup->gup_flags | FOLL_LONGTERM,
					    pages + i, NULL);
			break;
		case DUMP_USER_PAGES_TEST:
			if (gup->test_flags & GUP_TEST_FLAG_DUMP_PAGES_USE_PIN)
				nr = pin_user_pages(addr, nr, gup->gup_flags,
						    pages + i, NULL);
			else
				nr = get_user_pages(addr, nr, gup->gup_flags,
						    pages + i, NULL);
			break;
		default:
			ret = -EINVAL;
			goto unlock;
		}

		if (nr <= 0)
			break;
		i += nr;
	}
	end_time = ktime_get();

	/* Shifting the meaning of nr_pages: now it is actual number pinned: */
	nr_pages = i;

	gup->get_delta_usec = ktime_us_delta(end_time, start_time);
	gup->size = addr - gup->addr;

	/*
	 * Take an un-benchmark-timed moment to verify DMA pinned
	 * state: print a warning if any non-dma-pinned pages are found:
	 */
	verify_dma_pinned(cmd, pages, nr_pages);

	if (cmd == DUMP_USER_PAGES_TEST)
		dump_pages_test(gup, pages, nr_pages);

	start_time = ktime_get();

	put_back_pages(cmd, pages, nr_pages, gup->test_flags);

	end_time = ktime_get();
	gup->put_delta_usec = ktime_us_delta(end_time, start_time);

unlock:
	if (needs_mmap_lock)
		mmap_read_unlock(current->mm);
free_pages:
	kvfree(pages);
	return ret;
}

static long gup_test_ioctl(struct file *filep, unsigned int cmd,
		unsigned long arg)
{
	struct gup_test gup;
	int ret;

	switch (cmd) {
	case GUP_FAST_BENCHMARK:
	case PIN_FAST_BENCHMARK:
	case PIN_LONGTERM_BENCHMARK:
	case GUP_BASIC_TEST:
	case PIN_BASIC_TEST:
	case DUMP_USER_PAGES_TEST:
		break;
	default:
		return -EINVAL;
	}

	if (copy_from_user(&gup, (void __user *)arg, sizeof(gup)))
		return -EFAULT;

	ret = __gup_test_ioctl(cmd, &gup);
	if (ret)
		return ret;

	if (copy_to_user((void __user *)arg, &gup, sizeof(gup)))
		return -EFAULT;

	return 0;
}

static const struct file_operations gup_test_fops = {
	.open = nonseekable_open,
	.unlocked_ioctl = gup_test_ioctl,
};

static int __init gup_test_init(void)
{
	debugfs_create_file_unsafe("gup_test", 0600, NULL, NULL,
				   &gup_test_fops);

	return 0;
}

late_initcall(gup_test_init);
Commit	Line	Data
64c349f4 KS	1	#include <linux/kernel.h>
	2	#include <linux/mm.h>
	3	#include <linux/slab.h>
	4	#include <linux/uaccess.h>
	5	#include <linux/ktime.h>
	6	#include <linux/debugfs.h>
b9dcfdff	7	#include "gup_test.h"
64c349f4	8
41c45d37	9	static void put_back_pages(unsigned int cmd, struct page **pages,
f4f9bda4	10	unsigned long nr_pages, unsigned int gup_test_flags)
41c45d37 JH	11	{
	12	unsigned long i;
	13
	14	switch (cmd) {
	15	case GUP_FAST_BENCHMARK:
a9bed1e1	16	case GUP_BASIC_TEST:
41c45d37 JH	17	for (i = 0; i < nr_pages; i++)
	18	put_page(pages[i]);
	19	break;
	20
	21	case PIN_FAST_BENCHMARK:
a9bed1e1	22	case PIN_BASIC_TEST:
657d4f79	23	case PIN_LONGTERM_BENCHMARK:
41c45d37 JH	24	unpin_user_pages(pages, nr_pages);
41c45d37 JH	25	break;
f4f9bda4 JH	26	case DUMP_USER_PAGES_TEST:
	27	if (gup_test_flags & GUP_TEST_FLAG_DUMP_PAGES_USE_PIN) {
	28	unpin_user_pages(pages, nr_pages);
	29	} else {
	30	for (i = 0; i < nr_pages; i++)
	31	put_page(pages[i]);
	32
	33	}
	34	break;
41c45d37 JH	35	}
	36	}
	37
	38	static void verify_dma_pinned(unsigned int cmd, struct page **pages,
	39	unsigned long nr_pages)
	40	{
	41	unsigned long i;
	42	struct page *page;
	43
	44	switch (cmd) {
	45	case PIN_FAST_BENCHMARK:
a9bed1e1	46	case PIN_BASIC_TEST:
657d4f79	47	case PIN_LONGTERM_BENCHMARK:
41c45d37 JH	48	for (i = 0; i < nr_pages; i++) {
	49	page = pages[i];
	50	if (WARN(!page_maybe_dma_pinned(page),
	51	"pages[%lu] is NOT dma-pinned\n", i)) {
	52
9c84f229	53	dump_page(page, "gup_test failure");
41c45d37	54	break;
e44605a8 PT	55	} else if (cmd == PIN_LONGTERM_BENCHMARK &&
	56	WARN(!is_pinnable_page(page),
	57	"pages[%lu] is NOT pinnable but pinned\n",
	58	i)) {
	59	dump_page(page, "gup_test failure");
	60	break;
41c45d37 JH	61	}
	62	}
	63	break;
	64	}
	65	}
	66
f4f9bda4 JH	67	static void dump_pages_test(struct gup_test gup, struct page *pages,
	68	unsigned long nr_pages)
	69	{
	70	unsigned int index_to_dump;
	71	unsigned int i;
	72
	73	/*
	74	* Zero out any user-supplied page index that is out of range. Remember:
	75	* .which_pages[] contains a 1-based set of page indices.
	76	*/
	77	for (i = 0; i < GUP_TEST_MAX_PAGES_TO_DUMP; i++) {
	78	if (gup->which_pages[i] > nr_pages) {
	79	pr_warn("ZEROING due to out of range: .which_pages[%u]: %u\n",
	80	i, gup->which_pages[i]);
	81	gup->which_pages[i] = 0;
	82	}
	83	}
	84
	85	for (i = 0; i < GUP_TEST_MAX_PAGES_TO_DUMP; i++) {
	86	index_to_dump = gup->which_pages[i];
	87
	88	if (index_to_dump) {
	89	index_to_dump--; // Decode from 1-based, to 0-based
	90	pr_info("---- page #%u, starting from user virt addr: 0x%llx\n",
	91	index_to_dump, gup->addr);
	92	dump_page(pages[index_to_dump],
	93	"gup_test: dump_pages() test");
	94	}
	95	}
	96	}
	97
9c84f229 JH	98	static int __gup_test_ioctl(unsigned int cmd,
9c84f229 JH	99	struct gup_test *gup)
64c349f4 KS	100	{
64c349f4 KS	101	ktime_t start_time, end_time;
51896864	102	unsigned long i, nr_pages, addr, next;
79dbf135	103	long nr;
64c349f4	104	struct page **pages;
a7c46c0c	105	int ret = 0;
f3964599 JH	106	bool needs_mmap_lock =
f3964599 JH	107	cmd != GUP_FAST_BENCHMARK && cmd != PIN_FAST_BENCHMARK;
64c349f4	108
4b408c74 DC	109	if (gup->size > ULONG_MAX)
	110	return -EINVAL;
	111
64c349f4	112	nr_pages = gup->size / PAGE_SIZE;
778e1cdd	113	pages = kvcalloc(nr_pages, sizeof(void *), GFP_KERNEL);
64c349f4 KS	114	if (!pages)
	115	return -ENOMEM;
	116
f3964599 JH	117	if (needs_mmap_lock && mmap_read_lock_killable(current->mm)) {
	118	ret = -EINTR;
	119	goto free_pages;
	120	}
	121
64c349f4 KS	122	i = 0;
	123	nr = gup->nr_pages_per_call;
	124	start_time = ktime_get();
	125	for (addr = gup->addr; addr < gup->addr + gup->size; addr = next) {
	126	if (nr != gup->nr_pages_per_call)
	127	break;
	128
	129	next = addr + nr * PAGE_SIZE;
	130	if (next > gup->addr + gup->size) {
	131	next = gup->addr + gup->size;
	132	nr = (next - addr) / PAGE_SIZE;
	133	}
	134
714a3a1e KB	135	switch (cmd) {
714a3a1e KB	136	case GUP_FAST_BENCHMARK:
79dbf135	137	nr = get_user_pages_fast(addr, nr, gup->gup_flags,
714a3a1e KB	138	pages + i);
714a3a1e KB	139	break;
a9bed1e1	140	case GUP_BASIC_TEST:
79dbf135	141	nr = get_user_pages(addr, nr, gup->gup_flags, pages + i,
714a3a1e KB	142	NULL);
714a3a1e KB	143	break;
41c45d37	144	case PIN_FAST_BENCHMARK:
79dbf135	145	nr = pin_user_pages_fast(addr, nr, gup->gup_flags,
41c45d37 JH	146	pages + i);
41c45d37 JH	147	break;
a9bed1e1	148	case PIN_BASIC_TEST:
79dbf135	149	nr = pin_user_pages(addr, nr, gup->gup_flags, pages + i,
41c45d37 JH	150	NULL);
41c45d37 JH	151	break;
657d4f79 BS	152	case PIN_LONGTERM_BENCHMARK:
657d4f79 BS	153	nr = pin_user_pages(addr, nr,
79dbf135	154	gup->gup_flags \| FOLL_LONGTERM,
657d4f79 BS	155	pages + i, NULL);
657d4f79 BS	156	break;
f4f9bda4	157	case DUMP_USER_PAGES_TEST:
79dbf135 PT	158	if (gup->test_flags & GUP_TEST_FLAG_DUMP_PAGES_USE_PIN)
79dbf135 PT	159	nr = pin_user_pages(addr, nr, gup->gup_flags,
f4f9bda4 JH	160	pages + i, NULL);
f4f9bda4 JH	161	else
79dbf135	162	nr = get_user_pages(addr, nr, gup->gup_flags,
f4f9bda4 JH	163	pages + i, NULL);
f4f9bda4 JH	164	break;
714a3a1e	165	default:
a7c46c0c	166	ret = -EINVAL;
f3964599	167	goto unlock;
714a3a1e KB	168	}
714a3a1e KB	169
09e35a4a MT	170	if (nr <= 0)
09e35a4a MT	171	break;
64c349f4 KS	172	i += nr;
	173	}
	174	end_time = ktime_get();
	175
41c45d37 JH	176	/* Shifting the meaning of nr_pages: now it is actual number pinned: */
	177	nr_pages = i;
	178
26db3d09	179	gup->get_delta_usec = ktime_us_delta(end_time, start_time);
64c349f4 KS	180	gup->size = addr - gup->addr;
64c349f4 KS	181
41c45d37 JH	182	/*
	183	* Take an un-benchmark-timed moment to verify DMA pinned
	184	* state: print a warning if any non-dma-pinned pages are found:
	185	*/
	186	verify_dma_pinned(cmd, pages, nr_pages);
	187
f4f9bda4 JH	188	if (cmd == DUMP_USER_PAGES_TEST)
	189	dump_pages_test(gup, pages, nr_pages);
	190
26db3d09	191	start_time = ktime_get();
41c45d37	192
79dbf135	193	put_back_pages(cmd, pages, nr_pages, gup->test_flags);
41c45d37	194
26db3d09 KB	195	end_time = ktime_get();
26db3d09 KB	196	gup->put_delta_usec = ktime_us_delta(end_time, start_time);
64c349f4	197
f3964599 JH	198	unlock:
	199	if (needs_mmap_lock)
	200	mmap_read_unlock(current->mm);
	201	free_pages:
64c349f4	202	kvfree(pages);
a7c46c0c	203	return ret;
64c349f4 KS	204	}
64c349f4 KS	205
9c84f229	206	static long gup_test_ioctl(struct file *filep, unsigned int cmd,
64c349f4 KS	207	unsigned long arg)
64c349f4 KS	208	{
9c84f229	209	struct gup_test gup;
64c349f4 KS	210	int ret;
64c349f4 KS	211
714a3a1e KB	212	switch (cmd) {
714a3a1e KB	213	case GUP_FAST_BENCHMARK:
41c45d37	214	case PIN_FAST_BENCHMARK:
657d4f79	215	case PIN_LONGTERM_BENCHMARK:
a9bed1e1 JH	216	case GUP_BASIC_TEST:
a9bed1e1 JH	217	case PIN_BASIC_TEST:
f4f9bda4	218	case DUMP_USER_PAGES_TEST:
714a3a1e KB	219	break;
714a3a1e KB	220	default:
64c349f4	221	return -EINVAL;
714a3a1e	222	}
64c349f4 KS	223
	224	if (copy_from_user(&gup, (void __user *)arg, sizeof(gup)))
	225	return -EFAULT;
	226
9c84f229	227	ret = __gup_test_ioctl(cmd, &gup);
64c349f4 KS	228	if (ret)
	229	return ret;
	230
	231	if (copy_to_user((void __user *)arg, &gup, sizeof(gup)))
	232	return -EFAULT;
	233
	234	return 0;
	235	}
	236
9c84f229	237	static const struct file_operations gup_test_fops = {
64c349f4	238	.open = nonseekable_open,
9c84f229	239	.unlocked_ioctl = gup_test_ioctl,
64c349f4 KS	240	};
64c349f4 KS	241
afaa7888	242	static int __init gup_test_init(void)
64c349f4	243	{
9c84f229 JH	244	debugfs_create_file_unsafe("gup_test", 0600, NULL, NULL,
9c84f229 JH	245	&gup_test_fops);
64c349f4 KS	246
	247	return 0;
	248	}
	249
9c84f229	250	late_initcall(gup_test_init);