xiputil.exe
Xiputil is used to collect file I/O traces from a running ERA game and create streaming install plans to enable XIP (Xbox Instant Play) functionality when installing from optical media.
Xiputil provides the subcommands and functions described in the following table.
|
Command |
Description |
| xiputil collect | Collects the results of the real time I/O profiler. Pauses and resets (if running) the profiling trace of a packaged game's reads. If no game is running the output of the last profiling trace will be used. The profiling trace is stored within \\\DevelopmentFiles\XipFiles.</td> </tr>
| xiputil interpret | Interprets the supplied streaming plan and merges it with the package's table of contents. The results are then filtered and output based on the supplied options. The output is a human readable text file. If not supplied, the format is by time and filter includes reads and misses. Formatting by offset sorts accesses by their offset into the container. Formatting by summary or detailed produces a text file that can be diffed using off-the-shelf tools to detect differences between iterations of the package and streaming plans. |
| xiputil optimize | Converts and optimizes the specified trace, outputing the streaming plan to the specified path. |
| xiputil raw | Outputs IO reads in offset or time order. |
</table>
## xiputil collect
Collects the results of the real time I/O profiler. Pauses and resets (if running) the profiling trace of a packaged game's reads. If no game is running the output of the last profiling trace will be used. The profiling trace is stored within \\\DevelopmentFiles\XipFiles
xiputil collect <tracefilename>[/?]
|
|
Option |
Description |
|---|
| <tracefilename> | Specifies the file name to store the I/O trace. The trace will be accessible on the console under D:\DevelopmentFiles\XipFiles\ |
| /? | Displays help text. |
## xiputil interpret
Interprets the results of a Xiputil collected I/O trace and produces a report in human readable and/or tool diffable format.
xiputil interpret /trace:<pathtotrace> /toc:<pathtotocfile> /out:<pathtoreportfile> [/filter:<misses|reads>] [/format:<time|offset|summary|detailed>] [/?]
|
|
Option |
Description |
|---|
| /trace:<pathtotrace> | Specifies the trace file to be analyzed. |
| /toc:<pathtotocfile> | Specifies the toc file to look up file mappings. Produced by MakePkg.exe - find this next to your game package file, with an .toc.xml extension. |
| /out:<pathtotrace> | Specifies where to place the produced XIP streaming plan file. |
| [/filter:<misses|reads>] | Used when analyzing a trace collected when installing via xbapp install /oddsim or from burned optical media. Specifies whether the report should include I/O accesses which were serviced from the HDD (reads), I/O accesses which were serviced by the ODD (misses) or both. |
| [/format:<time|offset|summary|detailed>] | Specifies what type of analysis report to produce. Formatting by offset sorts accesses by their offset into the container. Formatting by summary or detailed produces a text file that can be diffed using off-the-shelf tools to detect differences between iterations of the package and streaming plans. |
| /? | Displays help text. |
## xiputil optimize
Converts and optimizes the specified trace, outputing the streaming plan to the specified path.
xiputil optimize /trace:<tracefile> /out:<streamingplanfile>
|
|
Option |
Description |
|---|
| /trace:<tracefile> | Specifies the trace file to use when creating the plan. |
| /out:<streamingplanfile> | Specifies output location for the streaming plan file. |
## packageutil raw
Outputs IO reads in offset or time order.
xiputil raw /trace:<tracefile> /out:<pathtoreportfile> [/format:<time|offset>]
|
|
Option |
Description |
|---|
| /trace:<tracefile> | Specifies the trace file to process. |
| /out:<pathtoreportfile> | Specifies output location for the report output. |
| /format:<time|offset> | Specifies whether to sort by offset or time order. |
|