unofficial-rtos-docs

Chapter 7 - FileX trace events

This chapter contains a description of the FileX events.

List of Events and Icons

The following is a list of FileX events displayed by TraceX.

The following describes each event:

Icon	Meaning
	Internal Logical Sector Cache Miss
	Internal Directory Cache Miss
	Internal Media Flush
	Internal Directory Entry Read
	Internal Directory Entry Write
	Internal I/O Driver Read
	Internal I/O Driver Write
	Internal I/O Driver Flush
	Internal I/O Driver Abort
	Internal I/O Driver Initialize
	Internal I/O Driver Boot Read
	Internal I/O Driver Release Sectors
	Internal I/O Driver Boot Write
	Internal I / O Driver Driver Un-initialize
	Directory Attributes Read (fx_directory_attributes_read)
	Directory Attributes Set (fx_directory_attributes_set)
	Directory Create (fx_directory_create)
	Directory Default Get (fx_directory_default_get)
	Directory Default Set (fx_directory_default_set)
	Directory Delete (fx_directory_delete)
	Directory First Entry Find (fx_directory_first_entry_find)
	Directory First Full Entry Find (fx_directory_first_full_entry_find)
	Directory Information Get (fx_directory_information_get)
	Directory Local Path Clear (fx_directory_local_path_clear)
	Directory Local Path Get (fx_directory_local_path_get)
	Directory Local Path Restore (fx_directory_local_path_restore)
	Directory Local Path Set (fx_directory_local_path_set)
	Directory Long Name Get (fx_directory_long_name_get)
	Directory Name Test (fx_directory_name_test)
	Directory Next Entry Find (fx_directory_next_entry_find)
	Directory Next Full Entry Find (fx_directory_next_full_entry_find)
	Directory Rename (fx_directory_rename)
	Directory Short Name Get (fx_directory_short_name_get)
	File Allocate (fx_file_allocate)
	File Attributes Read (fx_file_attributes_read)
	File Attributes Set (fx_file_attributes_set)
	File Best Effort Allocate (fx_file_best_effort_allocate)
	File Close (fx_file_close)
	File Create (fx_file_create)
	File Date Time Set (fx_file_date_time_set)
	File Delete (fx_file_delete)
	File Open (fx_file_open)
	File Read (fx_file_read)
	File Relative Seek (fx_file_relative_seek)
	File Rename (fx_file_rename)
	File Seek (fx_file_seek)
	File Truncate (fx_file_truncate)
	File Truncate Release (fx_file_truncate_release)
	File Write (fx_file_write)
	Media Abort (fx_media_abort)
	Media Cache Invalidate (fx_media_cache_invalidate)
	Media Check (fx_media_check)
	Media Close (fx_media_close)
	Media Flush (fx_media_flush)
	Media Format (fx_media_format)
	Media Open (fx_media_open)
	Media Read (fx_media_read)
	Media Space Available (fx_media_space_available)
	Media Volume Get (fx_media_volume_get)
	Media Volume Set (fx_media_volume_set)
	Media Write (fx_media_write)
	System Date Get (fx_system_date_get)
	System Date Set (fx_system_date_set)
	System Initialize (fx_system_initialize)
	System Time Get (fx_system_time_get)
	System Time Set (fx_system_time_set)
	Unicode Directory Create (fx_unicode_directory_create)
	Unicode Directory Rename (fx_unicode_directory_rename)
	Unicode File Create (fx_unicode_file_create)
	Unicode File Rename (fx_unicode_file_rename)
	Unicode Length Get (fx_unicode_length_get)
	Unicode Name Get (fx_unicode_name_get)
	Unicode Short Name Get (fx_unicode_short_name_get)

Event Descriptions

The following describes each individual event.

Internal Logical Sector Cache Miss

Internal logical sector cache miss

Icon

Description

This event represents an internal FileX logical sector cache miss.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Sector.
• Info Field 3: Total misses.
• Info Field 4: Cache size.

Internal Directory Cache Miss

Internal directory cache miss

Icon

Description

This event represents an internal FileX directory cache miss.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Total misses.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal Media Flush

Internal media flush

Icon

Description

This event represents an internal FileX media flush.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Number of dirty sectors.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal Directory Entry Read

Internal directory entry read

Icon

Description

This event represents an internal FileX directory entry read event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal Directory Entry Write

Internal directory entry write

Icon

Description

This event represents an internal FileX directory entry write event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Read

Internal I/O driver read

Icon

Description

This event represents an internal FileX I/O driver read event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Sector.
• Info Field 3: Number of sectors.
• Info Field 4: Buffer pointer.

Internal I/O Driver Write

Internal I/O driver write

Icon

Description

This event represents an internal FileX I/O driver write event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Sector.
• Info Field 3: Number of sectors.
• Info Field 4: Buffer pointer.

Internal I/O Driver Flush

Internal I/O driver flush

Icon

Description

This event represents an internal FileX I/O driver flush event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Abort

Internal I/O driver abort

Icon

Description

This event represents an internal FileX I/O driver abort event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Initialize

Internal I/O driver initialize

Icon

Description

This event represents an internal FileX I/O driver initialize event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Boot Sector Read

Internal I/O driver boot sector read

Icon

Description

This event represents an internal FileX I/O driver boot sector read event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Buffer pointer.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Release Sectors

Internal I/O driver release sectors

Icon

Description

This event represents an internal FileX I/O driver release sectors event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Sector.
• Info Field 3: Number of sectors.
• Info Field 4: Not used.

Internal I/O Driver Boot Sector Write

Internal I/O driver boot sector write

Icon

Description

This event represents an internal FileX I/O driver boot sector write event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Buffer pointer.
• Info Field 3: Not used.
• Info Field 4: Not used.

Internal I/O Driver Un-initialize

Internal I/O driver un-initialize

Icon

Description

This event represents an internal FileX I/O driver un-initialize event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

</blockquote></td>

Directory Attributes Read

fx_directory_attributes_read

Icon

Description

This event represents a directory attributes read event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.

• Info Field 3: Attributes bit map:

  Attribute	Value
  Read Only	(0x01)
  Hidden	(0x02)
  System	(0x04)
  Volume	(0x08)
  Directory	(0x10)
  Archive	(0x20)

• Info Field 4: Not used.

Directory Attributes Set

fx_directory_attributes_set

Icon

Description

This event represents a directory a directory attributes set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.

• Info Field 3: Attributes bit map:

  Attribute	Value
  Read Only	(0x01)
  Hidden	(0x02)
  System	(0x04)
  Archive	(0x20)

• Info Field 4: Not used.

Directory Create

fx_directory_create

Icon

Description

This event represents a directory create event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Default Get

fx_directory_default_get

Icon

Description

This event represents a directory default set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to return path name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Default Set

fx_directory_default_set

Icon

Description

This event represents a directory default set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to new default path name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Delete

fx_directory_delete

Icon

Description

This event represents a directory delete event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory First Entry Find

fx_directory_first_entry_find

Icon

Description

This event represents a directory first entry find event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory First Full Entry Find

fx_directory_first_full_entry_find

Icon

Description

This event represents a directory first full entry find event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Information Get

fx_directory_information_get

Icon

Description

This event represents a directory information get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Local Path Clear

fx_directory_local_path_clear

Icon

Description

This event represents a directory local path clear event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Local Path Get

fx_directory_local_path_get

Icon

Description

This event represents a directory local path get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to return path name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Local Path Restore

fx_directory_local_path_restore

Icon

Description

This event represents a directory local path restore event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to local path structure.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Local Path Set

fx_directory_local_path_set

Icon

Description

This event represents a directory local path set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to local path structure.
• Info Field 3: Pointer to new path name.
• Info Field 4: Not used.

Directory Long Name Get

fx_directory_long_name_get

Icon

Description

This event represents a directory long name get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to short file name.
• Info Field 3: Pointer to long file name.
• Info Field 4: Not used.

Directory Name Test

fx_directory_name_test

Icon

Description

This event represents a directory name test event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Next Entry Find

fx_directory_next_entry_find

Icon

Description

This event represents a directory next entry find event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Next Full Entry Find

fx_directory_next_full_entry_find

Icon

Description

This event represents a directory next full entry find event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to directory name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Directory Rename

fx_directory_rename event

Icon

Description

This event represents a directory rename event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to old directory name.
• Info Field 3: Pointer to new directory name.
• Info Field 4: Not used.

Directory Short Name Get

fx_directory_short_name_get

Icon

Description

This event represents a directory short name get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to long file name.
• Info Field 3: Pointer to short file name.
• Info Field 4: Not used.

File Allocate

fx_file_allocate

Icon

Description

This event represents a file allocate event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Requested size.
• Info Field 3: Current size.
• Info Field 4: New size.

File Attributes Read

fx_file_attributes_read

Icon

Description

This event represents a file attributes read event.

Information Fields

• Info Field 1: Pointer to the media.

• Info Field 2: Attributes bit map:

  Attribute	Value
  Read Only	(0x01)
  Hidden	(0x02)
  System	(0x04)
  Volume	(0x08)
  Directory	(0x10)
  Archive	(0x20)

• Info Field 3: Not used.
• Info Field 4: Not used.

File Attributes Set

fx_file_attributes_set

Icon

Description

This event represents a file attributes set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to file name.

• Info Field 3: Attributes bit map:

  Attribute	Value
  Read Only	(0x01)
  Hidden	(0x02)
  System	(0x04)
  Archive	(0x20)

• Info Field 4: Not used.

File Best Effort Allocate

fx_file_best_effort_allocate

Icon

Description

This event represents a file best effort allocate event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Requested size.
• Info Field 3: Actual size allocated.
• Info Field 4: Not used.

File Close

fx_file_close

Icon

Description

This event represents a file close event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: File size.
• Info Field 3: Not used.
• Info Field 4: Not used.

File Create

fx_file_create

Icon

Description

This event represents a file create event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to file name.
• Info Field 3: Not used.
• Info Field 4: Not used.

File Date Time Set

fx_file_date_time_set

Icon

Description

This event represents a file date/time set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to file name.
• Info Field 3: Year.
• Info Field 4: Month.

File Delete

fx_file_delete

Icon

Description

This event represents a file delete event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to file name.
• Info Field 3: Not used.
• Info Field 4: Not used.

File Open

fx_file_open

Icon

Description

This event represents a file open event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to the file control block.
• Info Field 3: Pointer to file name.

• Info Field 4: Open type:

  Open Type	Value
  Open for Read	(0x00)
  Open for Write	(0x01)
  Fast Open for Read	(0x02)

File Read

fx_file_read

Icon

Description

This event represents a file read event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Buffer pointer.
• Info Field 3: Request size.
• Info Field 4: Actual size read.

File Relative Seek

fx_file_relative_seek

Icon

Description

This event represents a file relative seek event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Byte offset.

• Info Field 3: Seek from:

  Event	Value
  From Beginning	(0x00)
  From End	(0x01)
  Forward	(0x02)
  Backward	(0x03)

• Info Field 4: Previous offset.

File Rename

fx_file_rename

Icon

Description

This event represents a file rename event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to old file name.
• Info Field 3: Pointer to new file name.
• Info Field 4: Not used.

File Seek

fx_file_seek

Icon

Description

This event represents a file seek event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Byte offset.
• Info Field 3: Previous offset.
• Info Field 4: Not used.

File Truncate

fx_file_truncate

Icon

Description

This event represents a file truncate event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Requested size.
• Info Field 3: Previous size.
• Info Field 4: New size.

File Truncate Release

fx_file_truncate_release

Icon

Description

This event represents a file truncate release event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Requested size.
• Info Field 3: Previous size.
• Info Field 4: New size.

File Write

fx_file_write

Icon

Description

This event represents a file write event.

Information Fields

• Info Field 1: Pointer to the file.
• Info Field 2: Buffer pointer.
• Info Field 3: Request size.
• Info Field 4: Actual size written.

Media Abort

fx_media_abort

Icon

Description

This event represents a media abort event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Media Cache Invalidate

fx_media_cache_invalidate

Icon

Description

This event represents a media cache invalidate event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Media Check

fx_media_check

Icon

Description

This event represents a media check event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Scratch memory pointer.
• Info Field 3: Scratch memory size.

• Info Field 4: Errors bit map:

  Error type	Value
  FAT Chain Error	(0x01)
  Directory Error	(0x02)
  Lost Cluster Error	(0x04)
  File Size Error	(0x08)

Media Close

fx_media_close

Icon

Description

This event represents a media close event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Media Flush

fx_media_flush

Icon

Description

This event represents a media flush event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

Media Format

fx_media_format

Icon

Description

This event represents a media format event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Number of root entries.
• Info Field 3: Sectors.
• Info Field 4: Sectors per cluster.

Media Open

fx_media_open

Icon

Description

This event represents a media open event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to media driver entry.
• Info Field 3: Memory pointer.
• Info Field 4: Memory size.

Media Read Media Read

fx_media_read

Icon

Description

This event represents a media read event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Logical sector.
• Info Field 3: Buffer pointer.
• Info Field 4: Bytes read.

Media Space Available

fx_media_space_available

Icon

Description

This event represents a media space available event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Available bytes pointer.
• Info Field 3: Number of free clusters.
• Info Field 4: Not used.

Media Volume Get

fx_media_volume_get

Icon

Description

This event represents a media volume get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to volume name.
• Info Field 3: Volume source.
• Info Field 4: Not used.

Media Volume Set

fx_media_volume_set

Icon

Description

This event represents a media volume set event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to volume name.
• Info Field 3: Not used.
• Info Field 4: Not used.

Media Write

fx_media_write

Icon

Description

This event represents a media write event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Logical sector.
• Info Field 3: Buffer pointer.
• Info Field 4: Bytes written.

System Date Get

fx_system_date_get

Icon

Description

This event represents a system date get event.

Information Fields

• Info Field 1: Year.
• Info Field 2: Month.
• Info Field 3: Day.
• Info Field 4: Not used.

System Date Set

fx_system_date_set

Icon

Description

This event represents a system date set event.

Information Fields

• Info Field 1: Year.
• Info Field 2: Month.
• Info Field 3: Day.
• Info Field 4: Not used.

System Initialize

fx_system_initialize

Icon

Description

This event represents a system initialize event.

Information Fields

• Info Field 1: Not used.
• Info Field 2: Not used.
• Info Field 3: Not used.
• Info Field 4: Not used.

System Time Get

fx_system_time_get

Icon

Description

This event represents a system time get event.

Information Fields

• Info Field 1: Hour.
• Info Field 2: Minute.
• Info Field 3: Second.
• Info Field 4: Not used.

System Time Set

fx_system_time_set

Icon

Description

This event represents a system time set event.

Information Fields

• Info Field 1: Hour.
• Info Field 2: Minute.
• Info Field 3: Second.
• Info Field 4: Not used.

Unicode Directory Create

fx_unicode_directory_create

Icon

Description

This event represents a Unicode directory create event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to Unicode name.
• Info Field 3: Size of Unicode name.
• Info Field 4: Pointer to short name.

Unicode Directory Rename

fx_unicode_directory_rename

Icon

Description

This event represents a Unicode directory rename event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to Unicode name.
• Info Field 3: Size of Unicode name.
• Info Field 4: Pointer to short name.

Unicode File Create

fx_unicode_file_create

Icon

Description

This event represents a Unicode file create event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to the Unicode name.
• Info Field 3: Size of Unicode name.
• Info Field 4: Pointer to short name.

Unicode File Rename

fx_unicode_file_rename

Icon

Description

This event represents a Unicode file rename event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to Unicode name.
• Info Field 3: Size of Unicode name.
• Info Field 4: Pointer to short name.

Unicode Length Get

fx_unicode_length_get

Icon

Description

This event represents a Unicode length get event.

Information Fields

• Info Field 1: Pointer to the Unicode name.
• Info Field 2: Length.
• Info Field 3: Not used.
• Info Field 4: Not used.

Unicode Name Get

fx_unicode_name_get

Icon

Description

This event represents a Unicode name get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Source short name.
• Info Field 3: Destination Unicode name pointer.
• Info Field 4: Destination Unicode name length.

Unicode Short Name Get

fx_unicode_short_name_get

Icon

Description

This event represents a Unicode short name get event.

Information Fields

• Info Field 1: Pointer to the media.
• Info Field 2: Pointer to source Unicode name.
• Info Field 3: Length of Unicode name.
• Info Field 4: Pointer to short name.

This site is open source. Improve this page.