dbgsrv/coredumpserver/readme.txt
changeset 0 c6b0df440bee
equal deleted inserted replaced
-1:000000000000 0:c6b0df440bee
       
     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 //
       
    16 
       
    17 Implement Core Dump Server and ECOM plugins.
       
    18 
       
    19 
       
    20 - Component Summary
       
    21 
       
    22 -- Core Dump Server : Server that manages the connection to the Debug Security Server (DSS), 
       
    23 loading plugins and controlling the creation of core dumps. 
       
    24 
       
    25 A stub SIS file is also provided to allow installations after ROM build.
       
    26 
       
    27 Two libraries are also provided, coredumpinterface and cdssupport.
       
    28 The coredumpinterface library is a standard Symbian interface to the Core Dump Server.
       
    29 The cdssupport library contains common code used by UI clients, the server and the ECOM plugins.
       
    30 
       
    31 
       
    32 -- Plugins : ECOM plugins that implement the creation of core dumps in differen formats (formatters) 
       
    33 and the saving of core dumps to different medium/media (writers). 
       
    34 
       
    35 By default there are two formatters (Symbian ELF, D_EXC) and one writer (File Writer).
       
    36 
       
    37 -- User Interfaces : User interfaces to the Core Dump Server (CDS). 
       
    38 By default there are two: TechView GUI and core dump script.
       
    39 
       
    40 
       
    41 - External Requirements
       
    42 
       
    43 -- Debug Security Server
       
    44 The Core Dump Server uses the DSS, which is available in the MCL from M04250. 
       
    45 
       
    46 -- Target Hardware
       
    47 Since the DSS does not run on the emulator, the CDS cannot run on the emulator either. 
       
    48 It has been tested on H2 and H4 boards.
       
    49 
       
    50 
       
    51 - Components Details
       
    52 
       
    53 -- Core Dump Server 
       
    54 IBY : server\src\coredumpserver.iby
       
    55 Source : server
       
    56 
       
    57 -- Core Dump Server STUB SIS file
       
    58 IBY : server\src\coredumpserverstub.iby
       
    59 Source : server\plugins
       
    60 
       
    61 
       
    62 -- Plugins
       
    63 
       
    64 --- Symbian ELF
       
    65 
       
    66 Source : plugins/formatters/symbianelf/group/symbianelfformatter.iby
       
    67 
       
    68 IBY : plugins\formatters\symbianelf\group\symbianelfformatter.iby
       
    69 
       
    70 Symbian ELF V1 : plugins/formatters/symbianelf/src/
       
    71 Symbian ELF V2 : plugins/formatters/symbianelf/srcv2/
       
    72 
       
    73 --- D_EXC
       
    74 
       
    75 IBY : plugins\formatters\dexc\group\dexcformatter.iby
       
    76 Source : plugins\formatters\dexc
       
    77 
       
    78 --- File Writer
       
    79 IBY : plugins\writers\file\group\filewriter.iby
       
    80 Source : plugins\writers\file
       
    81 
       
    82 --- UTrace
       
    83 IBY : plugins\formatters\utrace\group\utraceformatter.iby
       
    84 Source : plugins\formatters\utrace
       
    85 
       
    86 
       
    87 -- User Interfaces
       
    88 
       
    89 --- TechView UI
       
    90 IBY : ui\coredumpui\group\coredumpui.iby
       
    91 Source : \ui\coredumpui
       
    92 
       
    93 --- Core Dump Script UI
       
    94 IBY : ui\scriptconfig\coredumpscriptconfig.iby
       
    95 Source : ui\scriptconfig
       
    96 
       
    97 
       
    98 
       
    99 - Component Build Options
       
   100 
       
   101 Each of the abovementioned components can be built separately, and thus a ROM can contain a mixture of 
       
   102 components. To obtain the default set of components without the STUB SIS file:
       
   103  \epoc32\rom>buildrom h2 techview coredumpserver.iby symbianelfformatter.iby filewriter.iby dexcformatter.iby coredumpui.iby
       
   104 
       
   105 The STUB SIS file is required to upgrade and/or add plugins after ROM build. 
       
   106 
       
   107 Both the plugins and the server can be installed after ROM build.
       
   108 
       
   109 
       
   110 - Basic Usage
       
   111 
       
   112 -- The TechView UI 
       
   113 
       
   114 The TechView UI allows the user to:
       
   115  . Display a list of running processes and threads and choose which ones to observe for crashes 
       
   116  . Display a list of plugins and choose which ones to load
       
   117  . Configure the CDS options:
       
   118     - Core dump trigger : Hardware Exception and/or Kill Event 
       
   119     - Actions to carry out upon crash event 
       
   120     - Actions to carry out after core dump is complete
       
   121 
       
   122 
       
   123 -- D_EXC Output
       
   124 The D_EXC formatter will, by default, generate the same output in the same location (C: drive) as the original D_EXC tool. 
       
   125 
       
   126 
       
   127 -- Symbian ELF Output
       
   128 The Symbian ELF output is documented in 
       
   129   plugins\formatters\symbianelf\documentation\sgl_ts0028_027_symbian_core_dump_file_format
       
   130 
       
   131 The Symbian ELF formatter will, by default, generate all the optional output. 
       
   132 By default the core dump location is the E: drive. 
       
   133 The name of the file contains an optional user supplied string, followed by the lower 32 
       
   134 bits of the crash timestamp. If the user does not supply a file name to the file writer plugin, the
       
   135 default base name of the core dump file is "core<LSW time of crash>".
       
   136 
       
   137 Version 1.01.002
       
   138 =================
       
   139 Made by Stephen Roberts (17/11/2009)
       
   140 
       
   141 1.	DPDEF142882: Updated so crash files don't overwrite old ones if configured to use the same name.
       
   142 2.	DPDEF142849: Memory Leak Found when CDS exits after processing System Crash.
       
   143 
       
   144 
       
   145 Version 1.01.001
       
   146 =================
       
   147 Made by Sakhya Ghosh (22/10/2009)
       
   148 
       
   149 1. 	Updated Core Dump Server and SELF Formatter V2 with the new RProperty Signaling mechanism. A new RProperty added to 
       
   150 notify the clients of Core Dump Server about the core dump ELF media name. 
       
   151