User's Guide
Reference Manual
Release Notes
PDF
Top

Inviso
Reference Manual
Version 0.6.1

Expand All
Contract All

Table of Contents

- inviso
  - Top of manual page
  - start/0
  - start/1
  - stop/0
  - add_node/1
  - add_node/2
  - add_node_if_ref/1
  - add_node_if_ref/2
  - add_nodes/2
  - add_nodes/3
  - add_nodes_if_ref/2
  - add_nodes_if_ref/3
  - stop_nodes/0
  - stop_nodes/1
  - stop_all/0
  - change_options/1
  - change_options/2
  - init_tracing/1
  - init_tracing/1
  - init_tracing/2
  - stop_tracing/1
  - stop_tracing/0
  - clear/0
  - clear/2
  - clear/1
  - tp/6
  - tp/5
  - tp/5
  - tp/4
  - tp/2
  - tp/1
  - tpl/5
  - tpl/6
  - tpl/4
  - tpl/5
  - tpl/2
  - tpl/1
  - ctp/4
  - ctp/3
  - ctpl/4
  - ctpl/3
  - tf/3
  - tf/2
  - tf/2
  - tf/1
  - tf/1
  - ctf/3
  - ctf/2
  - ctf/2
  - ctf/1
  - ctf_all/1
  - ctf_all/0
  - init_tpm/4
  - init_tpm/5
  - init_tpm/7
  - init_tpm/8
  - tpm/4
  - tpm/5
  - tpm/5
  - tpm/6
  - tpm/8
  - tpm/9
  - tpm_tracer/4
  - tpm_tracer/5
  - tpm_tracer/5
  - tpm_tracer/6
  - tpm_tracer/8
  - tpm_tracer/9
  - tpm_ms/5
  - tpm_ms/6
  - tpm_ms_tracer/5
  - tpm_ms_tracer/6
  - ctpm_ms/4
  - ctpm_ms/5
  - ctpm/3
  - ctpm/4
  - tpm_localnames/0
  - tpm_localnames/1
  - ctpm_localnames/0
  - ctpm_localnames/1
  - tpm_globalnames/0
  - tpm_globalnames/1
  - ctpm_globalnames/0
  - ctpm_globalnames/1
  - ctp_all/0
  - ctp_all/1
  - suspend/1
  - suspend/2
  - cancel_suspension/0
  - cancel_suspend/1
  - get_status/0
  - get_status/1
  - get_tracerdata/0
  - get_tracerdata/1
  - list_logs/0
  - list_logs/1
  - list_logs/1
  - list_logs/1
  - fetch_log/3
  - fetch_log/2
  - delete_log/2
  - delete_log/1
  - delete_log/1
  - delete_log/1
  - delete_log/0
  - subscribe/0
  - subscribe/1
  - unsubscribe/0
  - unsubscribe/1
- inviso_as_lib
  - Top of manual page
  - setup_autostart/8
  - set_repeat/2
  - inhibit_autostart/1
- inviso_lfm
  - Top of manual page
  - merge/2
  - merge/3
  - merge/5
- inviso_lfm_tpfreader
  - Top of manual page
  - handle_logfile_sort_wrapset/1
- inviso_rt
  - Top of manual page
  - init_tracing/1
  - tp/5
  - tp/4
  - tp/1
  - tpl/4
  - tpl/5
  - tpl/1
  - ctp/3
  - ctpl/3
  - tf/2
  - tf/1
  - ctf/2
  - ctf/1
  - init_tpm/4
  - init_tpm/7
  - tpm/4
  - tpm/5
  - tpm/8
  - tpm_tracer/4
  - tpm_tracer/5
  - tpm_tracer/8
  - tpm_ms/5
  - tpm_ms_tracer/5
  - ctpm_ms/4
  - ctpm/3
  - local_register/0
  - remove_local_register/0
  - global_register/0
  - remove_global_register/0
- inviso_rt_meta
  - Top of manual page
  - tpm_ms/5
  - tpm_ms_tracer/5
  - list_tpm_ms/3
  - ctpm_ms/4
  - get_tracer/0

# inviso_lfm_tpfreader

### MODULE

inviso_lfm_tpfreader

### MODULE SUMMARY

Inviso Standard Reader Process to Standard Logfile Merger

### DESCRIPTION

Implements the standard reader process to the standard logfile merger inviso_lfm.

The reader process reads logfiles belonging to the same set (normally one node) in chronological order and delivers logged trace messages one by one to the output process. Before any trace messages are delivered, the inviso_lfm_tpreader implementation reads the entire trace information file (if in use) and builds a database over pid-to-alias associations.

The inviso_lfm_tpreader implementation is capable of considering that an alias may have been used for several processes during different times. An alias may also be in use for several pids at the same time, on purpose. If a process has generated a trace message, all associations between that pid and aliases will be presented as the list PidMappings in the message sent to the output process.

### EXPORTS

handle_logfile_sort_wrapset(LogFiles) -> FileList2

Types:

LogFiles = [{trace_log, FileList}]
FileList = FileList2 = [FileName]
FileName = string()

Only one {trace_log, FileList} tuple is expected in LogFiles, all other tuples are ignored. FileList must:

- contain one single file name, or
- a list of wraplog files, following the naming convention <Prefix><Nr><Suffix>.

Sorts the files in FileList in chronological order beginning with the oldest. Sorting is only relevant if FileList is a list of wraplogs. The sorting is done on finding the modulo-counter in the filename and not on filesystem timestamps.

This function is exported for convenience should an own reader process be implemented.

### The Trace Information File Protocol

The format of a trace information file is dictated by the meta tracer process. The inviso_lfm_tpfreader implementation of a reader process understands the following trace information entries. Note that the inviso_rt_meta trace information file is on binary format prefixing every entry with a 4 byte length indicator.

{Pid, Alias, alias, NowStamp}

  Pid = pid()
  Alias = term()
  NowStamp = term(), but in current implementation as returned from erlang:now/0

  This message indicates that from now on shall Pid be associated with Alias.

{MaybePid, Alias, unalias, NowStamp}

  MaybePid = pid() | undefined
  Alias = term()
  NowStamp = term(), see above

  This message indicates that, if MaybePid is a pid, this pid shall no longer be associated with Alias. If it is undefined, all associations with Alias from now shall be considered invalid.

  Also note that there are many situations where unalias entries will be missing. For instance if a process terminates without making explicit function calls removing its associations first. This is seldom a problem unless the pid is reused.