Update the HOWTO to show hugectl usage for configuring runtime
environments. Also add a reference to the hugectl man page.
Signed-off-by: Eric B Munson <[EMAIL PROTECTED]>
---
HOWTO | 28 +++++++++++++++++++++++-----
1 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/HOWTO b/HOWTO
index b8defca..7da26bc 100644
--- a/HOWTO
+++ b/HOWTO
@@ -252,20 +252,28 @@ environment variables:
version and use it for malloc(). From this point all malloc()s
should come from hugepage memory until it runs out.
-Usually it's preferable to set these environment variables on the
-command line of the program you wish to run, rather than using
-"export", because you'll only want to enable the hugepage malloc() for
-particular programs, not everything.
+It is preferable to use the hugectl (see: man 8 hugectl) utility to
+configure libhugetlbfs environment variables through the manual method
+is still supported.
Examples:
If you've installed libhugetlbfs in the default place (under
/usr/local) which is in the system library search path use:
+
+ $ hugectl --library-use-path --heap <your app command line>
+
+or
+
$ LD_PRELOAD=libhugetlbfs.so HUGETLB_MORECORE=yes <your app command line>
If you have built libhugetlbfs in ~/libhugetlbfs and haven't installed
it yet, the following would work for a 64-bit program:
+ $ hugectl --library-use-path --heap <your app command line>
+
+or
+
$ LD_PRELOAD=libhugetlbfs.so LD_LIBRARY_PATH=~/libhugetlbfs/obj64 \
HUGETLB_MORECORE=yes <your app command line>
@@ -319,7 +327,11 @@ set when calling shmget() and the pool is large enough.
For hugepage-unaware
applications, libhugetlbfs overrides shmget and adds the SHM_HUGETLB if the
environment variable HUGETLB_SHM is set to "yes". The steps to use hugepages
with applications not linked to libhugetlbfs are similar to morecore except
-for step 3.
+for step 3 when using the manual method.
+
+ $ hugectl --shm <your app command line>
+
+or
1. Set LD_PRELOAD=libhugetlbfs.so
This tells the dynamic linker to load the libhugetlbfs shared
@@ -488,6 +500,12 @@ segments to be placed in hugepages:
HUGETLB_ELFMAP=RW All segments (text/data/BSS)
HUGETLB_ELFMAP=no No segments
+Individual segment remapping can be requested using hugectl, if the binary has
+been aligned properly, by specifying one of the following options: --text for
+text segment, --data for the data segment, or --bss for the bss segement.
+Any combination of these options is valid.
+
+
Default remapping behavior:
---------------------------
--
1.5.6.1
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Libhugetlbfs-devel mailing list
Libhugetlbfs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/libhugetlbfs-devel
