mirror of
https://github.com/gperftools/gperftools
synced 2024-12-22 07:20:01 +00:00
refresh README-s
This commit is contained in:
parent
bef6592746
commit
a1c7ce7793
18
README
18
README
@ -69,6 +69,10 @@ see INSTALL for more details. It is not currently available on Windows.
|
|||||||
|
|
||||||
HEAP CHECKER
|
HEAP CHECKER
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
Please note that as of gperftools-2.11 this is deprecated. You should
|
||||||
|
consider asan and other sanitizers instead.
|
||||||
|
|
||||||
See docs/heap_checker.html for information about how to use tcmalloc's
|
See docs/heap_checker.html for information about how to use tcmalloc's
|
||||||
heap checker.
|
heap checker.
|
||||||
|
|
||||||
@ -178,12 +182,14 @@ For a full list of variables, see the documentation pages:
|
|||||||
COMPILING ON NON-LINUX SYSTEMS
|
COMPILING ON NON-LINUX SYSTEMS
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Perftools was developed and tested on x86 Linux systems, and it works
|
Perftools was developed and tested on x86, aarch64 and riscv Linux
|
||||||
in its full generality only on those systems. However, we've
|
systems, and it works in its full generality only on those systems.
|
||||||
successfully ported much of the tcmalloc library to FreeBSD, Solaris
|
|
||||||
x86, and Darwin (Mac OS X) x86 and ppc; and we've ported the basic
|
However, we've successfully ported much of the tcmalloc library to
|
||||||
functionality in tcmalloc_minimal to Windows. See INSTALL for details.
|
FreeBSD, Solaris x86 (not tested recently though), and Mac OS X
|
||||||
See README_windows.txt for details on the Windows port.
|
(aarch64; x86 and ppc have not been tested recently); and we've ported
|
||||||
|
the basic functionality in tcmalloc_minimal to Windows. See INSTALL
|
||||||
|
for details. See README_windows.txt for details on the Windows port.
|
||||||
|
|
||||||
|
|
||||||
PERFORMANCE
|
PERFORMANCE
|
||||||
|
@ -5,7 +5,7 @@ is supported at this time. A working solution file exists in this
|
|||||||
directory:
|
directory:
|
||||||
gperftools.sln
|
gperftools.sln
|
||||||
|
|
||||||
You can load this solution file into VC++ 7.1 (Visual Studio 2003) or
|
You can load this solution file into Visual Studio 2015 or
|
||||||
later -- in the latter case, it will automatically convert the files
|
later -- in the latter case, it will automatically convert the files
|
||||||
to the latest format for you.
|
to the latest format for you.
|
||||||
|
|
||||||
@ -29,9 +29,9 @@ To use tcmalloc_minimal in your own projects, you should only need to
|
|||||||
build the dll and install it someplace, so you can link it into
|
build the dll and install it someplace, so you can link it into
|
||||||
further binaries. To use the dll, you need to add the following to
|
further binaries. To use the dll, you need to add the following to
|
||||||
the linker line of your executable:
|
the linker line of your executable:
|
||||||
"libtcmalloc_minimal.lib" /INCLUDE:"__tcmalloc"
|
"libtcmalloc_minimal.lib" /INCLUDE:"__tcmalloc"
|
||||||
|
|
||||||
Here is how to accomplish this in Visual Studio 2005 (VC8):
|
Here is how to accomplish this in Visual Studio 2015:
|
||||||
|
|
||||||
1) Have your executable depend on the tcmalloc library by selecting
|
1) Have your executable depend on the tcmalloc library by selecting
|
||||||
"Project Dependencies..." from the "Project" menu. Your executable
|
"Project Dependencies..." from the "Project" menu. Your executable
|
||||||
@ -72,30 +72,8 @@ such as the cpu-profiler and leak-checker, have not yet been ported to
|
|||||||
Windows at all.
|
Windows at all.
|
||||||
|
|
||||||
|
|
||||||
--- WIN64
|
|
||||||
|
|
||||||
The function-patcher has to disassemble code, and is very
|
|
||||||
x86-specific. However, the rest of perftools should work fine for
|
|
||||||
both x86 and x64. In particular, if you use the 'statically link with
|
|
||||||
libc, and replace its malloc with tcmalloc' approach, mentioned above,
|
|
||||||
it should be possible to use tcmalloc with 64-bit windows.
|
|
||||||
|
|
||||||
As of perftools 1.10, there is some support for disassembling x86_64
|
|
||||||
instructions, for work with win64. This work is preliminary, but the
|
|
||||||
test file preamble_patcher_test.cc is provided to play around with
|
|
||||||
that a bit. preamble_patcher_test will not compile on win32.
|
|
||||||
|
|
||||||
|
|
||||||
--- ISSUES
|
--- ISSUES
|
||||||
|
|
||||||
NOTE FOR WIN2K USERS: According to reports
|
|
||||||
(http://code.google.com/p/gperftools/issues/detail?id=127)
|
|
||||||
the stack-tracing necessary for the heap-profiler does not work on
|
|
||||||
Win2K. The best workaround is, if you are building on a Win2k system
|
|
||||||
is to add "/D NO_TCMALLOC_SAMPLES=" to your build, to turn off the
|
|
||||||
stack-tracing. You will not be able to use the heap-profiler if you
|
|
||||||
do this.
|
|
||||||
|
|
||||||
NOTE ON _MSIZE and _RECALLOC: The tcmalloc version of _msize returns
|
NOTE ON _MSIZE and _RECALLOC: The tcmalloc version of _msize returns
|
||||||
the size of the region tcmalloc allocated for you -- which is at least
|
the size of the region tcmalloc allocated for you -- which is at least
|
||||||
as many bytes you asked for, but may be more. (btw, these *are* bytes
|
as many bytes you asked for, but may be more. (btw, these *are* bytes
|
||||||
@ -116,5 +94,6 @@ them on the gperftools Google Code site:
|
|||||||
http://code.google.com/p/gperftools/issues/list
|
http://code.google.com/p/gperftools/issues/list
|
||||||
|
|
||||||
-- craig
|
-- craig
|
||||||
|
-- updated by alk on 31 July 2023
|
||||||
|
|
||||||
Last modified: 2 February 2012
|
Last modified: 31 July 2023
|
||||||
|
Loading…
Reference in New Issue
Block a user