Skip to content

Commit 3d1db47

Browse files
fanchenkong1fanchenkong1
committed
build,src: fix Intel VTune profiling support
This change fix the Intel Vtune profiling support for JITted JavaScript on IA32 / X64 / X32 platform. The advantage of this profiling is that the user / developer of NodeJS application can get the detailed profiling information for every line of the JavaScript source code. This information will be very useful for the owner to optimize their applications. This feature is a compile-time option. For windows platform, the user needs to pass the following parameter to vcbuild.bat: "enable-vtune" For other OS, the user needs to pass the following parameter to ./configure command: "--enable-vtune-profiling" Fixes: #29060
1 parent 0991dfc commit 3d1db47

26 files changed

+10042
-1
lines changed

‎configure.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,13 @@
155155
help="Generate an executable with libgcc and libstdc++ libraries. This "
156156
"will not work on OSX when using the default compilation environment")
157157

158+
parser.add_argument("--enable-vtune-profiling",
159+
action="store_true",
160+
dest="enable_vtune_profiling",
161+
help="Enable profiling support for Intel VTune profiler to profile "
162+
"JavaScript code executed in Node.js. This feature is only available "
163+
"for x32, x86, and x64 architectures.")
164+
158165
parser.add_argument("--enable-pgo-generate",
159166
action="store_true",
160167
dest="enable_pgo_generate",
@@ -1207,6 +1214,15 @@ def configure_node(o):
12071214
if flavor == 'aix':
12081215
o['variables']['node_target_type'] = 'static_library'
12091216

1217+
if target_arch in ('x86', 'x64', 'ia32', 'x32'):
1218+
o['variables']['node_enable_v8_vtunejit'] = b(options.enable_vtune_profiling)
1219+
elif options.enable_vtune_profiling:
1220+
raise Exception(
1221+
'The VTune profiler for JavaScript is only supported on x32, x86, and x64 '
1222+
'architectures.')
1223+
else:
1224+
o['variables']['node_enable_v8_vtunejit'] = 'false'
1225+
12101226
if flavor != 'linux' and (options.enable_pgo_generate or options.enable_pgo_use):
12111227
raise Exception(
12121228
'The pgo option is supported only on linux.')

‎deps/v8/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,4 @@ bazel-v8
122122
/third_party/zlib/contrib/bench
123123
/third_party/zlib/contrib/tests
124124
/third_party/zlib/google/test
125+
!/third_party/ittapi

‎deps/v8/third_party/ittapi/CMakeLists.txt

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
#/* <copyright>
2+
# This file is provided under a dual BSD/GPLv2 license. When using or
3+
# redistributing this file, you may do so under either license.
4+
#
5+
# GPL LICENSE SUMMARY
6+
#
7+
# Copyright (c) 2005-2017 Intel Corporation. All rights reserved.
8+
#
9+
# This program is free software; you can redistribute it and/or modify
10+
# it under the terms of version 2 of the GNU General Public License as
11+
# published by the Free Software Foundation.
12+
#
13+
# This program is distributed in the hope that it will be useful, but
14+
# WITHOUT ANY WARRANTY; without even the implied warranty of
15+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16+
# General Public License for more details.
17+
#
18+
# You should have received a copy of the GNU General Public License
19+
# along with this program; if not, write to the Free Software
20+
# Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21+
# The full GNU General Public License is included in this distribution
22+
# in the file called LICENSE.GPL.
23+
#
24+
# Contact Information:
25+
# http://software.intel.com/en-us/articles/intel-vtune-amplifier-xe/
26+
#
27+
# BSD LICENSE
28+
#
29+
# Copyright (c) 2005-2017 Intel Corporation. All rights reserved.
30+
# All rights reserved.
31+
#
32+
# Redistribution and use in source and binary forms, with or without
33+
# modification, are permitted provided that the following conditions
34+
# are met:
35+
#
36+
# * Redistributions of source code must retain the above copyright
37+
# notice, this list of conditions and the following disclaimer.
38+
# * Redistributions in binary form must reproduce the above copyright
39+
# notice, this list of conditions and the following disclaimer in
40+
# the documentation and/or other materials provided with the
41+
# distribution.
42+
# * Neither the name of Intel Corporation nor the names of its
43+
# contributors may be used to endorse or promote products derived
44+
# from this software without specific prior written permission.
45+
#
46+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
47+
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
48+
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
49+
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
50+
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
51+
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
52+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
53+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
54+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
55+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
56+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57+
#</copyright> */
58+
#********************************************************************************************************************************************************************************************************************************************************************************************
59+
60+
cmake_minimum_required(VERSION 2.8)
61+
62+
project(ittapi)
63+
64+
OPTION(FORCE_32 "Force a 32bit compile on 64bit" OFF)
65+
66+
IF(FORCE_32 AND UNIX)
67+
SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32")
68+
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32")
69+
ENDIF()
70+
71+
if(CMAKE_SIZEOF_VOID_P MATCHES "8" AND NOT(FORCE_32))
72+
set(ARCH_64 1)
73+
endif()
74+
75+
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
76+
add_definitions(-D_DEBUG)
77+
if (NOT WIN32)
78+
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
79+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g")
80+
endif()
81+
else()
82+
if (NOT WIN32)
83+
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2")
84+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O2")
85+
endif()
86+
add_definitions(-DNDEBUG)
87+
endif()
88+
89+
set(LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)
90+
91+
foreach( OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES} )
92+
string( TOUPPER ${OUTPUTCONFIG} OUTPUTCONFIG )
93+
set( CMAKE_LIBRARY_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${LIBRARY_OUTPUT_PATH} )
94+
endforeach( OUTPUTCONFIG CMAKE_CONFIGURATION_TYPES )
95+
96+
set(ITT_PUBLIC_HDRS
97+
include/ittnotify.h
98+
include/jitprofiling.h
99+
include/libittnotify.h
100+
)
101+
102+
file(GLOB ITT_SRCS "src/ittnotify/*.c" "src/ittnotify/*.h")
103+
104+
add_library(ittnotify STATIC ${ITT_SRCS} ${ITT_PUBLIC_HDRS})
105+
106+
if(APPLE)
107+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES OUTPUT_NAME ittnotify)
108+
endif()
109+
110+
if(WIN32)
111+
if(ARCH_64)
112+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES OUTPUT_NAME libittnotify64)
113+
else()
114+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES OUTPUT_NAME libittnotify32)
115+
endif()
116+
else()
117+
if(ARCH_64)
118+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES OUTPUT_NAME ittnotify64)
119+
else()
120+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES OUTPUT_NAME ittnotify32)
121+
endif()
122+
endif()
123+
124+
if (NOT WIN32)
125+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC")
126+
TARGET_LINK_LIBRARIES(ittnotify dl)
127+
endif()
128+
129+
SET_TARGET_PROPERTIES(ittnotify PROPERTIES LINKER_LANGUAGE C)
130+
131+
target_include_directories(ittnotify
132+
PUBLIC include src/ittnotify
133+
)
134+
135+
set(CMAKE_SUPPRESS_REGENERATION true)

‎deps/v8/third_party/ittapi/README.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Intel® The Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) API
2+
**********************************************************************************
3+
4+
This ITT/JIT open source profiling API includes:
5+
6+
Instrumentation and Tracing Technology(ITT) API
7+
Just-In-Time(JIT) Profiling API
8+
9+
The Instrumentation and Tracing Technology (ITT) API enables your application
10+
to generate and control the collection of trace data during its execution
11+
across different Intel tools.
12+
13+
ITT API consists of two parts: static part and dynamic part.
14+
Dynamic part is specific for a tool and distributed only with a particular tool.
15+
Static part is a common part shared between tools.
16+
Currently static part of ITT API is distributed as static library and opened
17+
sources under BSD/GPLv2 dual license with every tool supporting ITT API.
18+
19+
Build the library:
20+
On Windows, Linux and OSX: requires cmake (https://cmake.org) to be set in PATH
21+
python buildall.py
22+
Windows: requires Visual Studio installed or requires Ninja (https://github.com/ninja-build/ninja/releases) to be set in PATH
23+
24+
Load up the library:
25+
On Windows and Linux:
26+
Set environment variable INTEL_LIBITTNOTIFY32/INTEL_LIBITTNOTIFY64 to the full path to the libittnotify[32/64].[lib/a]
27+
On OSX:
28+
Set environment variable DYLD_INSERT_LIBRARIES to the full path to the libittnotify.dylib

0 commit comments

Comments
 (0)