Skip to content

Large Page Support for Code Issue: 16198 #21064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
suresh-srinivas wants to merge 29 commits into from
Closed

Large Page Support for Code Issue: 16198 #21064

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
0a76c7e
Initial Large Page (2M) support for node.js
suresh-srinivas Mar 23, 2018
fa0e324
Add support for checking if explicitHugePages and transparentHugePage…
suresh-srinivas Mar 26, 2018
fdb45cd
Added License headers
suresh-srinivas Mar 30, 2018
b7791c2
Get rid of waring messages & code cleanup
suresh-srinivas Mar 30, 2018
6631eea
Protect the large pages under #ifdef NODE_ENABLE_LARGE_CODE_PAGES and…
suresh-srinivas Apr 4, 2018
843089c
Added configure option to enable huge pages
uttampawar Apr 9, 2018
077bc01
Added else clause to set node_use_large_pages=false by default
uttampawar Apr 9, 2018
7bdd9fc
Merge branch 'configure_fixes' into 2M-Pages-For-Code-16198
uttampawar Apr 9, 2018
b91de5a
Finished adding checks at appropriate places to handle possible error…
uttampawar May 8, 2018
7ef956a
Changed return type for two function from void to int
uttampawar May 9, 2018
b02e7a9
Fixed lint errors.
uttampawar May 24, 2018
2af82b1
Added one more condition check for verify the start address of newly …
uttampawar May 26, 2018
cae9285
Fixed syntax error due to wring data type. int64 to int64_t
uttampawar May 30, 2018
30114b6
Removed explictHugePages code
suresh-srinivas May 30, 2018
39e1f0d
Merge branch 'add-checks' into 2M-Pages-For-Code-16198
suresh-srinivas May 30, 2018
49cd0de
Merge branch '2M-Pages-For-Code-16198' of https://github.intel.com/DS…
suresh-srinivas May 30, 2018
2dd9e8c
Added Large Page Support
suresh-srinivas May 30, 2018
51d0f02
Merge branch 'intel-large-pages' of https://github.com/suresh-sriniva…
suresh-srinivas May 31, 2018
2f672ee
Update PR based on feedback
suresh-srinivas Jun 1, 2018
31504cc
Addressing the additional PR feedback
suresh-srinivas Jun 3, 2018
f998c58
Fix the gypi style issue
suresh-srinivas Jun 3, 2018
9f15cfc
Update with stylistic changes (eg char* instead of char *, IsLargePag…
suresh-srinivas Jun 4, 2018
d6de361
Add additional guard so large pages is only under Linux and target_ar…
suresh-srinivas Jun 4, 2018
29c7d13
Style fixes according to the Node C++ Style Guide
suresh-srinivas Jun 4, 2018
9828036
Eliminate ld.script and use implicit script
suresh-srinivas Jun 7, 2018
600cf54
Add #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
suresh-srinivas Jun 7, 2018
bf259e2
Fix the test failures
suresh-srinivas Jun 7, 2018
f0a6dcb
Add detailed help message to configure --with-largepages
suresh-srinivas Jun 8, 2018
4610793
Fix style issues and created inline functions instead of macros for a…
suresh-srinivas Jun 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Style fixes according to the Node C++ Style Guide 
     i) CamelCase for methods, functions
    ii) snake_case for variables/structs
   iii) indentation (dont indent code inside namespace)
  • Loading branch information
@suresh-srinivas
suresh-srinivas committed Jun 4, 2018
commit 29c7d13aadd7984454281e1a4f4a6c771a9aa18a
2 changes: 1 addition & 1 deletion src/node.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4380,7 +4380,7 @@ int Start(int argc, char** argv) {

#ifdef NODE_ENABLE_LARGE_CODE_PAGES
if (node::IsLargePagesEnabled()) {
if ((node::map_static_code_to_large_pages()) != 0) {
if ((node::MapStaticCodeToLargePages()) != 0) {
fprintf(stderr, "Reverting to default page size\n");
}
}
Expand Down
302 changes: 151 additions & 151 deletions src/node_large_page.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,91 +62,91 @@ namespace node {
#define PAGE_ALIGN_UP(x, a) ALIGN(x, a)
#define PAGE_ALIGN_DOWN(x, a) ((x) & ~((a) - 1))
Copy link
Copy Markdown
Member

@addaleax addaleax Jun 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style nit: these could all be inline functions, right?

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Yes fixed them to be inline functions.


struct TextRegion {
struct text_region {
char* from;
char* to;
int total_hugepages;
bool found_text_region;
int total_hugepages;
bool found_text_region;
};

Copy link
Copy Markdown
Member

@gireeshpunathil gireeshpunathil Jun 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how many of these fields are used?
can we follow a consistent variable naming convention? (camel casing vs snake casing etc.) I suggest look around in node.cc for the prevailing nomenclature.

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will look and make it consistent.

static void printSystemError(int error) {
fprintf(stderr, "Hugepages WARNING: %s\n", strerror(error));
return;
}
static void PrintSystemError(int error) {
fprintf(stderr, "Hugepages WARNING: %s\n", strerror(error));
return;
}

// The format of the maps file is the following
// address perms offset dev inode pathname
// 00400000-00452000 r-xp 00000000 08:02 173521 /usr/bin/dbus-daemon

static struct TextRegion find_node_text_region() {
std::ifstream ifs;
std::string map_line;
std::string permission;
char dash;
int64_t start, end;
const size_t hps = 2L * 1024 * 1024;
struct TextRegion nregion;

nregion.found_text_region = false;

ifs.open("/proc/self/maps");
if (!ifs) {
fprintf(stderr, "Could not open /proc/self/maps\n");
return nregion;
}
std::getline(ifs, map_line);
std::istringstream iss(map_line);
ifs.close();

iss >> std::hex >> start;
iss >> dash;
iss >> std::hex >> end;
iss >> permission;

if (permission.compare("r-xp") == 0) {
start = reinterpret_cast<unsigned int64_t>(&__nodetext);
char* from = reinterpret_cast<char *>PAGE_ALIGN_UP(start, hps);
char* to = reinterpret_cast<char *>PAGE_ALIGN_DOWN(end, hps);

if (from < to) {
size_t size = to - from;
nregion.found_text_region = true;
nregion.from = from;
nregion.to = to;
nregion.total_hugepages = size / hps;
}
}

return nregion;
static struct text_region FindNodeTextRegion() {
std::ifstream ifs;
std::string map_line;
std::string permission;
char dash;
int64_t start, end;
const size_t hps = 2L * 1024 * 1024;
struct text_region nregion;

nregion.found_text_region = false;

ifs.open("/proc/self/maps");
if (!ifs) {
fprintf(stderr, "Could not open /proc/self/maps\n");
return nregion;
}
std::getline(ifs, map_line);
std::istringstream iss(map_line);
ifs.close();

iss >> std::hex >> start;
iss >> dash;
iss >> std::hex >> end;
iss >> permission;

if (permission.compare("r-xp") == 0) {
start = reinterpret_cast<unsigned int64_t>(&__nodetext);
char* from = reinterpret_cast<char *>PAGE_ALIGN_UP(start, hps);
char* to = reinterpret_cast<char *>PAGE_ALIGN_DOWN(end, hps);
Copy link
Copy Markdown
Member

@addaleax addaleax Jun 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style nit: left-leaning pointers (e.g. char*), and I would not rely on the implicit parentheses added by the macros here

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Fixed.


if (from < to) {
size_t size = to - from;
nregion.found_text_region = true;
nregion.from = from;
nregion.to = to;
nregion.total_hugepages = size / hps;
}
}

static bool IsTransparentHugePagesEnabled() {
std::ifstream ifs;
return nregion;
}

ifs.open("/sys/kernel/mm/transparent_hugepage/enabled");
if (!ifs) {
fprintf(stderr, "Could not open file: " \
"/sys/kernel/mm/transparent_hugepage/enabled\n");
return false;
}
static bool IsTransparentHugePagesEnabled() {
std::ifstream ifs;

std::string always, madvise, never;
if (ifs.is_open()) {
while (ifs >> always >> madvise >> never) {}
}
ifs.open("/sys/kernel/mm/transparent_hugepage/enabled");
if (!ifs) {
fprintf(stderr, "Could not open file: " \
"/sys/kernel/mm/transparent_hugepage/enabled\n");
return false;
}

int ret_status = false;
std::string always, madvise, never;
if (ifs.is_open()) {
while (ifs >> always >> madvise >> never) {}
}

if (always.compare("[always]") == 0)
ret_status = true;
else if (madvise.compare("[madvise]") == 0)
ret_status = true;
else if (never.compare("[never]") == 0)
ret_status = false;
int ret_status = false;

ifs.close();
return ret_status;
}
if (always.compare("[always]") == 0)
ret_status = true;
else if (madvise.compare("[madvise]") == 0)
ret_status = true;
else if (never.compare("[never]") == 0)
ret_status = false;

ifs.close();
return ret_status;
}

// Moving the text region to large pages. We need to be very careful.
// a) This function itself should not be moved.
Expand All @@ -157,97 +157,97 @@ struct TextRegion {
// the same virtual address
// 3. madvise with MADV_HUGE_PAGE
// 3. If successful copy the code there and unmap the original region
int
__attribute__((__section__(".eh_frame")))
__attribute__((__aligned__(2 * 1024 * 1024)))
__attribute__((__noinline__))
__attribute__((__optimize__("2")))
move_text_region_to_large_pages(struct TextRegion r) {
void* nmem = nullptr;
void* tmem = nullptr;
int ret = 0;

size_t size = r.to - r.from;
void* start = r.from;

// Allocate temporary region preparing for copy
nmem = mmap(nullptr, size,
PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
if (nmem == MAP_FAILED) {
printSystemError(errno);
return -1;
}

memcpy(nmem, r.from, size);
int
__attribute__((__section__(".eh_frame")))
__attribute__((__aligned__(2 * 1024 * 1024)))
__attribute__((__noinline__))
__attribute__((__optimize__("2")))
MoveTextRegionToLargePages(struct text_region r) {
void* nmem = nullptr;
void* tmem = nullptr;
int ret = 0;

size_t size = r.to - r.from;
void* start = r.from;

// Allocate temporary region preparing for copy
nmem = mmap(nullptr, size,
PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
if (nmem == MAP_FAILED) {
PrintSystemError(errno);
return -1;
}

memcpy(nmem, r.from, size);

// We already know the original page is r-xp
// (PROT_READ, PROT_EXEC, MAP_PRIVATE)
// We want PROT_WRITE because we are writing into it.
// We want it at the fixed address and we use MAP_FIXED.
tmem = mmap(start, size,
PROT_READ | PROT_WRITE | PROT_EXEC,
MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1 , 0);
if (tmem == MAP_FAILED) {
printSystemError(errno);
munmap(nmem, size);
return -1;
}

ret = madvise(tmem, size, MADV_HUGEPAGE);
if (ret == -1) {
printSystemError(errno);
ret = munmap(tmem, size);
if (ret == -1) {
printSystemError(errno);
}
ret = munmap(nmem, size);
if (ret == -1) {
printSystemError(errno);
}

return -1;
}

memcpy(start, nmem, size);
ret = mprotect(start, size, PROT_READ | PROT_EXEC);
if (ret == -1) {
printSystemError(errno);
ret = munmap(tmem, size);
if (ret == -1) {
printSystemError(errno);
}
ret = munmap(nmem, size);
if (ret == -1) {
printSystemError(errno);
}
return -1;
}

// Release the old/temporary mapped region
ret = munmap(nmem, size);
if (ret == -1) {
printSystemError(errno);
}

return ret;
tmem = mmap(start, size,
PROT_READ | PROT_WRITE | PROT_EXEC,
MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1 , 0);
if (tmem == MAP_FAILED) {
PrintSystemError(errno);
munmap(nmem, size);
return -1;
}

ret = madvise(tmem, size, MADV_HUGEPAGE);
if (ret == -1) {
PrintSystemError(errno);
ret = munmap(tmem, size);
if (ret == -1) {
PrintSystemError(errno);
}
ret = munmap(nmem, size);
if (ret == -1) {
PrintSystemError(errno);
}

// This is the primary API called from main
int map_static_code_to_large_pages() {
struct TextRegion r = find_node_text_region();
if (r.found_text_region == false) {
fprintf(stderr, "Hugepages WARNING: failed to find text region \n");
return -1;
}

if (r.to <= reinterpret_cast<void *> (&move_text_region_to_large_pages))
return move_text_region_to_large_pages(r);
return -1;
}

return -1;
memcpy(start, nmem, size);
ret = mprotect(start, size, PROT_READ | PROT_EXEC);
if (ret == -1) {
PrintSystemError(errno);
ret = munmap(tmem, size);
if (ret == -1) {
PrintSystemError(errno);
}

bool IsLargePagesEnabled() {
return IsTransparentHugePagesEnabled();
ret = munmap(nmem, size);
if (ret == -1) {
PrintSystemError(errno);
}
return -1;
}

// Release the old/temporary mapped region
ret = munmap(nmem, size);
if (ret == -1) {
PrintSystemError(errno);
}

return ret;
}

// This is the primary API called from main
int MapStaticCodeToLargePages() {
struct text_region r = FindNodeTextRegion();
if (r.found_text_region == false) {
fprintf(stderr, "Hugepages WARNING: failed to find text region \n");
return -1;
}

if (r.to <= reinterpret_cast<void *> (&MoveTextRegionToLargePages))
return MoveTextRegionToLargePages(r);

return -1;
}

bool IsLargePagesEnabled() {
Copy link
Copy Markdown
Member

@addaleax addaleax Jun 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style nit: there is an extra space after bool

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Fixed this too.

return IsTransparentHugePagesEnabled();
}

} // namespace node
Copy link
Copy Markdown
Member

@bnoordhuis bnoordhuis Jun 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I admit I kinda checked out after the first 100 lines. This file has so many style errors, can you fix those first, please?

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you be specific? I ran the make -s lint and fixed all the ones pointed to by that.

Copy link
Copy Markdown
Member

@bnoordhuis bnoordhuis Jun 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The linter doesn't catch everything but to name three things:

  1. Inconsistent indentation.
  2. Star leans left in pointers (void* p, not void *p or void * p.)
  3. Casing: IsLargePagesEnabled, not isLargePagesEnabled.

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I have updated the PR with 2) and 3). I am using standard indentation of 2 spaces.

Copy link
Copy Markdown
Member

@addaleax addaleax Jun 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@suresh-srinivas There’s https://github.com/nodejs/node/blob/master/CPP_STYLE_GUIDE.md that would help a lot with this. Also, comparing with other code in our codebase if you’re unsure. :)

(In particular, we don’t indent code inside namespaces)

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax thanks much. I will look at this and fix styles accordingly.

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax @bnoordhuis @gireeshpunathil fixed the style errors. Let me know if you see anything else.

2 changes: 1 addition & 1 deletion src/node_large_page.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

namespace node {
Copy link
Copy Markdown
Contributor

@gabrielschulhof gabrielschulhof Jun 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be enclosed in

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

Copy link
Copy Markdown
Contributor Author

@suresh-srinivas suresh-srinivas Jun 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I fixed it.

bool IsLargePagesEnabled();
int map_static_code_to_large_pages();
int MapStaticCodeToLargePages();
} // namespace node

#endif // SRC_NODE_LARGE_PAGE_H_
Expand Down