doc/hspice-output.txt

   1
   2 Notes on the format of "post" files generated by HSPICE.
   3
   4 All copyrights disclaimed on this text file only -
   5         this file, hspice-output.txt, is in the public domain.
   6
   7 -----------------------------------------------------------------------------
   8
   9 Sample header from an hspice file, line numbers added for illustration.
  10
  11  1   00010002000000009601
  12  2                   09/10/9813:30:19 Copyright (C) 1985-1997 by Avant! Corporation.
  13  3                              0
  14  4                             1       1       1     TIME            v(a
  15  5   v(b             $&%#      1       1       1     TIME            v(a
  16  6   0.00000E+000.00000E+00 .00000E+00 .12500E-09 .00000E+00 .00000E+00 .2500
  17
  18
  19 Line 1 contains three fixed-width fields of interest:
  20  0-3    integer (0001 above) the number of automaticly-recorded
  21         variables in the file. It will be 1 if ".option probe" is specfied,
  22         larger otherwise.  I call this nauto in my code.
  23
  24  4-7    integer (0002 above) the number of output variables added by the user's
  25         .graph, .probe and .plot statements.  I call this nprobe.
  26
  27 16-19   The version of the fileformat.   Values seen are 9007 and 9601,
  28         corresponding to the version of HSPICE where the fileformat
  29         was last changed.
  30
  31 hspice file format "9601" is the default in hspice 98.2 (9007 was
  32 previous).  Difference is in how nodenames 16 characters and longer
  33 are handled.  Processing the fields starting on line 4 as whitespace-seperated
  34 fields filereader always does 9601 correctly, and does 9007 correctly if
  35 nodnames are 15 characters or shorter.
  36
  37 Line 2 seems to be just the silly copyright notice.
  38
  39 Line 3 contains one integer.  If it is 0, there is a single table of
  40 data in the file, and no sweeps are present.  If it is greater than 0,
  41 it indicates how many tables of data are present in the file.
  42 Processing for values 0 and 1 is otherwise done identicaly.
  43 Processing for values greater than one will get interesting.
  44
  45 Starting on line 4 is a set of lines containing the types and names of each
  46 variable.   As noted above, it almost works in all cases to paste
  47 the lines together and treat the result as having whitespace-seperated fields.
  48
  49 First comes an integer for each variable, indicating the variable type.
  50
  51 The first variable is the independent variable.  The integral types for this
  52 also indicates the analysis type.
  53 1       Transient analysis; type is time.
  54 2       AC analysis; type is frequency
  55 3       DC sweep; type is voltage
  56
  57 The type numbers for the dependent variables are:
  58
  59 1       voltage as dependent var in sweep or transient
  60 2       voltage as dependent var in AC analysis
  61 8       current
  62 9       magnitude of current (not verified)
  63 10      real part of current (not verified)
  64 11      imaginary part of current (not verified)
  65 15      current
  66
  67
  68 After the variable-type integers come the variable names.
  69 A variable name of "$&%#" indicates the end of the list; anything after
  70 this on the last line should be ignored.
  71
  72 Next comes the ascii floating-point data.  There are a fixed number of floats
  73 per line, and the data can be thought of as a set of columns.  Sometimes there
  74 is a space between columns, and somtimes there a leading zero for the number
  75 in the next column takes its place, so for "portability" parse as 11-character
  76 fixed fields.
  77
  78 For DC and transient analysis, the number of columns is equal to the number
  79 of variables.
  80 For AC analysis, it appears that the automaticly-inserted dependent variables
  81 have two columns of data that go with them, presumably for the real and
  82 imaginary parts.
  83
  84 In the ascii tables, it appears that if there is a very large value for an
  85 independent-variable (usually 0.1e+31) that indicates the end of a table.
  86
  87
  88 -----------------------------------------------------------------------------
  89
  90 About Binary Hspice files:
  91 generate with ".options POST=1"
  92
  93 Theese files appear to have 16-byte binary header, then an ascii
  94 header similar (identical?) to that from an ascii hspice file,
  95 followed by binary data.
  96
  97 output from test.hsp:
  98 ascii has 292 floating-point values - 97 rows of three, plus one extra.
  99 binary has 1192 bytes in the binary data section - could be 149 doubles or
 100 298 floats, or maybe some is some sort of header/trailer/control info.
 101
 102 binary header is:
 103 00 00 00 04 00 00 00 2b  00 00 00 04 00 00 01 58   .......+.......X
 104
 105 guess: 4 32-bit ints,
 106 fourth one is length in bytes of the ascii header portion.  In this case,
 107 binary data starts at offset 0x0168.
 108
 109 confirmed this by adding another output item to test1.hsp - start of
 110 binary data moves to offset 0x0180, 4th integer in header is 0x170.
 111 With four plotted items, the pattern in the binary data is real
 112 obvious.
 113
 114 Looks like there are 5 more 32-bit longwords, then binary floats.
 115
 116 test1.tr0.binary:
 117 000170  20 20 20 20 20 20 20 20  24 26 25 23 20 20 20 20           $&%#
 118 000180  00 00 01 70 00 00 00 04  00 00 01 85 00 00 00 04   ...p............
 119 000190  00 00 06 14 00 00 00 00  00 00 00 00 00 00 00 00   ................
 120 0001a0  80 00 00 00 2f 09 70 5f  00 00 00 00 00 00 00 00   ..../.p_........
 121 0001b0  80 00 00 00 2f 89 70 5f  00 00 00 00 00 00 00 00   ..../.p_........
 122
 123 floating-point data appears to start at offset 0x194 here.  It could be
 124 that the value 0x195 (word at 0x188) is related to this offset.  the
 125 value 0x614 at offset 0x190 appears related to the size of the
 126 floating-point data.  At the end of the file we have:
 127
 128 000780  af c5 1b fa 34 54 d0 cd  00 00 00 00 00 00 00 00   ....4T..........
 129 000790  af 6c 87 f9 34 56 bf 95  00 00 00 00 00 00 00 00   .l..4V..........
 130 0007a0  af 24 5e 7d 71 49 f2 ca  00 00 06 14               .$^}qI......
 131
 132 Data block size is 0x7a8-0x194, or 0x614.
 133 Last word is 0x614 - matches word at 0x190.
 134 Clearly this is a repeat of the block-size.
 135
 136 The pattern for this block structure used for both the ascii header and
 137 the floating point data appears to be:
 138         4-word header, last word indicating data size in bytes
 139         data
 140         1-word trailer consisting of the size-word.
 141
 142
 143 remaining questions:
 144
 145 What are the 32-bit floating-point values?
 146 single-precision IEEE? single-precision native floating point?  On HP,
 147 these are the same thing so we really can't tell.  I haven't got
 148 access to hspice binaries for other architectures.
 149
 150 What happens to the binary integers in non big-endian architectures?
 151 Are the files in network-order (i.e. always big-endian and portable)
 152 Or are they in native byte-order?  Idealy, readers should be able to read
 153 any file on any architecture.
 154 If the files aren't always big-endian, how would one determine the endianness
 155 of the file?
 156
 157 -----------------------------------------------------------------------------
 158
 159
 160 Hspice ascii files containing multiple DC sweeps.
 161
 162 Here is an hspice file produced by a current vs. voltage sweep, with no extra
 163 sweep parameters from ".DC vtest 0 0.6 0.01 vsup 1.6 1.6 0.1"
 164
 165 00010001000000009007    * dospice hspice deck from jpfet.cmd+jpfet.gfa+_loadsfil
 166 e_       10/18/9918:16:59 Copyright (C) 1985-1997 by Avant! Corporation.
 167                            0
 168                           3      15     VOLTS           i1(rtest        $&%#
 169  .00000E+00 .40592E-15 .10000E-01 .23246E-04 .20000E-01 .46289E-04 .30000E-01
 170  .69128E-04 .40000E-01 .91763E-04 .50000E-01 .11420E-03 .60000E-01 .13642E-03
 171  .70000E-01 .15845E-03 .80000E-01 .18027E-03 .90000E-01 .20189E-03 .10000E+00
 172  .22330E-03 .11000E+00 .24451E-03 .12000E+00 .26551E-03 .13000E+00 .28632E-03
 173  .14000E+00 .30692E-03 .15000E+00 .32731E-03 .16000E+00 .34750E-03 .17000E+00
 174  .36749E-03 .18000E+00 .38727E-03 .19000E+00 .40685E-03 .20000E+00 .42623E-03
 175  .21000E+00 .44540E-03 .22000E+00 .46437E-03 .23000E+00 .48313E-03 .24000E+00
 176  .50170E-03 .25000E+00 .52005E-03 .26000E+00 .53821E-03 .27000E+00 .55616E-03
 177  .28000E+00 .57390E-03 .29000E+00 .59145E-03 .30000E+00 .60878E-03 .31000E+00
 178  .62592E-03 .32000E+00 .64285E-03 .33000E+00 .65958E-03 .34000E+00 .67610E-03
 179  .35000E+00 .69242E-03 .36000E+00 .70854E-03 .37000E+00 .72445E-03 .38000E+00
 180  .74016E-03 .39000E+00 .75566E-03 .40000E+00 .77096E-03 .41000E+00 .78606E-03
 181  .42000E+00 .80096E-03 .43000E+00 .81565E-03 .44000E+00 .83013E-03 .45000E+00
 182  .84442E-03 .46000E+00 .85849E-03 .47000E+00 .87237E-03 .48000E+00 .88604E-03
 183  .49000E+00 .89951E-03 .50000E+00 .91278E-03 .51000E+00 .92584E-03 .52000E+00
 184  .93870E-03 .53000E+00 .95135E-03 .54000E+00 .96381E-03 .55000E+00 .97606E-03
 185  .56000E+00 .98810E-03 .57000E+00 .99995E-03 .58000E+00 .10116E-02 .59000E+00
 186  .10230E-02 .60000E+00 .10343E-02 .10000E+31
 187
 188
 189 And here is a similar file, with one extra sweep parameter that takes
 190 on only one value; produced by
 191
 192 ".DC vtest 0 0.6 0.01 vsup 1.6 1.6 0.1"
 193
 194 00010001000100009007    * dospice hspice deck from jpfet.cmd+jpfet.gfa+_loadsfil
 195 e_      10/18/9918:18:10 Copyright (C) 1985-1997 by Avant! Corporation.
 196                            1
 197                           3      15     VOLTS           i1(rtest        0:vsup
 198         $&%#              3      15     VOLTS           i1(rtest        0:vsup
 199  .16000E+01 .00000E+00 .40592E-15 .10000E-01 .23246E-04 .20000E-01 .46289E-04
 200  .30000E-01 .69128E-04 .40000E-01 .91763E-04 .50000E-01 .11420E-03 .60000E-01
 201  .13642E-03 .70000E-01 .15845E-03 .80000E-01 .18027E-03 .90000E-01 .20189E-03
 202  .10000E+00 .22330E-03 .11000E+00 .24451E-03 .12000E+00 .26551E-03 .13000E+00
 203  .28632E-03 .14000E+00 .30692E-03 .15000E+00 .32731E-03 .16000E+00 .34750E-03
 204  .17000E+00 .36749E-03 .18000E+00 .38727E-03 .19000E+00 .40685E-03 .20000E+00
 205  .42623E-03 .21000E+00 .44540E-03 .22000E+00 .46437E-03 .23000E+00 .48313E-03
 206  .24000E+00 .50170E-03 .25000E+00 .52005E-03 .26000E+00 .53821E-03 .27000E+00
 207  .55616E-03 .28000E+00 .57390E-03 .29000E+00 .59145E-03 .30000E+00 .60878E-03
 208  .31000E+00 .62592E-03 .32000E+00 .64285E-03 .33000E+00 .65958E-03 .34000E+00
 209  .67610E-03 .35000E+00 .69242E-03 .36000E+00 .70854E-03 .37000E+00 .72445E-03
 210  .38000E+00 .74016E-03 .39000E+00 .75566E-03 .40000E+00 .77096E-03 .41000E+00
 211  .78606E-03 .42000E+00 .80096E-03 .43000E+00 .81565E-03 .44000E+00 .83013E-03
 212  .45000E+00 .84442E-03 .46000E+00 .85849E-03 .47000E+00 .87237E-03 .48000E+00
 213  .88604E-03 .49000E+00 .89951E-03 .50000E+00 .91278E-03 .51000E+00 .92584E-03
 214  .52000E+00 .93870E-03 .53000E+00 .95135E-03 .54000E+00 .96381E-03 .55000E+00
 215  .97606E-03 .56000E+00 .98810E-03 .57000E+00 .99995E-03 .58000E+00 .10116E-02
 216  .59000E+00 .10230E-02 .60000E+00 .10343E-02 .10000E+31
 217
 218
 219 Note that the data in the second file is identical to that in the
 220 first, except for an extra value "1.6" at the start of the data block.
 221
 222 There is also an additional nonzero field in the first header line.
 223 Hypothesis: this tells us how many sweep-parameter variables are stuck in
 224 the start of the data block.
 225
 226 -----------------------------------------------------------------------------
 227
 228
 229
 230
 231 I recieved this email from a gwave contributor.  I believe that most
 232 of these details have been incorporated into the text above, and have
 233 been verified in the implementation.
 234
 235 From hlee@gltusa.com Fri Mar  5 17:10:24 1999
 236 Date: Fri, 29 Jan 1999 17:41:08 -0800
 237 From: "H. Lee" <hlee@gltusa.com>
 238 To: tell@cs.unc.edu
 239 Cc: hlee@gltusa.com
 240 Subject: Some information about hspice output format
 241
 242     [The following text is in the "big5" character set]
 243     [Your display is set for the "iso-8859-1" character set]
 244     [Some characters may be displayed incorrectly]
 245
 246 I read the hspice.txt file in your gwave distribution
 247 and I would like to add a few point. Hopefully this
 248 will help. As I did not dig into the code to see what
 249 actually get implemented, if you find this something
 250 you already know, just discard this email.
 251
 252 The information I have is derived from Hspice 97.04 so
 253 it is still 9007. I only ran the test for post=2(ascii o/p).
 254
 255 Looks likes that the ascii header did have some
 256 information in there.
 257
 258 eg.
 259 line 1:00050004000000009007    a simple ac run
 260 line 2:                99/01/2819:30:35 Copyright (C) 1985-1997 by
 261 Avanti!,Inc.
 262 line 3:                           0
 263 line 4:                          1       1       1       1
 264 8        2     2
 265 line 5: 8     8     HERTZ       0       1         2
 266 line 6:I(v1         v(1         v(2     i(r2      i(c1
 267 line 7:$&%#         v(1         v(2     i(r2      i(c1
 268
 269 The first number in line 1 "0005" means that in the hspice file
 270 .option line, only post is specified and probes is not specified
 271 in the .option line. The 5 means that including the independent
 272 variable, there are 5 variables that hspice will automatically
 273 store data in the output file.
 274
 275 Further, the first number in line 4 "1" has some meaning too.
 276 It seems that 1 means transient so the independent variable is TIME.
 277 2 means ac analysis so the independent variable is HERZ.
 278 3 means dc analysis so the independent variable is VOLTS.
 279 The three 1's and one 8's following the first 1's in line 4 basically
 280 said there are 1 0's,2 voltages and one current. It also seems that in
 281 the five variables hspice automatically stored for us, for transient
 282 and dc, there are one column of data per variable, for ac, there are
 283 2 column per variable (except '0').
 284
 285 The second number in line 1 "0004" basic said that in hspice file
 286 there are .print or .plot or .probe line for four additional
 287 variables, for example .probe v(1) v(2) i(r2) i(c1). And for these
 288 probed variables, they are magnitude only, thus one column of data
 289 per variable. That come down to 13 columns of data in quickAC.ac0(
 290 HERTZ -> 2 columns, 0 -> one columns, 1 2 I(v1 -> 2 columns each,
 291 v(1 v(2 i(r2 i(c1 -> one column each. The corresponding numbers in
 292 line 4 and line 5 for v(1 v(2 i(r2 i(c1 have meaning, too. For example,
 293 8 means current(.probe i(c1), 9 means magnitude of current(.probe
 294 im(c1)),
 295 10 means real part of current(.probe ir(c1)), 11 means image part of
 296 current
 297 (.probe ii(c1)), etc.
 298
 299 If in hspice file, both post and probes are specified in .option line,
 300 then the first number of line 1 will just be "0001" with the second
 301 number in line 1 specify the actual number of variables probed in
 302 hspice file.  So the number of column of data will be the sum of first
 303 number and second number in line 1.
 304
 305 One last point, if there are sweep in the hspice file. The number in
 306 line 3 will change too. For example, if there is, say .dc vd 0 3.6 0.6
 307 vg 0.9 3.6 0.9, then the number in line 3 will becom 4 for vg = 0.9
 308 1.8 2.7 3.6 and there will be four set of data.
 309
 310 Again, hope this helps and hope that these get implemented in the next
 311 release
 312 of gwave.
 313
 314 Regards,
 315
 316 Hung-Yi Lee
 317
 318 (408)4929068 x182              hlee@gltusa.com
 319
 320
 321