memana/analyzetoolclient/group/ReleaseNotes_AnalyzeTool.txt
changeset 0 f0f2b8682603
equal deleted inserted replaced
-1:000000000000 0:f0f2b8682603
       
     1 ===============================================================================
       
     2 
       
     3 RELEASE NOTES - AnalyzeTool v1.8.0
       
     4 RELEASED 1st December 2009
       
     5 
       
     6 ===============================================================================
       
     7 
       
     8 Product Description:
       
     9 ====================
       
    10 
       
    11 AnalyzeTool is a test software tool that is used for testing Symbian software
       
    12 for memory leaks and pinpointing the leaking problems from the source code.
       
    13 
       
    14 
       
    15 Main Features:
       
    16 ==============
       
    17 - Pinpoints memoryleaks from target hardware and emulator to source code lines
       
    18 - Discovers resource leaks from process
       
    19 - Command line interface and Carbide.c++ Extension
       
    20 
       
    21 ===============================================================================
       
    22 
       
    23 What's New in 1.8.0
       
    24 ===================
       
    25 
       
    26 -New:[AT-45] - Memory usage shown as graph.
       
    27 
       
    28 ===============================================================================
       
    29 
       
    30 Installation Notes:
       
    31 ===================
       
    32 PDK Tools Overlay installer should be used to install AnalyzeTool to the used
       
    33 environment. After that AnalyzeTool should be build to all used platforms and
       
    34 both build types (udeb/urel) in that environment.
       
    35  
       
    36 AnalyzeTool is found from sf\pdt\dynaanactrlandcptr\memana\analyzetoolclient
       
    37 folder. Building should be done in group folder.
       
    38 
       
    39 Note: Before building check symbian_version.hrh file that it defines correct
       
    40 version for your environment.
       
    41 
       
    42 ===============================================================================
       
    43 
       
    44 System Requirements:
       
    45 ====================
       
    46 - Windows XP
       
    47 - Trace connection for real time data gathering to PC
       
    48 
       
    49 Additional Requirements:
       
    50 - Carbide.c++ v2.x
       
    51 
       
    52 ===============================================================================
       
    53 
       
    54 Compatibility Issues:
       
    55 =====================
       
    56 - Not compatible with versions older than 1.5.0 of AnalyzeTool
       
    57 - Kernel code analysis not supported
       
    58 
       
    59 ===============================================================================
       
    60 
       
    61 Known Issues:
       
    62 =============
       
    63 - When using monitored internal data gathering mode (-mi) and hooked application contains huge 
       
    64 amounts of allocations, AnalyzeTool storageserver might run out of memory to store the data. This 
       
    65 message "Symbian error code -4" is seen in the data file. Solution is to 
       
    66 use external / monitored external data gathering mode. No fix is planned yeat. 
       
    67 
       
    68 - Switch allocator. AnalyzeTool change the application memory allocator to AnalyzeTool own memory 
       
    69 allocator and using the User::SwitchAllocator function can lead to situation where the tested 
       
    70 application does not work properly. No fix is planned yeat. 
       
    71 
       
    72 - AnalyzeTool hooked QT applications becomes too slow to run. Improved in release 1.7.4 where you 
       
    73 can use small size call stack(s) and new logging mode (external -e). 
       
    74 
       
    75 - Stif test case with AnalyzeTool can inform wrong memory leak alert. No fix is planned yeat. 
       
    76 
       
    77 - AnalyzeTool overwrites functions TInt User::ProcessCritical(TCritical aCritical) and TInt 
       
    78 User::SetProcessCritical(TCritical aCritical), but this works only when the function is called from 
       
    79 hooked exe application. So if setting critical is done from DLL (even if it's hooked with 
       
    80 AnalyzeTool) the overwriting does not work and the process stays set critical during the testing. No 
       
    81 fix is planned yeat. 
       
    82 
       
    83 - If hooked application is closed by calling User::Exit() from DLL instead of .exe application 
       
    84 AnalyzeTool reports "abnormal process end" and can't report proper memory leaks. No fix is planned 
       
    85 yeat. 
       
    86 
       
    87 ===============================================================================
       
    88 Version History:
       
    89 ================
       
    90 
       
    91 Version in 1.7.4 - 4th November 2009
       
    92 ---------------------------------
       
    93 -New: [AT-560] - Third data gathering mode which is simple and fast.
       
    94 -New: [AT-592] - Support for specifying call stack size(s).
       
    95 -New: [AT-627] - Button to open preferences.
       
    96 -New: [AT-551] - New error dialogs in Carbide extension.
       
    97 -New: [AT-583] - Extension version number shown in AnalyzeTool view.
       
    98 -Fix: [AT-568] - Inform user in build phase that kernel mode is not supported/hooked.
       
    99 -Fix: [AT-623] - Version conflict not shown to user.
       
   100 -Fix: [AT-632] - Selecting leak from sub test does not give call stack info.
       
   101 -Fix: [AT-630] - Console UI leaks memory.
       
   102 
       
   103 Version in 1.7.3 - 1st October 2009
       
   104 ---------------------------------
       
   105 -New: [AT-570] - Support reading debug data from ROFS files.
       
   106 -New: [AT-495] - Timestamps in DLL load/unload messages.
       
   107 -New: [AT-540] - Support for DLL timestamps in CLI.
       
   108 -New: [AT-544] - Use all found emulator binaries in analyze.
       
   109 -New: [AT-527] - Timestamp in free trace message.
       
   110 -Fix: [AT-463] - Memory card drive letter hard coded.
       
   111 
       
   112 Version in 1.7.2 - 3th September 2009
       
   113 ---------------------------------
       
   114 -Fix: [AT-569] - False memory leak reported when test had handle leak(s)
       
   115 -Fix: [AT-535] - Hooked application panics on exit at certain environment
       
   116 
       
   117 Version in 1.7.1 - 19th August 2009
       
   118 ---------------------------------
       
   119 -Fix: [AT-542] - Decrease extension memory usage when creating results.
       
   120 -Fix: [AT-548] - Write protected mmp files will not prevent building project.
       
   121 -Fix: [AT-553] - Device data file input should not accept path.
       
   122 -Fix: [AT-554] - User build accidentally slow debug version of AnalyzeTool
       
   123 -Fix: [AT-528] - Mutex access violation error in certain environment.
       
   124 -Fix: [AT-562] - Two tests in one log file may fail to pinpoint.
       
   125 -Fix: [AT-563] - Analysis takes allocations before process start tag.
       
   126 -Fix: [AT-526] - Memory check related macro panics when application is hooked.
       
   127 -Fix: [AT-541] - Opening help on hooked application causes panic.
       
   128 -Fix: [AT-555] - AnalyzeTool skips some reallocations.
       
   129 -New: [AT-558] - Supporting new environment.
       
   130 
       
   131 Version in 1.7.0 - 25th June 2009
       
   132 ---------------------------------
       
   133 -Fix: [AT-521] - AnalyzeTool results can be incorrect if new line is non-standard
       
   134 -Fix: [AT-414] - Logging level 2 does not work in raptor and build type urel correctly
       
   135 -Fix: [AT-508] - Show error if illegal parameters
       
   136 -Fix: [AT-464] - Verbose output renders AnalyzeTool unusable slow
       
   137 -Fix: [AT-517] - Improve parsing speed of addresses
       
   138 -New: [AT-320] - Create support to use xml project definition when building using raptor.
       
   139 -New: [AT-389] - User can easily check version of AnalyzeTool in SDK
       
   140 -New: [AT-134] - Carbide.c++ AnalyzeTool building of a QT project
       
   141 -New: [AT-236] - Refresh button which makes results again
       
   142 -New: [AT-136] - Carbide extension to visualize results for emulator/simulator memory leaks automatically
       
   143 
       
   144 Version in 1.6.0 - 20th April 2009
       
   145 ---------------------------------
       
   146 -New: [AT-475] - Number of max callstack items increased to 40
       
   147 -New: [AT-453] - On the fly call stack filtering improved
       
   148 -New: [AT-481] - "PROCESS_END x ABNORMAL" are now printed also when internal data gathering mode is used
       
   149 -Fix: [AT-491] - Error info improved with new command line parameters
       
   150 
       
   151 Version in 1.5.2 - 2nd April 2009
       
   152 ---------------------------------
       
   153 -New: [AT-455] - A lot of changes to atool.exe parameters
       
   154 -New: [AT-257] - addr2line.exe in now used to pinpoint code lines
       
   155 -New: [AT-337] - Supports for pinpointing codelines from GCCE binaries
       
   156 -New: [AT-113] - Pinpoint memory leaks to code lines also in urel builds
       
   157 -Fix: [AT-461] - Pinpointing works also to dlls in emulator environment.
       
   158 -Fix: [AT-470] - Logging levels 1&2 (atool -a l1 or atool -a l2) shows now only pinpointed lines
       
   159 -Fix: [AT-483] - Commandline crash fixed when project build to winscw platform
       
   160 -Fix: [AT-328] - User is now warned when build type differs between data and project
       
   161 -Fix: [AT-419] - Clear AnalyzeTool changes (atool -c) runs reallyclean also
       
   162 -Fix: [AT-446] - Error message is display when user analysis invalid data
       
   163 -Fix: [AT-413] - Building errors fixed
       
   164 
       
   165 Version 1.5.1 - 19th March 2009
       
   166 -------------------------------
       
   167 -Fix: [AT-422] - Abnormal process ends not anymore showed for non-AnalyzeTool processes
       
   168 -Fix: [AT-433] - Summary info fixed when executing atool.exe with -uninst parameter
       
   169 -Fix: [AT-415] - New mmp specified error message added to sbs2 builds
       
   170 -Fix: [AT-449] - Thread killing now handled correctly
       
   171 -Fix: [AT-452] - All library events are now handled by DAnalyzeToolEventHandler
       
   172 -New: [AT-443] - Atool version is checked when hooked application is started
       
   173 -New: [AT-343] - System components info in callstack is read from rom symbols file
       
   174 -New: [AT-451] - Added support for pinpointing codelines from static libraries in ARMV5 platform
       
   175 
       
   176 Version 1.5.0 - 19th February 2008
       
   177 ----------------------------------
       
   178 -Fix: [AT-317] - Multible processes can log to same datafile
       
   179 -Fix: [AT-350] - Running atool -c in directory where only empty atool_temp directory exists will not delete atool_temp directory
       
   180 -Fix: [AT-330] - In analyze report pinpointed memoryleak count is always zero when using raptor, in logging levels 1 & 2
       
   181 -Fix: [AT-333] - Use of raptor build variables leads to incorrect listing file name with certain types
       
   182 -Fix: [AT-357] - AnalyzeTool can share existing TraceViewer connection
       
   183 -Fix: [AT-361] - Unnecessary "Can not analyze" dialog is no longer displayed after the project is built with AnalyzeTool.
       
   184 -Fix: [AT-363] - Needed files for AnalyzeTool hooking are also checked for winscw
       
   185 -Fix: [AT-376] - Analyze Tool Pre- and Post-Build Errors are added to Problems View
       
   186 -Fix: [AT-272] - AnalyzeTool debug logging improved
       
   187 -Fix: [AT-374] - Start tracing icon changed
       
   188 -Fix: [AT-332] - Only supported mmp target types are now hooked
       
   189 -Fix: [AT-372] - If SDK prefs not ok in Carbide, atool gives error: missing libraries from SDK
       
   190 -Fix: [AT-378] - Crash when trying to navigate to source location
       
   191 -Fix: [AT-388] - Hooked application no longer panics if there is old version of atool in SDK (now application does not start if versions do not match)
       
   192 -Fix: [AT-390] - Emulator pinpoints to wrong cpp file
       
   193 -Fix: [AT-393] - Progress monitor is shown while starting the TraceViewer connection
       
   194 -Fix: [AT-417] - AnalyzeTool configUI memory leaks fixed
       
   195 -Fix: [AT-316] - New 'How to use examples' added to command line help
       
   196 -Fix: [AT-410] - Command line tool, "atool.exe", is bundled into the Carbide extension
       
   197 -Fix: [AT-325] - unnecessary copying of trace file removed from Carbide
       
   198 -Fix: [AT-358] - Disable unnecessary AnalyzeTool buttons when trace is started.
       
   199 -New: [AT-296] - AnalyzeTool supports hooking and unhooking of project in command line
       
   200 -New: [AT-254] - AnalyzeTool to work also in emulator
       
   201 -New: [AT-323] - AnalyzeTool Carbide extension can be used without Traceviewer Extension
       
   202 
       
   203 Version 1.4.1 - 19th December 2008
       
   204 ----------------------------------
       
   205 -Fix: [AT-310] - AnalyzeTool consoleapplication does not show all process information
       
   206 
       
   207 Version 1.4.0 - 12th December 2008
       
   208 ----------------------------------
       
   209 -New: [AT-263] - Atool supports Symbian build system version 2 (SBS v.2)
       
   210 -Fix: [AT-271] - "atool -c" gives badly formed error texts
       
   211 -Fix: [AT-294] - Atool.exe to check if there is process start and dll_load in datafile
       
   212 
       
   213 Version 1.3.3 - 27th November 2008
       
   214 ----------------------------------
       
   215 -Fix: [AT-237] - Support analysing datafiles without /epoc32/build content or from sub folder where build was made
       
   216 -Fix: [AT-285] - Temporary file left to output directory in atool.exe analyze
       
   217 -Fix: [AT-292] - S60_UPGRADABLE_APP_REG_RSC macro not always available
       
   218 -Fix: [AT-283] - AnalyzeTool.iby works also on PP environment
       
   219 
       
   220 Version 1.3.2 - 13th November 2008
       
   221 ----------------------------------
       
   222 -Fix: [AT-224] - Multiple modules use same source files (objects listing files)
       
   223 -Fix: [AT-220] - Atool.exe to show what is trying to copy or move
       
   224 -Fix: [AT-238] - Logging level filtering summary
       
   225 -New: [AT-233] - Results include processes udeb/urel info.
       
   226 
       
   227 Version 1.3.1 - 30th October 2008
       
   228 ---------------------------------
       
   229 -Fix: [AT-228] - Atool tries to delete same temp directory multiple times
       
   230 -Fix: [AT-247] - run abld reallyclean instead of abld clean
       
   231 -Fix: [AT-215] - AnalyzeTool panics on certain environment
       
   232 
       
   233 Version 1.3.0 - 23rd October 2008
       
   234 ---------------------------------
       
   235 -Fix: [AT-156] - Multiple subtests within test run show only one subtest
       
   236 -Fix: [AT-179] - Atool misinterprets data filename which contains "-l" in string as logging argument
       
   237 -Fix: [AT-181] - Logging levels 1 and 3 produce same results when using UREL target
       
   238 -Fix: [AT-204] - Memoryhook prints PROCESS_END when child threads are killed
       
   239 -Fix: [AT-206] - Atool reports runs from irrelevant PROCESS_ENDS
       
   240 -Fix: [AT-210] - Logging level 2 incorrect call stack data
       
   241 -Fix: [AT-222] - No error message data file can not be opened
       
   242 -Fix: [AT-225] - NPE when using the Analyze View in Carbide 2.0.
       
   243 -Fix: [AT-227] - AnalyzeTool uses default variant if no variant parameter is used and default level1 makefiles content is invalid
       
   244 -Doc: [AT-175] - AnalyzeTool user guide to have advanced section which explains in detail how tool works
       
   245 -New: [AT-66]  - Merge call stack info from main exe and dlls.
       
   246 -New: [AT-118] - Show urel/udeb info from main process
       
   247 -New: [AT-145] - Analyze is made to given module target name
       
   248 -New: [AT-162] - bldmake bldfiles to call only for needed components
       
   249 -New: [AT-163] - a single process start - end, should not be a test run
       
   250 -New: [AT-183] - atool continues even if bldmake bldfiles fails
       
   251 -New: [AT-189] - Carbide.c++ Extension shows ABNORMAL text when system exception happens in the phone
       
   252 -New: [AT-190] - Carbide.c++ Extension could filter memory leaks which does not contain any call stack
       
   253 -New: [AT-191] - MemoryHook reports PROCESS_END with ABNORMAL tag
       
   254 -New: [AT-192] - atool -c to undo mmp change
       
   255 -New: [AT-196] - logging datafile shown in Configuration UI
       
   256 -New: [AT-202] - Modules with read only mmp files can be hooked
       
   257 -New: [AT-209] - Print logging filename if not given
       
   258 -New: [AT-211] - AnalyzeTool supports new environments
       
   259 -New: [AT-214] - atool could check "build" parameter before assuming debug build
       
   260 
       
   261 Version 1.2.1 - 2nd October 2008
       
   262 --------------------------------
       
   263 -Fix: [AT-165] - Process end is not get when process is killed
       
   264 -Fix: [AT-176] - Should not hook STATIC libraries
       
   265 -Fix: [AT-177] - atool.exe makes changes before creating backup from mmp file
       
   266 -Fix: [AT-188] - Atool can not pinpoint codelines from variant modules.
       
   267 -New: [AT-142] - Subtests supports handle leak detection
       
   268 -New: [AT-159] - AnalyzeTool no longer hooks kernel side components
       
   269 -New: [AT-123] - Configuration UI could be used to kill processes in device
       
   270 
       
   271 Version 1.2.0 - 18th September 2008
       
   272 -----------------------------------
       
   273 -Fix: [AT-56] - Error when project is build in Carbide.
       
   274 -Fix: [AT-73] - White space not ignored when reading target from MMP-file
       
   275 -Fix: [AT-87] - XML report file is incorrect when executing multiple test runs with subtest
       
   276 -Fix: [AT-93] - Error note "AnalyzeTool can not find all .cpp files" even when project consists of only .c files.
       
   277 -Fix: [AT-101] - UI fixes
       
   278 -Fix: [AT-102] - MMP selection dialog during build
       
   279 -Fix: [AT-109] - Does not follow build order
       
   280 -Fix: [AT-110] - Jump to code line does not work
       
   281 -Fix: [AT-119] - Updating AnalyzeTool, installed on ROM, with a SIS-file fails.
       
   282 -Fix: [AT-143] - Save button menu in previous (wrong) place
       
   283 -Fix: [AT-157] - "Number of memory allocations: " can be wrong with multiple test runs
       
   284 -Fix: [AT-160] - Carbide.c++ start trace dialog does not contain cancel option
       
   285 -New: [AT-74] - Get module info from makefile
       
   286 -New: [AT-90] - Check for missing files before building
       
   287 -New: [AT-98] - Use makefile templates
       
   288 -New: [AT-116] - Improved AnalyzeTool Carbide.c++ Extension to use Carbide builder
       
   289 -New: [AT-117] - Improve results showing
       
   290 -New: [AT-121] - Urel build selection in Carbide
       
   291 -New: [AT-144] - Environment changes zips to include also binaries for various environments
       
   292 -New: [AT-149] - Check that AnalyzeTool works with mmp files without .mmp extension
       
   293 -New: [AT-53] - AnalyzeTool supports also building and analysing urel binaries
       
   294 
       
   295 Version 1.1.2 - 21th August 2008
       
   296 --------------------------------
       
   297 -Fix: [AT-50] - Atool result not always displayed.
       
   298 -Fix: [AT-97] - Launching Carbide generates error message to error log
       
   299 -Fix: [AT-99] - 'Module not build with AnalyzeTool' is still displayed after AnalyzeTool build.
       
   300 
       
   301 Version 1.1.1 - 7th August 2008
       
   302 -------------------------------
       
   303 -Fix: [AT-72] - Command line tool can not handle project where two MMP-files are in same directory
       
   304 
       
   305 Version 1.1.0 - 10th July 2008
       
   306 ------------------------------
       
   307 -Fix: [AT-70] - Redundant handle leak information
       
   308 -New: [AT-59] - Trace data can be saved to a file.
       
   309 -New: [AT-68] - Cancel logging from ConfigUI feature.
       
   310 
       
   311 ===============================================================================
       
   312 
       
   313 /*
       
   314 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
       
   315 * All rights reserved.
       
   316 * This component and the accompanying materials are made available
       
   317 * under the terms of "Eclipse Public License v1.0"
       
   318 * which accompanies this distribution, and is available
       
   319 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
   320 *
       
   321 * Initial Contributors:
       
   322 * Nokia Corporation - initial contribution.
       
   323 *
       
   324 * Contributors:
       
   325 * 
       
   326 * Description:
       
   327 *
       
   328 */