1*053f45beSAndroid Build Coastguard Worker // SPDX-License-Identifier: GPL-2.0
2*053f45beSAndroid Build Coastguard Worker /*
3*053f45beSAndroid Build Coastguard Worker * hugepage-mmap:
4*053f45beSAndroid Build Coastguard Worker *
5*053f45beSAndroid Build Coastguard Worker * Example of using huge page memory in a user application using the mmap
6*053f45beSAndroid Build Coastguard Worker * system call. Before running this application, make sure that the
7*053f45beSAndroid Build Coastguard Worker * administrator has mounted the hugetlbfs filesystem (on some directory
8*053f45beSAndroid Build Coastguard Worker * like /mnt) using the command mount -t hugetlbfs nodev /mnt. In this
9*053f45beSAndroid Build Coastguard Worker * example, the app is requesting memory of size 256MB that is backed by
10*053f45beSAndroid Build Coastguard Worker * huge pages.
11*053f45beSAndroid Build Coastguard Worker *
12*053f45beSAndroid Build Coastguard Worker * For the ia64 architecture, the Linux kernel reserves Region number 4 for
13*053f45beSAndroid Build Coastguard Worker * huge pages. That means that if one requires a fixed address, a huge page
14*053f45beSAndroid Build Coastguard Worker * aligned address starting with 0x800000... will be required. If a fixed
15*053f45beSAndroid Build Coastguard Worker * address is not required, the kernel will select an address in the proper
16*053f45beSAndroid Build Coastguard Worker * range.
17*053f45beSAndroid Build Coastguard Worker * Other architectures, such as ppc64, i386 or x86_64 are not so constrained.
18*053f45beSAndroid Build Coastguard Worker */
19*053f45beSAndroid Build Coastguard Worker
20*053f45beSAndroid Build Coastguard Worker #include <stdlib.h>
21*053f45beSAndroid Build Coastguard Worker #include <stdio.h>
22*053f45beSAndroid Build Coastguard Worker #include <unistd.h>
23*053f45beSAndroid Build Coastguard Worker #include <sys/mman.h>
24*053f45beSAndroid Build Coastguard Worker #include <fcntl.h>
25*053f45beSAndroid Build Coastguard Worker
26*053f45beSAndroid Build Coastguard Worker #define FILE_NAME "huge/hugepagefile"
27*053f45beSAndroid Build Coastguard Worker #define LENGTH (256UL*1024*1024)
28*053f45beSAndroid Build Coastguard Worker #define PROTECTION (PROT_READ | PROT_WRITE)
29*053f45beSAndroid Build Coastguard Worker
30*053f45beSAndroid Build Coastguard Worker /* Only ia64 requires this */
31*053f45beSAndroid Build Coastguard Worker #ifdef __ia64__
32*053f45beSAndroid Build Coastguard Worker #define ADDR (void *)(0x8000000000000000UL)
33*053f45beSAndroid Build Coastguard Worker #define FLAGS (MAP_SHARED | MAP_FIXED)
34*053f45beSAndroid Build Coastguard Worker #else
35*053f45beSAndroid Build Coastguard Worker #define ADDR (void *)(0x0UL)
36*053f45beSAndroid Build Coastguard Worker #define FLAGS (MAP_SHARED)
37*053f45beSAndroid Build Coastguard Worker #endif
38*053f45beSAndroid Build Coastguard Worker
check_bytes(char * addr)39*053f45beSAndroid Build Coastguard Worker static void check_bytes(char *addr)
40*053f45beSAndroid Build Coastguard Worker {
41*053f45beSAndroid Build Coastguard Worker printf("First hex is %x\n", *((unsigned int *)addr));
42*053f45beSAndroid Build Coastguard Worker }
43*053f45beSAndroid Build Coastguard Worker
write_bytes(char * addr)44*053f45beSAndroid Build Coastguard Worker static void write_bytes(char *addr)
45*053f45beSAndroid Build Coastguard Worker {
46*053f45beSAndroid Build Coastguard Worker unsigned long i;
47*053f45beSAndroid Build Coastguard Worker
48*053f45beSAndroid Build Coastguard Worker for (i = 0; i < LENGTH; i++)
49*053f45beSAndroid Build Coastguard Worker *(addr + i) = (char)i;
50*053f45beSAndroid Build Coastguard Worker }
51*053f45beSAndroid Build Coastguard Worker
read_bytes(char * addr)52*053f45beSAndroid Build Coastguard Worker static int read_bytes(char *addr)
53*053f45beSAndroid Build Coastguard Worker {
54*053f45beSAndroid Build Coastguard Worker unsigned long i;
55*053f45beSAndroid Build Coastguard Worker
56*053f45beSAndroid Build Coastguard Worker check_bytes(addr);
57*053f45beSAndroid Build Coastguard Worker for (i = 0; i < LENGTH; i++)
58*053f45beSAndroid Build Coastguard Worker if (*(addr + i) != (char)i) {
59*053f45beSAndroid Build Coastguard Worker printf("Mismatch at %lu\n", i);
60*053f45beSAndroid Build Coastguard Worker return 1;
61*053f45beSAndroid Build Coastguard Worker }
62*053f45beSAndroid Build Coastguard Worker return 0;
63*053f45beSAndroid Build Coastguard Worker }
64*053f45beSAndroid Build Coastguard Worker
main(void)65*053f45beSAndroid Build Coastguard Worker int main(void)
66*053f45beSAndroid Build Coastguard Worker {
67*053f45beSAndroid Build Coastguard Worker void *addr;
68*053f45beSAndroid Build Coastguard Worker int fd, ret;
69*053f45beSAndroid Build Coastguard Worker
70*053f45beSAndroid Build Coastguard Worker fd = open(FILE_NAME, O_CREAT | O_RDWR, 0755);
71*053f45beSAndroid Build Coastguard Worker if (fd < 0) {
72*053f45beSAndroid Build Coastguard Worker perror("Open failed");
73*053f45beSAndroid Build Coastguard Worker exit(1);
74*053f45beSAndroid Build Coastguard Worker }
75*053f45beSAndroid Build Coastguard Worker
76*053f45beSAndroid Build Coastguard Worker addr = mmap(ADDR, LENGTH, PROTECTION, FLAGS, fd, 0);
77*053f45beSAndroid Build Coastguard Worker if (addr == MAP_FAILED) {
78*053f45beSAndroid Build Coastguard Worker perror("mmap");
79*053f45beSAndroid Build Coastguard Worker unlink(FILE_NAME);
80*053f45beSAndroid Build Coastguard Worker exit(1);
81*053f45beSAndroid Build Coastguard Worker }
82*053f45beSAndroid Build Coastguard Worker
83*053f45beSAndroid Build Coastguard Worker printf("Returned address is %p\n", addr);
84*053f45beSAndroid Build Coastguard Worker check_bytes(addr);
85*053f45beSAndroid Build Coastguard Worker write_bytes(addr);
86*053f45beSAndroid Build Coastguard Worker ret = read_bytes(addr);
87*053f45beSAndroid Build Coastguard Worker
88*053f45beSAndroid Build Coastguard Worker munmap(addr, LENGTH);
89*053f45beSAndroid Build Coastguard Worker close(fd);
90*053f45beSAndroid Build Coastguard Worker unlink(FILE_NAME);
91*053f45beSAndroid Build Coastguard Worker
92*053f45beSAndroid Build Coastguard Worker return ret;
93*053f45beSAndroid Build Coastguard Worker }
94