Jump to content

PDGuide - Summary of Functions and Interfaces: Difference between revisions

From EDM2
← Older edit
No edit summary
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
 
Line 2: Line 2:


{{IBM-Reprint}}
{{IBM-Reprint}}


OS/2 Warp Version 4 provides functions, commands, graphical utilities, icons, and folders to help you collect and manage problem determination data. Here is a summary to help you understand all that is available to you, and where more information can be found about each.
OS/2 Warp Version 4 provides functions, commands, graphical utilities, icons, and folders to help you collect and manage problem determination data. Here is a summary to help you understand all that is available to you, and where more information can be found about each.
Line 11: Line 10:
* Dumps
* Dumps
* Error Log
* Error Log
* DMI  
* DMI
 
Most of the function described in the tables can be accessed from the systems management folder  
Most of the function described in the tables can be accessed from the systems management folder  


{| class="wikitable"
{|class="wikitable" width=80%
!colspan="3"|Table2 .FFST
|+Table2. FFST
|-
!NAME||TASKS||FOR INFORMATION
|NAME
|TASKS
|FOR INFORMATION
|-
|-
| FFSTProbe function
| FFSTProbe function
| * Logs data in Error Log <br>* Can trigger FFST dump
| * Logs data in Error Log <br>* Can trigger FFST dump
| [[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
| rowspan=5|[[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
|-
|-
| FFSTQueryConfiguration function
| FFSTQueryConfiguration function
| Queries FFST configuration information
| Queries FFST configuration information
| [[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
|-
|-
| FFSTSetConfiguration function
| FFSTSetConfiguration function
| Change FFST configuration values
| Change FFST configuration values
| [[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
|-
|-
| MKTMPF (Make Template File) command
| MKTMPF (Make Template File) command
| Creates an error record template file
| Creates an error record template file
| [[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
|-
|-
| MRES (MultiRes Resource Compiler)
| MRES (MultiRes Resource Compiler)
| Creates message files
| Creates message files
| [[PDGuide_-_Guide_to_Instrumenting_Your_Code|Instrumenting Your Code]]
|-
|-
| FFSTCONF command
| FFSTCONF command
| Controls error data requested by the FFSTProbe function  
| Controls error data requested by the FFSTProbe function  
| [[PDGuide_-_Controlling_FFSTProbe_Calls|Controlling FFSTProbe]]
| rowspan=2|[[PDGuide_-_Controlling_FFSTProbe_Calls|Controlling FFSTProbe]]
|-
|-
| FFST Setup icon
| FFST Setup icon
| Accesses FFST Setup display
| Accesses FFST Setup display
| [[PDGuide_-_Controlling_FFSTProbe_Calls|Controlling FFSTProbe]]
|}
|}


{|class="wikitable" width=80%
|+Table 3. Trace
!NAME||TASKS||FOR INFORMATION
|-
|TRACE utility||Turns trace points on and off||rowspan=5|Using Trace
|-
|TRACEFMT utility||Views error event trace data data
|-
|TRACEGET command||Captures contents of trace buffer to a file
|-
|TRACELOG utility||Controls logging of event trace data
|-
|TRCUST utility||Trace Customizer to create trace format file
|}


ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
{|class="wikitable" width=80%
³ Table 3. Trace ³
|+Table 4. Dump
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
!NAME||TASKS||FOR INFORMATION
³ NAME ³ TASKS ³ FOR INFORMATION ³
|-
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
|PM Dump Facility icon||Initiates the PM Dump Facility dump formatter||Capturing Dumps
³ TRACE utility ³ Turns trace points on ³ Using Trace ³
|}
³ ³ and off ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ TRACEFMT utility ³ Views error event trace ³ Using Trace ³
³ ³ data ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ TRACEGET command ³ Captures contents of ³ Using Trace ³
³ ³ trace buffer to a file ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ TRACELOG utility ³ Controls logging of ³ Using Trace ³
³ ³ event trace data ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ TRCUST utility ³ Trace Customizer to ³ Using Trace ³
³ ³ create trace format file ³ ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ


{|class="wikitable" width=80%
|+Table 5. Error Log
!NAME||TASKS||FOR INFORMATION
|-
|LogOpenEventNotification function||Requests notification of when entries are put in error log||rowspan=8|Problem Determination APIs
|-
|LogChangeEventFilter function||Changes the event notification filter
|-
|LogReadEntry function||Reads entries from the log file
|-
|LogOpenFile function||Opens a log file for reading
|-
|LogCloseFile function||Closes a log file
|-
|LogWaitEvent function||Request error notification
|-
|LogCloseEventNotification function||Closes event notification
|-
|LogFormatEntry function||Gets character strings that can be displayed when formatted.
|-
|SYSLOG (Error Log Formatter) utility||Displays the system Error Log


ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
Allows access to other FFST tools
³ Table 4. Dump ³
|Viewing Error Log
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
|}
³ NAME ³ TASKS ³ FOR INFORMATION ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ PM Dump Facility icon ³ Initiates the PM Dump ³ Capturing Dumps ³
³ ³ Facility dump formatter ³ ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ


 
{|class="wikitable" width=80%
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
|+Table 6. DMI
³ Table 5. Error Log ³
!NAME||FUNCTION(S)||FOR INFORMATION
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
|-
³ NAME ³ TASKS ³ FOR INFORMATION ³
|DMI||Standard way and API set to define and access VPD||DMI
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
|}
³ LogOpenEventNotification³ Requests notification of ³ Problem Determination ³
³ function ³ when entries are put in ³ APIs ³
³ ³ error log ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogChangeEventFilter ³ Changes the event ³ Problem Determination ³
³ function ³ notification filter ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogReadEntry function ³ Reads entries from the ³ Problem Determination ³
³ ³ log file ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogOpenFile function ³ Opens a log file for ³ Problem Determination ³
³ ³ reading ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogCloseFile function ³ Closes a log file ³ Problem Determination ³
³ ³ ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogWaitEvent function ³ Request error notifica- ³ Problem Determination ³
³ ³ tion ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogCloseEventNotificatio³ Closes event notifica- ³ Problem Determination ³
³ function ³ tion ³ APIs ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ LogFormatEntry function ³ Gets character strings ³ Problem Determination ³
³ ³ that can be displayed ³ APIs ³
³ ³ when formatted. ³ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ SYSLOG (Error Log For- ³ Displays the system ³ Viewing Error Log ³
³ matter) utility ³ Error Log ³ ³
³ ³ ³ ³
³ ³ Allows access to other ³ ³
³ ³ FFST tools ³ ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
 
 
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ Table 6. DMI ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ NAME ³ FUNCTION(S) ³ FOR INFORMATION ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ DMI ³ Standard way and API set ³ DMI ³
³ ³ to define and access VPD ³ ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ


[[Category:PDGuide]]
[[Category:PDGuide]]

Latest revision as of 20:29, 21 January 2018

Problem Determination Programmer's Guide
  1. Introduction to Collecting and Managing Problem Determination Data
  2. Guide to Instrumenting Your Code
  3. Controlling FFSTProbe Calls
  4. Viewing and Analyzing Error Log Entries
  5. Analyzing Performance and Debugging Problems Using Trace
  6. Capturing and Saving Failure-Related Information through Dumps
  7. The Desktop Management Interface
  8. Summary of Functions and Interfaces
  9. Problem Determination APIs

Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation

OS/2 Warp Version 4 provides functions, commands, graphical utilities, icons, and folders to help you collect and manage problem determination data. Here is a summary to help you understand all that is available to you, and where more information can be found about each.

The tables appear in the same order as the chapters in the book:

  • First Failure Support Technology
  • Trace
  • Dumps
  • Error Log
  • DMI

Most of the function described in the tables can be accessed from the systems management folder

Table2. FFST
NAME TASKS FOR INFORMATION
FFSTProbe function * Logs data in Error Log
* Can trigger FFST dump 		Instrumenting Your Code
FFSTQueryConfiguration function Queries FFST configuration information
FFSTSetConfiguration function Change FFST configuration values
MKTMPF (Make Template File) command Creates an error record template file
MRES (MultiRes Resource Compiler) Creates message files
FFSTCONF command Controls error data requested by the FFSTProbe function Controlling FFSTProbe
FFST Setup icon Accesses FFST Setup display
Table 3. Trace
NAME TASKS FOR INFORMATION
TRACE utility Turns trace points on and off Using Trace
TRACEFMT utility Views error event trace data data
TRACEGET command Captures contents of trace buffer to a file
TRACELOG utility Controls logging of event trace data
TRCUST utility Trace Customizer to create trace format file
Table 4. Dump
NAME TASKS FOR INFORMATION
PM Dump Facility icon Initiates the PM Dump Facility dump formatter Capturing Dumps
Table 5. Error Log
NAME TASKS FOR INFORMATION
LogOpenEventNotification function Requests notification of when entries are put in error log Problem Determination APIs
LogChangeEventFilter function Changes the event notification filter
LogReadEntry function Reads entries from the log file
LogOpenFile function Opens a log file for reading
LogCloseFile function Closes a log file
LogWaitEvent function Request error notification
LogCloseEventNotification function Closes event notification
LogFormatEntry function Gets character strings that can be displayed when formatted.
SYSLOG (Error Log Formatter) utility Displays the system Error Log

Allows access to other FFST tools

Viewing Error Log
Table 6. DMI
NAME FUNCTION(S) FOR INFORMATION
DMI Standard way and API set to define and access VPD DMI
Retrieved from "https://www.edm2.com/index.php?title=PDGuide_-_Summary_of_Functions_and_Interfaces&oldid=54270"