source: trunk/release_notes.working @ 2139

Revision 2139, 60.5 KB checked in by dietz, 14 years ago (diff)

* empty log message *

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1***
2***  THIS FILE IS UNDER RCS - DO NOT MODIFY UNLESS YOU HAVE
3***  CHECKED IT OUT USING THE COMMAND CHECKOUT.
4***
5***    $Id$
6***
7
8Release Notes:  Earthworm Version "working"
9Cleaned out after release of v6.2 on 4/15/2003
10Note that v6.3 was a CVS snapshot that was released on 9/21/2005
11
12NEW MODULES:
13***********
14
15pkfilter:
16The purpose of pkfilter is to reduce the number of "duplicate" picks
17from a given "station". For pkfilter, all components which have
18matching station code and network code are considered to be the from the
19same "station". The rules for what are considered "duplicate" picks
20can be found in the file:
21vX.X/src/seismic_processing/pkfilter/pkfilter.designspecs.txt
22Pkfilter is location-code friendly and will handle both the TYPE*2K
23and TYPE*SCNL versions picks and codas.  LDD 5/5/2004
24
25statrigfilter:
26The purpose of statrigfilter is to eliminate "duplicate" triggers
27from a given "station". For statrigfilter, all channels which have
28matching station code and network code are considered to be the from the
29same "station". The rules for what are considered "duplicate" triggers
30can be found in the file:
31vX.X/src/seismic_processing/statrigfilter/statrigfilter.designspecs.txt
32Statrigfilter is location-code friendly and will handle both
33TYPE_CARLSTATRIG_SCNL and TYPE_CARLSTATRIG messages.  LDD 11/23/2005
34
35putpick:
36   Putpick is a command-line testing tool which allows one to replay
37a file containing picks and/or codas into an Earthworm ring.
38     Usage: putpick <pickfile> <RING_NAME> <pause: y/n>
39Putpick reads a file containing a series of pick/coda msgs
40and write them to shared memory.  The file can contain a mix
41of TYPE_PICK2K, TYPE_PICK_SCNL, TYPE_CODA2K, TYPE_CODA_SCNL,
42and also comments.  Only valid TYPE_PICK* and TYPE_CODA* msgs
43will be written to shared memory; all other lines will be ignored.
44   Putpick is useful for replaying picks into binder - binder's
45logfile (or a portion of it) can be used as the input file
46to putpick, or the picks can be placed in a separate file.
47   If pause = y, the relative timing of writing msgs to ring is
48based on delta-t in the timestamps in the picks.
49   If pause = n, the msgs are written to the ring as fast
50as they are read from the file.   LDD 6/25/2004
51
52ws_clientIIx:
53Added a new set of ws_client routines (ws_clientIIx), that are used by
54ora_trace_fetch.  The new routines were designed to streamline and
55simplify access to the wave_servers while conserving wave_server
56resources.  (The routines handle connect/disconnect for the caller,
57and if given a list of requests, the routines will sort the request
58by wave_server, so that it will connect to one wave_server, retrieve
59the appropriate data, disconnect from the first and connect to the
60second, retrieve the appropriate data, and so on.
61The routines were written in 2001, (derived from ws_clientII) and have
62never been as thoroughly tested as ws_clientII.
63The routines have not been scheduled for SCNLizing.
64DK 072004
65
66scn2scnl,scnl2scn:
67A pair of conversion modules (code resides in data_exchange/scn_convert)
68to change trace data, picks and codas from the original Earthworm formats
69with site,component,network codes to the new Earthworm formats using
70site,component,network,location codes and visa versa.  Written by Will
71Kohler, modified by Pete Lombard to do SCN->SCNL lookups.
72LDD 10/21/2004
73
74slink2ew:
75A seedlink client for acquiring data from seedlink servers (e.g. IRIS)
76and converting to tracebuf2 (or optionally tracebuf). Much more robust
77than liss2ew. Written by Chad Trabant of IRIS; modified for tracebuf2
78and debugged by Chad Trabant and Jim Luetgert.
79JHL 4/19/05
80PAF Updated with version 1.3 on 1/30/2006
81
82export_ack, export_scnl_ack:
83  This new version of export expects to receive an acknowledgment packet
84for every packet it writes to the socket. Creation of this new version
85was desired because we observed during the export of continuous trace
86data that during a communication failure, export was able to successfully
87write several messages to the (broken?) socket, but import never received
88them. When the socket was re-established, those messages were lost forever.
89  Acknowledgments are received asynchronously by the socket-reading thread.
90A circular buffer, SendQueue, tracks the status of msgs after they been
91pulled from the MessageStacker queue. If the socket is broken/reconnected,
92export*ack re-sends any msgs in the SendQueue which haven't been
93acknowledged. In normal operation, if export*ack laps the SendQueue and
94finds a message that has been sent but not ACKed, it will sleep 10ms and
95then check status again, looping until an ACK is received before preparing
96to send the next message.
97  The SendQueue length is configurable, from 1 to 254 messages (default=100). 
98Using a shorter SendQueue can cause a decrease in the rate at which
99export will send messages. A slower rate might be desireable so
100that an import system is not flooded by data after a prolonged
101communication break. In testing with export and import on the same
102machine, these are export's approximate maximum data rates:
103  SendQueueLength =   1,   10 messages/second
104  SendQueueLength =  10,   90 messages/second
105  SendQueueLength = 100,  350 messages/second
106Using the default SendQueueLength, export*ack's data rate was not
107observably different than export_generic's data rate. 
108  export*ack requires using the new import_ack to communicate properly.
109Since the receipt of ACKs is asynchronous, we may now have the opposite
110problem to that we had before (duplicate data instead of lost data). It
111is now possible that import_ack actually received a packet, but export_ack
112didn't get the ACK before the socket broke. In this is case, export_ack
113will re-send the packet and import_ack will see the same packet more than
114once. The system running import_ack must be prepared for duplicate data.
115LDD 4/29/2005
116
117import_ack:
118  This new version of import is required as the data exchange partner
119for the new export*ack modules. However, it can communicate with either
120old or new-protocol export modules, and can therefore be used anywhere
121in place of import_generic.
122  From the first message received per socket connection, import_ack
123discovers what flavor of export it's talking to. It will do either
124old non-ACK or new ACK protocol as appropriate on the fly.
125  Import_ack has been modified to use same configuration commands as
126export for setting up the server connection and socket heartbeat
127strings and intervals. It still recognizes the original import_generic
128commands. 
129  Since the receipt of ACKs by export_ack is asynchronous, we may now
130have the opposite problem to that we had before (duplicate data instead
131of lost data). It is now possible that import_ack received a packet,
132but the socket broke before export_ack received the ACK. In this is case,
133export_ack will re-send the packet and import_ack will see the same packet
134more than once. Therefore, the system running import_ack as a partner to
135export_ack must be prepared to handle duplicate data.  LDD 4/29/2005
136
137wftimefilter:
138  This new module was created to "sanitize" incoming waveform data
139streams to the liking of Earthworm modules. It reads waveform data
140(compressed or uncompressed) from one transport ring and writes it
141to another ring, filtering out duplicate data, time overlaps and
142bogus future timestamped data. Timestamp checks are done for each
143channel independently. The check for bogus future timestamps requires
144that the system clock is set to network time.
145  Wftimefilter can be configured to output the messages using the
146original installation/moduleid or its own installation/moduleid.
147However, it does not alter the contents of the message in any way.
148  Systems which are importing data using import_ack/export*ack should
149probably use wftimefilter to remove possible duplicate data after
150an import/export reconnect. Systems importing waveform data from
151non-Earthworm data sources should also consider running wftimefilter
152to ensure that only chronological timeseries enter their own Earthworm
153processing.  LDD 5/10/2005
154  Modifed to allow additional optional behavior:
155   1)rejecting packets that have a sample-rate different than the expected one for the
156     channel. 
157   2)Limiting per-channel logging, to limit logfile size and increase readability.
158   3)Adding per-channel daily summaries of errors and warnings.
159   4)Adding the ability to issue a STATUS message to a ring as a part of the daily summary.
160  Default behavior should be unchanged.
161DK 2006/03/27
162
163startstop_service:
164(added to CVS by Paul Friberg 6/29/2005, authored by Mark Morrison)
165From the README.txt found in the src/system_control/startstop_sevice:
166startstop_service is identical to the old startstop_nt, except that
167it runs as a Windows service.  This means that the parameters are all the
168same - read from startstop_nt.d - but that startstop isn't just executed
169from a command window or via the scheduler.  Note that this version is
170taken from startstop_nt, so I haven't compiled or tested any of this under
171Solaris or other systems.  I believe it's generally felt, however,
172that these modifications don't apply to Solaris.
173
174srparxchewsend: as a new data source. This is contributed by Symmetric
175Research for their digitizers. It was installed in data_sources by
176Paul Friberg Jan 5, 2005.
177
178rayloc_ew:
179(last revised 13 July, 2004) Ilya Dricker at www.isti.com
180Rayloc_ew is an Earthworm Module to perform global relocation of
181earthquakes and travel time computation.  Rayloc_ew is an Earthworm-style
182wrapper around a Fortran program RayLoc written by Ray Bulland.
183Rayloc_ew attaches itself to the input ring and monitors the ring buffer
184for the TYPE_LOC_GLOBAL
185<http://folkworm.ceri.memphis.edu/ew-doc/PROGRAMMER/GlobalMessages.html>
186messages.  Rayloc_ew reformats the input and calls FORTRAN RayLoc processing
187machinery. The output of rayloc_ew is TYPE_RAYLOC
188<http://www.isti.com/~ilya/Message_Format_TYPE_RAYLOC.html> message,
189which is written to the output ring.  The rayloc_ew program is compiled
190and tested out on a Solaris platform (with gcc and g77 compilers).
191
192startstop_unix:
193Added in this Linux'ified version of startstop (uses a startstop_unix.d file)
194from Alexandre Nercessian: PAF 9/7/2005
195
196raypicker:
197Added this from the HYDRA package for Mitch Withers. This is the picker
198that is used by NEIC to feed glass. Only compile tested under Windows
199at this point since that is where NEIC uses it.
200PAF 01/30/2006
201
202glass:
203Add this from older NEIC distro. This is a global associator written
204by Carl Johnson. This module will only compile/run under Windows.
205PAF 01/30/2006
206
207eqfilterII:
208Added in this new module from Mitch WIthers for handling arc, global,
209and rayloc message types.
210PAF 01/30/2006
211
212geqproc:
213Same tasks as eqproc, but this takes global messages instead of
214arc messages. Part of global event processing chain.
215PAF 01/30/2006
216
217globalproc:
218Moved globalproc from NEIC v0.1 to v7.0.  Recall that globalproc
219listens to the glass chatter, assembles quake, pick, and amp messages
220into a global loc message, and sends it to the ring when appropriate.
221Combined with geqproc, the two accomplish the same thing as what
222eqproc did for binder.  This strays from the original intent of globalproc
223allowing a tweaked eqproc and globalproc to "eat" glass output simultaneously
224but given that we have rayloc, geqproc only needs to locate local events
225so this lashup was easier and does the job. Comments by Mitch Withers:
226PAF 01/30/2006
227
228config_ws:
229This module will listen on a wave_ring for scn or scnl type trace_buf[2]
230messages and create a waveserverV configuration file for the tanks. It
231has a number of configuration options to specify how many tanks and of
232what size they should be.
233This nifty little module is contributed by John Patton of the Hydra
234group and installed by Paul Friberg (only compiles under Windows).
235PAF 02/09/2006
236
237reconfigure:
238This command line tool sends a reconfigure request to startstop. Startstop
239will then re-read startstop_*.d and start up any new rings or modules it
240finds. Duplicate module names and duplicate ring names are not allowed.
241Necessary for this to work is the addition of
242Message  TYPE_RECONFIG       112
243to the earthworm.d file.
244s.lisowski 20060405
245
246
247
248MODIFICATIONS/BUG FIXES TO EXISTING MODULES:
249********************************************
250
251
252startstop:
253Reconfigure or 'recon' command added to startstop module. The command can
254either be given by running the command-line 'reconfigure' tool, or by typing
255'recon' or 'reconfigure' into the interactive EARTHWORM STATUS interface.
256Startstop will then re-read startstop_*.d and start up any new rings or
257modules it finds. Duplicate module names and duplicate ring names are not
258allowed. Necessary for this to work is the addition of
259Message  TYPE_RECONFIG       112
260to the earthworm.d file.
261Also some startstop commonalities for all four platforms (Windows, Windows
262Service, Linux, Solaris) were added to libsrc/util/startstop_lib.c, commonalities
263between Solaris and Linux were added to libsrc/util/startstop_unix_generic,
264commonalities between Windows and Windows Service were added to
265libsrc/winnt/startstop_winlib.c.
266s.lisowski 20060405
267
268logit:
269Made it so that logit now appends a platform-specific slash to EW_LOG if
270there isn't one. This allows for a more consistent entry on in the
271environment/ew_<platform>.{cmd,bash} file.
272s.lisowski 20060405
273
274gmew:
275Added in SCNL capability (no longer available for just SCN) and upgraded
276to the new version of ShakeMapXML (v3.1). I also patched a minor wave server
277warning message to be more explicit (empty menu) and added versioning
278to the program itself.
279PAF 03/15/2006
280
281heli_ewII:
282Added in SCNL capability (no longer available for just SCN).
283PAF 03/15/2006
284
285libsrc/solaris/sleep_ew.c:
286Added: #include <string.h>   WMK 3/22/04
287
288libsrc/solaris/transport.c:
289Added: #include <stdlib.h>
290Function tport_bufthr() now returns NULL.  WMK 3/22/04
291
292libsrc/winnt/transport.c:
293Added: #include <stdlib.h>
294
295libsrc/util/kom.c
296Changed: "static struct k_buf" to "struct k_buf"   WMK 3/22/04
297
298libsrc/util/trheadconv.c
299New function to convert TYPE_TRACEBUF headers to
300TYPE_TRACEBUF2 headers.  WMK 4/29/04
301
302libsrc/winnt/sendmail.c
303Increased BUFFSIZE from 200 to 250, to accomodate more email recipients.
304This is a kludgy fix.  It might better to allocate the buffer on the fly,
305to accommodate any number of email messages.  Also, note that I did not
306increase BUFFSIZE in libsrc/solaris/sendmail.c  WMK 6/11/03
307
308libsrc/util/getutil.c
309Added new functions: GetKeyName, GetInstName, GetModIdName, GetTypeName.
310These functions take a numeric value (shared memory key, installation id,
311module id or message type) as their argument and return a pointer to its
312corresponding character string name from the earthworm*d tables.  If the
313numeric value is not in the earthworm*d tables, the functions return a
314NULL pointer.
315Added new function, GetLocalInstName, which return a pointer to the
316environment variable EW_INSTALLATION.
317LDD 7/29/2004
318
319libsrc/util/rw_strongmotionII.c:
320Changed rd_strongmotionII() to interpret both "-" and "?" as NULL strings
321when reading the QID: line qid and qauthor fields.  Previously only
322accepted "?" as a NULL string.  Change was required by CISN data which
323uses "-" as a NULL string in those fields.  LDD 2/13/2004
324
325adsend:
326Modified to produce tracebuf messages with trace2 headers.
327These headers contain location code and header version number.
328Old-style tracebuf messages (w/o location code) are no longer
329made.  WMK 4/22/04
330
331pick_ew:
332  Modified to create picks and codas containing SCNLs.
333Input waveform messages may be of either TYPE_TRACEBUF or
334TYPE TRACEBUF2.  WMK 4/29/04
335  Added new optional config file command so that pick_ew can choose
336which messages to process: GetLogo <instid> <modid> <msgtype>
337There's no limit to the number of GetLogo commands that can be used.
338If no GetLogo commands are used, then pick_ew will process all
339TYPE_TRACEBUF and TYPE_TRACEBUF2 messages in InRing. LDD 4/8/2005
340
341carlstatrig:
342  Modified for location code. Reads TYPE_TRACEBUF2 and produces
343TYPE_CARLSTATRIG_SCNL messages. PNL 5/5/2004
344  Added new optional config command so that carlstatrig can choose
345which messages to process: GetWavesFrom <instid> <modid>
346There's no limit to the nubmer of GetWavesFrom commands that can
347be used. If no GetWavesFrom commands are listed, then carlstatrig
348defaults to "GetWavesFrom INST_WILDCARD MOD_WILDCARD". LDD 4/12/2005
349
350binder_ew:
351  Modified to use TYPE_PICK_SCNL as input.  Required changes to the
352station file reading library, site.c, and to the hypoinverse site file.
353LDD 5/17/2004
354  Modified to attempt pick association with entire quake list before
355attempting a new stack. Previously only attempted association with
356the 10 most recent events.  This should allow picks to arrive fairly
357late (out-of-real-time) and still be associated with an event. This
358will prevent such picks from restacking into a new, duplicate event.
359This modification requires that binder keep track of the earliest
360pick sequence number associated with each quake so that no hypocenter
361updates are attempted if some of the supporting picks are no longer
362in the pick FIFO. If a Pick  associates with an event that can't
363be updated, a TYPE_LINK message will go out, but no relocation will
364be done, and no new TYPE_QUAKE2K message will be issued.
365LDD 10/21/2004
366  grid.c changes: Added sanity check on mStack value; modified grid_stack
367to go thru pick list from newest to oldest pick.
368LDD 10/29/2004
369  bind.c: Modified to make the pick and quake FIFO lengths configurable.
370Added two optional config file commands:
371pick_fifo_length xxxx (default = 1000 = previous hardcoded length)
372quake_fifo_length yyy (default =  100 = previous hardcoded length)
373Only large networks should need to consider using these commands to
374increase FIFO sizes. Care must be taken to ensure that eqproc/eqprelim
375FIFO lengths are the same length (or larger) than binder_ew's FIFOs.
376LDD 3/9/2005
377  Modified to shut down cleanly on termination request. LDD 4/15/2005
378  binder_ew.c: Added two optional commands:
379BufferRing  ringname (default = BINDER_RING = previous hardcoded string)
380            This defines which ring binder will use for private storage
381            space for incoming picks. ringname must exist in an earthworm.d
382            "Ring" line.
383EventIdFile filename (default = quake_id.d  = previous hardcoded string)
384            This defines the name of the file that will contain the
385            next valid eventid for binder to apply to a new association.
386Having these two items hardcoded had made it extremely tricky to run
387multiple instances of binder on the same host without them competing for
388common resources. Now it will be a simple matter of different configuration
389files to run multiple instances. This could be useful in testing
390different binder configurations.  LDD 8/1/2005
391
392eqproc:
393Modified to use TYPE_PICK_SCNL and TYPE_CODA_SCNL as input.
394Modified to produce TYPE_EVENT_SCNL as output.
395LDD 5/17/2004
396  Modified to make four more operational parameters configurable.
397All are set with new optional config file commands and default to
398the previous hardcoded values if their commands are ommitted.
3991. pick FIFO length ('pick_fifo_length' command, default = 1000)
4002. quake FIFO length ('quake_fifo_length' command, default = 100)
401For proper event reporting, eqproc's pick and quake FIFO lengths must
402greater than or equal in length to binder's FIFOs.
4033. heartbeat interval ('HeartbeatInt' command, default = 0.3*tReport)
4044. time interval at which quake FIFO is checked for events that are
405ready to send downstream ('rpt_check' command, default = 0.3*tReport)
406Items 3 & 4 were previously a hardcoded fraction of tReport, which is
407configured with the optional 'rpt_dwell' command (default = 30 s).
408These changes should allow eqproc to send events downstream in a more
409timely fashion.  LDD 3/10/2005
410
411eqprelim:
412Modified to use TYPE_PICK_SCNL and TYPE_CODA_SCNL as input.
413Modified to produce TYPE_EVENT_SCNL as output.
414LDD 5/17/2004
415  Modified to make two more operational parameters configurable.
416Both are set with new optional config file commands and default to
417the previous hardcoded values if their commands are ommitted.
4181. pick FIFO length ('pick_fifo_length' command, default = 1000)
4192. quake FIFO length ('quake_fifo_length' command, default = 100)
420For proper event reporting, eqprelim's pick and quake FIFO lengths must
421greater than or equal in length to binder's FIFOs.  LDD 3/11/2005
422
423eqcoda:
424Modified to use TYPE_EVENT_SCNL as input and to write location codes
425in the TYPE_HYP2000ARC message it puts out. Added new optional command
426"LogArcMsg" to control whether output TYPE_HYP200ARC msg is written to
427eqcoda's log file (0=don't log; non-zero=do log it).  LDD 5/20/2004
428
429hyp2000:
430Grabbed Fred Klein's most recent version of hyp2000 which is location-code
431compliant.  LDD 7/01/2004
432Grabbed Fred Klein's most recent version of hyp2000 which has a new
433command 'DI1' to set a different distance weighting scheme for early
434iterations.  Normal distance weighting is still set with the 'DIS'
435command. This change was prompted by trouble locating the Parkfield
436mainshock of 9/2004.  LDD 12/8/2004
437Grabbed Fred Klein's most recent version of hyp2000 which has added
438logic to allow location codes "  " and "--" to match (they both
439represent a "blank" location code). LDD 10/5/2005
440
441ew2file:
442Added optional command "TimeBasedFilename X" to control whether a
443time string derived from the message contents is added to the beginning 
444of the output file names. If X is zero (default), original file naming
445convention is used (SequenceNumber.suffix). If X is non-zero, a time
446string is prepended to the filename (YYYYMMDD-HHMMSS.SequenceNumber.suffix).
447This option is only applicable for TYPE_PICK2K, TYPE_PICK_SCNL, and
448TYPE_HYP2000ARC messages. All other message types will be named
449according to the original convention regardless of the TimeBaseFilename
450setting.  Other messages types containing timestamps could be added
451to the new naming scheme in the future.  LDD 11/11/2005
452
453evanstrig:
454Modified to use TYPE_TRACEBUF2 as input and to write TYPE_LPTRIG_SCNL
455as output. Both message types include location codes.  Changed config
456file command "MaxSCN" to "MaxSCNL".  Added location code as the fourth
457argument to the "TriggerOn" command. LDD 5/21/2004
458
459evansassoc:
460Added location code; modified to use TYPE_LPTRIG_SCNL as input and to
461write TYPE_TRIGLIST_SCNL as output.  Added location code as the fourth
462argument to the "AddChannel" command. LDD 5/24/2004
463
464putter:
465Modified to read files of TYPE_PICK_SCNL and TYPE_CODA_SCNL. Added
466optional second argument, ringname (name of ring to write msgs to).
467Previously was hardcoded to write to PICK_RING. Will still work with
468TYPE_PICK2K and TYPE_CODA2K msgs as long as the installation id and
469moduleid are less than 100.  LDD 5/17/2004
470
471findwave:
4721. Modified to read both TYPE_TRACEBUF2 and TYPE_TRACEBUF msgs.
4732. Modified "d" output (debug) to include pin number and message logo as 
474both character strings from earthworm*.d and numeric values. If a field
475of the logo is not in the local earthworm*d files, the debug output will
476show one or more of these strings: inst_unlisted, mod_unlisted, type_unlisted. 
477If the channel's installation id is different from the local installation id
478(set by the EW_INSTALLATION environment variable), the module_id string will
479read: mod_not_local.
4803. Modified "w" output (wave_serverV) to include the actual installation
481and module id strings from earthworm*d files.  If the installation is not
482in the earthworm_global.d file, it will be listed as INST_WILDCARD.  If the
483moduleid is not in the earthworm.d file, it will be listed as MOD_WILDCARD.
484If the channel's installation id is different from the local installation id
485(set by the EW_INSTALLATION environment variable), the module will be listed
486as MOD_WILDCARD.
4874. Modified all output to be space-delimited rather than tab-delimited.
488LDD 7/29/2004
489
490findwave:
491  Merged Hydra changes into findwave.  The default findwave behavior is unchanged.
492  Hydra changes include:
493     Option:  have tanks segmented by HD based on a HardDrive size
494     Option:  have findwave truncate tanksizes to 1GB, to comply with
495              wave_serverV maximum safe tank size.
496     Option:  have findwave massage the record sizes to be a fixed size
497              for all tanks.
498     Option:  have findwave massage the record sizes for variable-record-length
499              channels to be slightly larger than the largest record received for that channel.
500   Run findwave with no arguments for more information.
501
502gaplist:
503Added a "Total Gap" column to the output tables.  "Total Gap" is the
504total, in seconds, of the length of all gaps for a particular channel.
505"Total Gap" gets reset to 0 when the day rolls over.  Also, added a
506column named "Dead Time", which is the elapsed time since a channel
507died.  If "Dead Time" is blank, the channel is currently alive.
508"Dead Time" does NOT reset to 0 when the day rolls over. WMK 1/8/04
509
510gaplist: Slight table reformat.  WMK 1/20/04
511
512gaplist: Now accepts TYPE_TRACEBUF and/or TYPE_TRACEBUF2 messages.
513The config file (gaplist.d) now contains a list of SCNLs to monitor,
514rather than SCNs.  WMK 4/30/04
515
516gaplist: Added system-clock timestamp to logging of gaps/overlaps.
517Made slight formatting changes in logging.  LDD 5/7/2004
518
519gaplist: Now, the scnl array is allocated using realloc, so any number
520of Scnl and Label lines are permitted in the config file.
521Fixed two bugs:
522Label strings longer than 31 characters weren't null-terminated in the
523program.  Now, they are, so long labels are correctly truncated.
524Also, the label array, defined in gaplist.h, had a length of 31
525characters, which caused some values in the scnl array to get clobbered.
526This resulted in continuous dead/alive messages being sent to statmgr.
527WMK 5/11/04
528 
529gaplist: Added new optional command: GetLogo <instid> <modid> <msgtype>
530If no GetLogo cmds are given, gaplist will process all TYPE_TRACEBUF
531and TYPE_TRACEBUF2 messages (previous default behavior).
532Modified to allow processing of TYPE_TRACE_COMP_UA and TYPE_TRACE2_COMP_UA
533messages (headers are NOT compressed!). LDD 4/11/2005
534
535evtK2ora:
536Fixed endTime bug in makeEwSnippet(). Thanks Jim L.
537Alex 5/9/03
538
539shakemapfeed:
540The last two arguments to ewdb_api_GetSMDataWithChannelInfo were
541reversed. That meant that the number of returned SM messages would be
542incorrect IF that number exceeded MaxDataPerEvent. The result would be an
543out-of-bounds memory access and corrupted SM data. PNL 6/9/03
544
545shakemapfeed:
546Changed the sorting used in Filter_SM_data. Now SM messages are sorted by SCNL
547instead of by idchan. That means that the output XML will have components of
548one station listed consecutively, a big help for shakemap. PNL 10/30/03
549
550shakemapfeed:
551Changed the length of the long station name in the mapping file from
55220 to 50 characters.  LDD 2/5/04
553
554skakemapfeed:  (EWDB API - Strong Motion) ewdb_internal_GetAllSMMessages()
555(Note: This function is called by ewdb_api_GetSMDataWithChannelInfo())
556Fixed a bug in PostGetAllSMMessages().  The idEvent field may be null
557for some records, and Oracle  does not appear to be writing a 0 value to
558the memory area for the null field, so that record assumes the
559idEvent of the previous record located at that point
560in the internal buffer.  The result is data corruption, such that you get
561messages that are unassociated with an Event, but they appear to be associated
562with an event.
563DK 02/12/04
564
565shakemapfeed: Added new optional command, SMQueryMethod, to control how SM data
566is requested from the DBMS. Default behavior is original 2-stage query (get
567all SM data associated with this eventid, then get all UNassociated SM data
568in a space/time box). If SMQueryMethod is non-zero, shakemapfeed will request
569all SM data in a space/time box. This will return SM data associated with this
570event, SM data associated with other events, and UNassociated SM data.
571Regardless of query method, post-query filtering will be performed on eventid,
572external eventid, and external author.  SM data associated with a different
573eventid but with the same author will be rejected.  Data with a different
574author will be allowed - this is most likely data imported from another
575network and its eventids are meaningless in our DBMS.  LDD 02/13/2004
576
577shakemapfeed: Changed the auto-feed scheduling logic to allow for variable
578time intervals between feeds to shakemap.  Feeds are scheduled at
579fixed times after the arrival of the archive message by using the new
580command, ScheduleFeed (one time per ScheduleFeed command, up to 20 allowed).
581Auto-feeds will continue at the last ScheduleFeed interval until UpdateDuration
582minutes after the event origin time.  ScheduleFeed replaces the original
583DelayFirstFeed and UpdateInterval commands. These original commands are still
584accepted and will set up the auto-feed schedule in the original manner in the
585absence of ScheduleFeed commands.  LDD 3/4/2004
586
587k2ew:
588The channel bitmap bug reported below has been fixed. K2ew now reads the
589correct bitmap to determine which channels are streaming. PNL 6/9/03
590
591k2ew:
592Version 2.38: K2ew will now, optionally, obtain network code from the K2
593headers, rather than from the configuration file.  For this to work, network
594codes need to be entered into the K2 using Altus File Assistant. A different
595network code may be entered for each stream.  The K2 must be running
596application firmware version 3.02 or later.  The "Network" parameter, in the
597config file, is now optional.  WMK 3/25/05
598
599liss2ew, ew2liss, dumpseed:
600There was a bug on Microsoft based systems that caused the user defined
601types BYTE, WORD, and LONG to be ignored.  This was a problem specifically
602with the type WORD, which was changed from a signed 16-bit value to an
603unsigned 16-bit value, causing many problems, most noteably with the
604signed seed varibles for sample rate and sample rate multiplier.  All
605liss based modules have had this problem corrected. JMP 06/17/2003
606
607getfile_ew:
608There was a feature in getfile_ew that could cause more cpu to be
609used than necessary by checking time since last heartbeat more
610often than necessary.  Added sleep_ew(1000) within heartbeat
611loop. MMW 06/29/2003
612
613getfileII:
614Ported getfileII to FreeBSD.  Two new files are in the source directory:
615makefile.bsd and socket_bsd.c.  No other changes to files. WMK 11/25/03
616
617getfileII:
618Added more string-length checking to config.c and to the incoming file
619names and output paths to avoid overflowing character arrays. Changed
620version number to 1.1.  LDD 7/28/2004
621
622sudsputaway:
623Added functions to properly initialize SUDS structures to
624Banfill's default values. CJB 10/3/2003
625
626sudshead.h:
627Updated to make more compatible with suds.h in current
628release of PCSUDS. CJB 10/3/2003
629
630file2ew:
631Fixed bug in raw2ew.c which caused file2ew to exit when the
632SuffixType command contained only 2 arguments.  The third
633argument (installation ID) was supposed to be optional, and
634now is!  LDD 10/3/2003
635
636ew2file:
637Fixed bug in timing of heartbeat file generation.
638Had been using HeartBeatInt instead of HeartFileInt to control
639the production loop.  Caused continuous heartbeat file generation
640when HeartFileInt==0.  LDD 11/24/2003
641
642sniffwave:
643Changed to sniff headers of both TYPE_TRACEBUF and TYPE_TRACE_COMP_UA msgs.
644Will only print data values for TYPE_TRACEBUF messages.  Changed to accept
645the any of these strings as wildcards in SCN: "wild", "WILD", "*".
646LDD 10/31/2003
647
648Modified to list both the Quality value and (if TRACE2_HEADER the Version
649value) in the header output.
650DK 2005/03/27
651
652sniffwave:
653Modified to sniff headers of TYPE_TRACEBUF2 and TYPE_TRACE2_COMP_UA msgs.
654Added new command-line argument <location> to support these new message
655types. LDD 4/13/2004
656
657vX.X/src/data_exchange/Makefile:
658Added directives for STANDALONE_MODULES (right now getfileII and sendfileII)
659so that their executables, which are created in their source directories,
660are also copied to the vX.X/bin directory.  LDD 11/27/2003
661
662sendfileII:
663Ported to BSD Unix.  Added a new makefile, named makefile.bsd.
664To compile, type "make -f makefile.bsd".  Otherwise, everything is the
665same as on Solaris.  WMK 2/17/04.
666
667sendfileII:
668Added optional config command "-SendPause xxx" where xxx is a time in
669milliseconds (default = 0). sendfileII will sleep SendPause millseconds
670before trying to open a file for shipping.  This gives file writers of
671unknown behavior some time to finish writing and to close the file before
672sendfileII wisks it away. Windows fopen_excl() was supposed to keep us
673from opening a file that another process was using, but I don't think
674it's working the way we expected. Besides, Solaris never had the
675fopen_excl() option, so SendPause helps us there.  LDD 3/23/2006
676
677EWDB - Station Information:
678Modified the two stored procedures that handle the processing of SCNL
679from station list tools (stalist_XXX2ora) and automatic data (trace feed,
680automatic pick feed, strong motion, etc.).
681Modified the procedures to properly process the Location Code of the
682SCNL.  Prior to this, Location codes weren't properly being handled.
683Because this change is to SQL procedures and not C code, you must
684refresh the DB stored procedures by updating with the SQL scripts from
685"working".  (run ewdb_load_external_utils.sql from schema/sql_scripts).
686DK 02/17/04
687
688naqs2ew:
689  Modified to produce TYPE_TRACEBUF2 messages to support location codes.
690Can optionally be configured to produce the original TYPE_TRACEBUF msg.
691New config file commands: OutputMsgType (optional) and RequestChanSCNL.
692See sample configuration file for details. LDD 4/14/2004
693  Modified to output all packets (regardless of time-order) to Earthworm
694when RequestChanSCNL "delay" is -1.  This will allow out-of-chronological
695order data and possibly duplicate data into the EW system. For delay>=0,
696out-of-order packets will be ignored (previous behavior). LDD 11/22/2005
697  Added new command "RepackageNmx" (optional) to control how Nmx packets
698are repackaged into Earthworm messages.  If set to 1, naqs2ew will create
699one EW msg from each Nmx packet. If the Nmx packet contains more than
700MaxSamplePerMsg samples, multiple EW msgs will be created. The entire Nmx
701packet will be converted immediately.  If set to 2 (the default), naqs2ew
702will repackage Nmx packets into 1-second EW msgs.  If an Nmx packet
703contains more or less than 1-second of data, some samples will be buffered
704until the receipt of the next Nmx packet for that channel.  Some shorter
705EW messages will be generated if time tears are present.  LDD 11/23/2005
706  Fixed bug in how compression bits of raw Nmx compressed data packets
707are interpreted in unpack_tsdata_bundle() of nmxp_packet.c. Now, if both
708compression bits are 0, it is interpreted as "this data set contains no data"
709and the 4-byte data set is ignored. Previously, if both compression bits
710were 0, it was (mis)intrepreted to mean that compression was not used and
711that the data set contained a single non-differenced data value. This bug
712would have added extra bogus samples to the output, but probably only when
713a data packet was partially full. Since I can't think of a reason why a
714datalogger would not fill each data packet fully, I'm guessing that this
715bug was very rarely, if ever, encountered. LDD 1/4/2006
716
717
718reftek2ew:
719Modified to produce TYPE_TRACEBUF2 messages to support location codes.
720Config command "SCNFile" was replaced by the "SCNLFile" command.
721Location code was added to the SCNLFile (which maps between
722DAS#,stream,channel and SCNL,pin) as the 7th of 8 fields on each line.
723Added a new config file command "SendUnknownChan" to control whether
724channels not listed in the SCNLFile are written as TYPE_TRACEBUF2 msgs.
725If SendUnknownChan is non-zero, reftek2ew makes up the SCNL as follows:
726Station is the DAS serial number, component is "Cxx" where xx is the
727channel number from the DAS, network is "Sy" where y is the stream number
728from the DAS, and location code is "--" (the NULL location).
729If SendUnknownChan is zero, data from channels not listed in SCNLFile
730is ignored.  LDD 5/25/2004
731
732compress_UA:
733Modified to produce TYPE_TRACE2_COMP_UA messages when handling
734TYPE_TRACEBUF2 messages as input. Compress_UA can still take TYPE_TRACEBUF
735packets as input and will produce TYPE_TRACE_COMP_UA messages as output.
736Eliminated "GetWavesFrom" command and replaced it with two new commands:
737"GetLogo" to supply the logos to process and "CompressSCNL" to supply
738the list of channels to process.  If handling TYPE_TRACEBUF messages,
739the location code in the CompressSCNL command is ignored, but it still
740must be provided.  LDD 4/16/2004
741
742decompress_UA:
743Modified to work on both TYPE_TRACE2_COMP_UA and TYPE_TRACE_COMP_UA msgs.
744Produces TYPE_TRACEBUF2 messages if input is TYPE_TRACE2_COMP_UA.
745Produces TYPE_TRACEBUF messages is input is TYPE_TRACE_COMP_UA.
746Eliminated "GetWavesFrom" command and replaced it with "GetLogo" command.
747LDD 4/16/2004
748
749decimate:
750Modified to work on either TYPE_TRACEBUF and/or TYPE_TRACEBUF2 messages
751to support the addition of location codes to network processing.
752Output message will be of same type as input message.  Changed the
753GetWavesFrom command to require a third argument specifying the input
754message type (must be either TYPE_TRACEBUF or TYPE_TRACEBUF2). If the
755input message type is TYPE_TRACEBUF, location codes are ignored. Replaced
756the GetSCN command with GetSCNL to support the addition of location codes. 
757If the GetSCN command is used, the input and output location codes are
758set to "--".  LDD 5/11/2004
759
760sniffring:
761Modified so it does not attempt to print the contents of two new binary
762message types: TYPE_TRACEBUF2 and TYPE_TRACE2_COMP_UA.  LDD 4/16/2004
763
764export_actv, export_scn_actv:
765Moved source code from data_exchange/export_actv into data_exchange/export
766to avoid duplication of the supporting export filtering code.  The versions
767of the filters in export_actv had not had bug fixes in quite a while and
768were not location-code compliant.  LDD 4/20/2004
769
770export_scn, export_scn_pri, export_scn_actv:
771Modified the scnfilter code to include location code as well.  Replaced
772Send_scn and Send_scn_remap config commands with Send_scnl and Send_scnl_remap.
773If old commands are used, the location code will be set to * (wildcard).
774Modified to work with all the new location-code friendly Earthworm messages:
775TYPE_TRACEBUF2, TYPE_TRACE2_COMP_UA, TYPE_PICK_SCNL and TYPE_CODA_SCNL.
776Still works with old format messages.  LDD 4/21/2004
777
778export_generic,export_scn
779Added logging under "Verbose" mode concerning the queue status of each
780message to be exported. This will generate VERY LARGE log files, but
781could be useful in debugging.  LDD 3/23/2005
782
783write_cta:
784Program now reads TYPE_TRACEBUF and TYPE_TRACEBUF2 messages from the
785transport ring.  All TYPE_TRACEBUF messages are converted to TYPE_TRACEBUF2,
786before writing to tape.  Tape files now begin with "wu" (instead of "wt"),
787to indicate that they contain TYPE_TRACEBUF2 messages.  WMK 5/11/04
788
789read_cta:
790Program now reads tape files whose names begin with "wt" and "wu".
791"wu" files contain TYPE_TRACEBUF2 messages.  WMK 5/11/04
792
793cta2cusp:
794Cosmetic changes.  Program will process cta files beginning with wt or wu.
795Only old version triglist messages, without location code, will work.
796If there are multiple channels with the same SCN, they will be interleaved
797in the file sent to CUSP.  This is bad.  WMK 5/12/04
798
799tankplayer:
800Added support for TypeTraceBuf2, which was missing from the get_time function
801that is used to determine the time of the packet from the trace header.
802Changed the program's behavior when Tracebuf2 packets are encountered with
803VERSION fields that don't match those compiled into the program.  Previously
804the program always quit at the first sign of a tracebuf with a mismatched version
805number.  Now depending on the value of the IgnoreTBVersionNumbers config command,
806the program attempts to parse and either play or skip the message based on
807the value of the command.  (TRUE = play, FALSE= ignore).
808Added a log message when tankplayer comes across a large delay between packets.
809Modified the sleep code that executes between packets, so that it sleeps
810in small intervals and continues to issue heartbeats even during a large gap.
811Added additional debugging info for dealing with problems encountered in tracebuf files.
812DK 2006/03/09
813
814tankplayer:
815odified to read TYPE_TRACEBUF2 files in addition to the original file
816types (TYPE_TRACEBUF and TYPE_ADBUF).  LDD 5/21/2004
817
818remux_tbuf:
819Added WaveMsg2MakeLocal() call to report and filter out tracebufs
820with headers that don't checksum.
821Replaced fprintf(stdout) commands with logit().
822Added a progress indicator that prints a ".' to the screen each time
823100 tracebufs have been processed.
824DK 2006/03/09
825
826time_ew.c (timegm_ew())
827Fixed bugs in timegm_ew() that appeared on machines not set to UTC timezone.
828DK 07/12/2004
829
830import_generic:
831  Moved the generation of Earthworm TYPE_HEARTBEAT messages out of the
832Heartbeat thread and into the main() thread. EW heartbeats will be generated
833in both the "connect to server" loop and the main working loop. This means
834that import will keep beating its EW heart when its export server becomes
835inaccessible, avoiding unnecessary restarts by statmgr/startstop. The
836former Heartbeat thread was renamed the SocketHeartbeat thread because
837its sole job is to write heartbeats (alive strings) to the socket. Also
838changed names of variables related to the socket heartbeat thread to
839avoid confusion.  LDD 3/15/2005
840  Restructured the "connect to server" loop to be easier to follow and
841reworded the messages logged during connection attempts. LDD 3/17/2005
842
843import_gen_pasv:
844Incorporated Richard Godbee's bug fixes in the accept_ew loop (fixed
845mis-placed end-while bracket, uninitialized variables) and increased
846the length of the RingName and MyModName variables. Reformatted the
847entire file with proper, readable indenting, changed accept_ew timeout
848to HeartBeatInt (had been hard-coded to 9 seconds), added inter-connection
849time interval to logging, generally cleaned up comments. LDD 4/13/2006
850
851Most Modules:
852  Linux Makefiles (makefile.ux) have been added to a number of modules and
853in some cases _LINUX compile directives have been added into the code. The
854list of codes to which this has been done will be provided as a separate
855note. 8/11/2005 Paul Friberg
856
857startstop_nt:
858Added in restart command to Interactive() function. This nice modification
859was provided by Murray McGowan. Tested and added by Paul Friberg 9/7/2005
860
861startstop_unix/startstop_solaris:
862Added in the same restart command as above. It's a nice feature to have. (9/7/2005)
863
864
865CHANGES TO CONFIGURATION FILES and DESCRIPTOR FILES:
866****************************************************
867
868earthworm.d: Added this earthworm type to allow sending a reconfigure
869command through rings.
870Message  TYPE_RECONFIG       112
871
872
873shakemapfeed.d: Added new optional command, SMQueryMethod, to control how SM
874data is requested from the DBMS. Default behavior (SMQueryMethod 0) is original
8752-stage query (get all SM data associated with this eventid, then get all
876UNassociated SM data in a space/time box). If SMQueryMethod is non-zero,
877shakemapfeed will request all SM data in a space/time box. This will return
878SM data associated with this event, SM data associated with other events,
879and UNassociated SM data.
880  Regardless of query method, post-query filtering will be performed on eventid,
881external eventid, and external author.  SM data associated with a different
882eventid but with the same author will be rejected.  Data with a different
883author will be allowed - this is most likely data imported from another
884network and its eventids are meaningless in our DBMS.  LDD 02/13/2004
885
886shakemapfeed.d: New command "ScheduleFeed <minutes(float) after receiving event>"
887sets the shakemap feeding schedule. Up to 20 ScheduleFeed commands are
888allowed, setting one time per command.  Auto-feeds will continue at the
889last ScheduleFeed interval until UpdateDuration minutes after the event
890origin time. ScheduleFeed replaces the original DelayFirstFeed and UpdateInterval
891commands. These original commands are still accepted and will set up
892the auto-feed schedule in the original manner in the absence of ScheduleFeed
893commands.  LDD 3/4/2004
894
895naqs2ew.d: Two new commands to support location code addition:
896"OutputMsgType <TYPE_TRACEBUF or TYPE_TRACEBUF2>" to choose output format.
897   If the OutputMsgType command is omitted, naqs2ew will produce
898   TYPE_TRACEBUF2 messages by default.
899"RequestChanSCNL" replaces the "RequestChannel" command. It has all the
900   same arguments with the addition of the <location code> argument.
901   LDD 4/14/2004
902
903binder_ew.d:
904Two new optional commands:
905"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
906"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
907If a command is omitted, the corresponding fifo will be set to the previous
908hardcoded length.  LDD 2/9/2005
909
910eqproc.d
911Four new optional commands. If any of these commands is omitted, the
912corresponding parameter will be set to its previous hardcoded value.
913"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
914"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
915For proper event reporting, eqproc's pick/quake FIFO lengths must be
916greater than or equal to binder's pick/quake FIFO lengths!
917"HeartbeatInt <hbsec>" sets the interval (seconds) between TYPE_HEARTBEAT
918messages (default=0.3*tReport).
919"rpt_check" <chksec>" sets the interval (seconds) at which the quake FIFO
920will be inspected to see if it's time to send an event to downstream
921modules (default=0.3*tReport).
922The parameter tReport is set with the 'rpt_dwell' command (default=30s).
923LDD 3/11/2005
924
925eqprelim.d
926Added two optional commands. If either of these commands is omitted, the
927corresponding parameter will be set to its previous hardcoded value.
928"pick_fifo_length <npick>" set the length of the pick FIFO (default=1000)
929"quake_fifo_length <nquake>" sets the length of the quake FIFO (default=100).
930For proper event reporting, eqprelim's pick/quake FIFO lengths must be
931greater than or equal to binder's pick/quake FIFO lengths!
932LDD 3/11/2005
933
934compress_UA.d:
935Eliminated "GetWavesFrom" command and replaced it with two new commands:
936"GetLogo <Inst_id> <Mod_id> <msg_type>"
937 Inst_id and/or Mod_id fields can be wildcards, but msg_type field must
938 be either TYPE_TRACEBUF or TYPE_TRACEBUF2. Multiple GetLogo commands may
939 be supplied (no limit on number).
940"CompressSCNL <sta> <comp> <net> <loc>"
941 The wildcard character '*' (without quotes) can be used in any of
942 the fields.  Use as many CompressSCNL commands as needed to define the
943 list of channels to be processed.  If input is TYPE_TRACEBUF, the <loc>
944 field will be ignored, but it must still be provided.
945 LDD 4/16/2004
946
947decompress_UA.d:
948Eliminated "GetWavesFrom" command and replaced it with new command:
949"GetLogo <Inst_id> <Mod_id> <msg_type>"
950 Inst_id and/or Mod_id fields can be wildcards, but msg_type field must
951 be either TYPE_TRACE_COMP_UA or TYPE_TRACE2_COMP_UA. Multiple GetLogo
952 commands may be supplied (no limit on number).
953LDD 4/16/2004
954
955decimate.d:
956GetWavesFrom: added a third requires argument specifying the input
957message type.  Only valid messages types are TYPE_TRACEBUF and TYPE_TRACEBUF2.
958Replaced the GetSCN command with GetSCNL to support the addition of location
959codes.  GetSCNL requires 8 arguments, input SCNL and output SCNL. No wildcards
960are permitted.  LDD 5/11/2004
961
962export_scn*.d:
963Added two new commands, Send_scnl and Send_scnl_remap, to implement location
964code filtering.  If old commands (Send_scn and Send_scn_remap) are used,
965the location code is set to * (wildcard). LDD 4/21/2004
966
967wave_serverV:
968Modified behavior so that wave_server does not Abort On A Single Tank Failure,
969unless the AbortOnSingleTankFailure flag is set in config file. 
970(This was the documented behavior).
971
972wave_serverV:
973Wave server now limits tank sizes to 1GB.  This applies only to NEW tanks, not
974existing tankfiles.
975The default behavior is for wave server to EXIT if it comes across a tank in the
976config file that is >= 1GB.
977If the "TruncateTanksTo1GBAndContinue" command is set in the config file, then
978wave server will trunctate any >= 1GB tank files to just under 1GB, and continue
979normal operation.
980This was done to prevent users from creating unsafe large tanks, after a bug was
981discovered that limits the safe wave server tank size to ~1GB.
982DK 2005/03/17
983
984Added code to check the return value from call to WaveMsg2MakeLocal(),
985and reject packets for which WaveMsg2MakeLocal() reported and error.
986Updated the wave_serverV version and timestamp.  This will cause
987wave_serverV to filter out packets with header issues that weren't previously
988filtered out before.
989Fixed a bug where wave_serverV would filter out packets that contained only
990one sample.
991DK 2006/03/27
992
993wave_serverV / wave_viewer / ws_clientII.c:
994Modified wave_server protocol slightly to better differentiate between SCN vs. SCNL
995clients and servers.  New wave_server clients should be backwards compatible with
996previous SCNL wave_servers, but the new wave_serverV is not backwards compatible
997with any clients.
998The new wave_viewer works with ALL wave_servers (SCN, old SCNL, new SCNL), and
999the new ws_clientII library works with ALL SCNL wave_servers.
1000DK 2005/04/22
1001
1002
1003wave_serverV / wave_viewer / ws_clientII.c:
1004Fixed bug in wave_server (server_thread.c ParseMsg()) that was incorrectly reading
1005the Ascii FILL value from the "endtime" field instead of the "fill" field.
1006This fix only affects ascii wave_server clients on gappy channels.
1007Fixed more bugs in the ASCII protocol logic between ws_clientII and wave_serverV.
1008DK 2005/09/07
1009
1010ringtocoax:
1011Changed tport_getmsg to tport_copyfrom so that it can distinguish missed messages
1012(overlapped in ring) from sequence gaps in the ring. This can be useful for
1013fine-tuning the BurstCount and BurstInterval configuration settings.
1014LDD 2005/4/8
1015
1016localmag:
1017Does not compile under latest release of earthworm (needs to be SCNL'ized). It
1018will compile with earlier versions however and 3 new options have been
1019added in: useMedian, minStationsMl, require2Horizontals
1020which are all explained in the localmag/Doc/localmag_cmd.html file.
1021The program now has a version number to distinguish different released versions.
1022Upgraded as per requests from Univ of Utah and HVO on 8/10/2005 by Paul Friberg (PAF)
1023I upgraded localmag to use SCNL now and tested it at Utah 3/01/2006 PAF
1024
1025
1026
1027KNOWN BUGS:
1028***********
1029
1030liss2ew:
1031liss2ew has been observed intermittantly producing malformed
1032TRACE_BUF messages.  Currently the conditions for causing this problem
1033are unknown.  Due to this, liss2ew should be treated as suspect.  Use at
1034your own risk.  JMP 6-18-2003
1035
1036k2ew:
1037k2ew uses the k2hdr.rwParms.misc.channel_bitmap parameter to decide
1038which channels it will see as streams from the K2.  This is actually the
1039parameter which the K2 uses to decide which channels to record in an event
1040file (see K2's <bitmap> command).  The K2's <sdstreams bitmap> is the parameter
1041that shows which channels the K2 is streaming out.  This is the parameter
1042that k2ew should be using to decide what data it will see.  The big problem
1043is that none of the header files from Kinemetrics (nkwhdrs.h) seem to
1044show this parameter anywhere. This issue is only a problem for those folks
1045who want to record more channels on the K2 than they want to stream continuously.
1046Terry Dye (Univ of Utah) discovered this problem when trying to stream only
10473 channels of a 12 channel K2.  LDD 4/11/2002    FIXED PNL, 6/9/03
1048
1049
1050wave_serverV:
1051it occasionally sends the following error to statmgr:
1052   UTC_Thu Sep 06 03:30:14 2001  WSV1/wave_serverV_nano ReadBlockData
1053   failed for tank [z:\nano57.tnk], with offset[999908] and record
1054   size[64]! errno[0] Mail sent.
1055The nominal tank size is 1 megabyte, and the actual tank size is 999908.
1056It looks like waveserver is trying to read off the end of the tank.
1057WMK 9/6/01
1058
1059wave_serverV:
1060appears not to reply to requests for a single sample of data. I noticed
1061when testing wave_viewer, that if the start time and end time of a request were
1062equal (in which case there should be one sample of data) then wave_serverV did
1063not reply to the request (ASCII request) at all. No Data, No Flags, No Reply,
1064No Nothing.  It needs to issue a reply to every request.
1065DavidK 09/25/01
1066
1067wave_serverV:
1068Wave server appears to be limited (on 32-bit systems) to 1GB tank sizes.
1069A bug (a signed integer overflow of tmpoE at Line 1155 of
1070       serve_trace.c  (LocateRoughOffset()))
1071prevents data retrieval from the tank under certain conditions when the
1072tank size exceeds 1 GB.
1073DavidK & PNL 09/27/04
1074
1075Automatic restarts of adsend (using the "restartMe" line in the descriptor
1076file) can cause an NT system to hang. Therefore, you should never
1077use the autorestart feature with adsend, but you should bring down
1078the entire Earthworm system if adsend needs to be restarted.
1079LDD 5/31/2000 Comments added to adsend.desc, but leave this warning here!
1080
1081libsrc/utils/site.c: The strings used for station, channel and network are
1082required to be fixed length with trailing spaces added to short names. If
1083the strings given to site_index do not have these trailing blanks, SCN names
1084will not match. This is not documented anywhere.  PNL 10/15/00
1085
1086socket_ew: (libsrc/util/socket_ew_common.c libsrc/solaris/socket_ew.c
1087            libsrc/winnt/socket_ew.c include/socket_ew.h)
1088Fixed a bug in the connect_ew function().
1089When run in non-blocking mode (clients connecting to
1090a server - using a timeout value), there was a bug in
1091the connection code(discovered on Solaris) that caused
1092the function to return a timeout-error when there was
1093any kind of error during connection.
1094The bug was discovered when connecting to a non-existent socket.
1095When trying to connect to a non-existent wave_server on a machine,
1096the underlying socket library was returning a Connection-Refused error,
1097but the socket_ew library was passing back a timeout error.
1098-
1099The change only applies when a socket-error occurs while the function is
1100waiting for the connect to happen.  The instance where you will most-likely
1101see a difference, is when you try connecting to a non-existent socket.
1102Previously the function would return TIMEOUT, now it will return
1103connection REFUSED.
1104-
1105Added a new function: socketSetError_ew(),
1106and defined a new socket_ew return code: CONNREFUSED_EW.
1107DK 2003/02/04
1108
1109sm_ew2ora:
1110There is a bug in sm_ew2ora that involves having multipe time intervals for
1111components and channels.  If a strong motion message containing information
1112for a channel that the DB has never seen before is loaded into the DB, and
1113then later another message for the same channel with an earlier timestamp
1114is loaded, the load of the second message will fail, due to problems with
1115overlapping time intervals, and the call that sm_ew2ora uses to create
1116those time intervals.  This problem only affects stations that were
1117not previously loaded via one of the station loader programs stalist*2ora,
1118and only when receiving SM data that is timestamped with a time that is
1119prior to the original time for that channel.  The bug lies in the logic
1120of ewdb_api_PutSMMessage(), and not in the underlying code.
1121Davidk 05/25/01
1122
1123A change was made to ewdb_api_PutSMMessage() that dramatically affects
1124sm_ew2ora.  Please see the note about that function.  Davidk 2001/07/26
1125
1126ewdb_api_CreateWaveform()  (ewdb_internal_CreateSnippet.c
1127                            ewdb_internal_CreateWaveformDesc.c)
1128Added a call to release the cursors used by the internal functions, when they
1129fail.  Fixes a bug which resulted in a DB cursor leak when a call to stuff
1130a snippet into the DB failed.
1131DK 2003/02/04
1132
1133logit.c:
11341) Added a new function logit_core()
1135int logit_core( char *flag, char *format, va_list ap);
1136This function is the same as logit(), except that it takes a va_list argument
1137for the variable length parameter instead of '...', and it has an int
1138return value.
1139This function can be called by other functions that receive a '...' variable
1140argument list, where as logit() cannot.  logit_core() is to logit()
1141what vsprintf() is to sprintf().
1142-
11432) Moved all of the functionality in logit() to logit_core(), and modify
1144logit to call logit_core().
1145-
11463)  Added a new function get_prog_name2(), as an intended replacement
1147of get_prog_name().  get_prog_name2() includes an additional
1148parameter (the buffer length of the output buffer).
1149-
11504)  Modified logit_init() to use get_prog_name2() instead of get_prog_name()
1151-
1152All four(4) of these changes should be backwards compatible with all existing
1153earthworm code, and the modified logit.c has already been tested with several
1154earthworm modules.
1155-
1156
1157
1158ewdb_api:
1159Added new function ewdb_api_GetEventSummaryInfo() to retrieve summary
1160information for an event(including the preferred szSource and szSourceEventID
1161of the event).   011904 DK
1162
1163
1164
1165KNOWS DEFICIENCIES:
1166*******************
1167
1168ringtocoax:
1169In Windows NT, the time resolution of sleep_ew() is about 16 msec (one clock
1170tick).  On Solaris, the resolution is about 10 msec.  This is a problem for
1171ringtocoax, since packet delays need to be set to a few milliseconds.
1172
1173statmgr: A space is needed between "tsec:" and the value.
1174If it isn't there, things fail. Artifcat of the kom routines. (Alex)
1175
1176threads functions: The KillThread function on WindowsNT and Solaris
1177terminate the thread without ensuring that no mutexes are held. If a thread
1178holds a mutex when it dies, no other thread can get that mutex. PNL 1/12/2000
1179
1180carlsubtrig:
1181The system time must be set to GMT and ew_nt.cmd must have
1182TZ=GMT for carlsubtrig to work.  Comments in ew_nt.cmd done 5/25/00. Barbara
1183       
1184localmag:
1185needs GMT set on the system
1186
1187ew2seisvole:
1188on NT, exits with horrible crash when system is stopped.
1189
1190NUMBER OF RINGS LIMITED ON SOLARIS:
1191Under Solaris 2.6 (and probably other versions as well), the maximum number
1192of shared memory segments is six. This means that on an out-of-the-box machine
1193you can only configure six rings. If you try to configure more than that, you
1194will see a cryptic message from tport_create about too many open files.  The
1195fix to this problem is to add the following lines to the /etc/system
1196file, and then reboot the system.
1197
1198 set shmsys:shminfo_shmmax = 4294967295
1199 set shmsys:shminfo_shmmin = 1
1200 set shmsys:shminfo_shmmni = 100
1201 set shmsys:shminfo_shmseg = 20
1202 set semsys:seminfo_semmns = 200
1203 set semsys:seminfo_semmni = 70
1204
1205This allows for 20 rings.
1206
1207     Lucky Vidmar (7/6/2000)
1208
1209startstop_solaris:
1210Fixed bug in call to logit_init().
1211The program was printing error messages:
1212  Invalid arguments passed in.
1213  Call to get_prog_name failed.
1214  WARNING: Call logit_init before logit.
1215
1216startstop_solaris:
1217There MAY be a problem with the signal that
1218startstop sends to modules during the shutdown sequence. The shutdown
1219sequence is started (after typing "quit" to startstop or running "pau")
1220by startstop placing a terminate message on all transport rings. Modules
1221should see this message and start their own shutdown. After a configurable
1222delay, startstop checks to see that all modules have exitted. Any that are
1223still running are sent a signal to terminate them. Currently that signal
1224is SIG_TERM. But since wave_serverV has a handler for SIG_TERM, wave_serverV
1225sees that as essentially the same as a terminate message. So if wave_serverV
1226is having problems completing its shutdown, SIG_TERM won't do anything. The
1227result is that startstop may give up and exit, leaving wave_serverV running.
1228If that happens, the operator will have to terminate wave_serverV by doing
1229"kill -9 <wave_serverV-pid>". That may leave shared memory and semaphores
1230stranded in the kernel: run the command "ipcs -a" to see. If necessary,
1231the stranded shared memory and semaphores may be cleaned up with the
1232ipcrc command; must be run as root; see the man page.
1233This problem only exists on Solaris/Unix, not on WindowsNT.
1234PNL, 10/4/2000
1235
1236libsrc/utils/kom.c:  fix comment in k_open()
1237
1238The comment above k_open() says that only one file can
1239be open at a time. Yet the Kbuf array has slots for MAXBUF (currently 4) open
1240files. Does this work, or is the comment to be taken at it's word?
1241PNL 10/15/00
1242
1243libsrc/utils/logit.c: logit_init() requires a module_id number, which it uses
1244to construct the log file name. This is not helpful, since the module_id
1245number is not meaningful to people. Worse, it requires that the config file be
1246read and earthworm.d lookups be completed before logit calls can be made. Thus
1247errors in the config file can only be reported to stderr or stdout instead of
1248being saved in a file.  PNL 11/29/00
1249
1250libsrc/util/k2evt2ew.c: This library supports a maximum EVT data size
1251of 800000 samples per channel per EVT file.  This value is hardcoded
1252as MAXTRACELTH in include/k2evt2ew.h.  k2evt2ew() will return a warning
1253if the EVT file exceeds this size, and process as much as the EVT file
1254as the hardcoded limit allows.
1255DK 2003/01/18
1256
1257import_ida:  Modified to build under WIN32(#ifdef'd a couple of includes
1258and modified the NT makefiles.)  (saved under tag HYDRA_V1-20)
1259Modified for SCNL and Tracebuf2.
1260DK 2005/04/22
1261
1262
1263TRACEBUF messages.
1264The definition of `endtime' of the TRACEBUF message is not documented.
1265Some programmers are taking it as the "expected start time of the next
1266TRACEBUF packet (if the sample interval is uniform.)" The more accepted
1267practice is that `endtime' is the time of the last sample of the current
1268TRACEBUF packet; that is, one sample interval less than the expected
1269start time of the next TRACEBUF messsage. Using this last definition, if a
1270TRACEBUF packet has exactly one sample, then its starttime and endtime are
1271the identical. Clearly this distinction needs to be documented. The file
1272waveform_format (in the /home/earthworm/DOC directory) gives no specifics
1273about start or end times.  PNL 1/24/01
1274
1275
1276
Note: See TracBrowser for help on using the repository browser.