forked from hercules-390/html
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathshared.html
610 lines (451 loc) · 17.8 KB
/
shared.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.0//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML><HEAD><TITLE>
Hercules: Shared Device Server
</TITLE>
<LINK REL=STYLESHEET TYPE="text/css" HREF="hercules.css">
<link rel="shortcut icon" href="images/favicon.ico" />
<link rel="icon" href="images/favicon.ico" />
</HEAD><BODY BGCOLOR="#ffffcc" TEXT="#000000" LINK="#0000A0" VLINK="#008040" ALINK="#000000">
<h1>Hercules Shared Device Server</h1>
<hr noshade>
<h2>Contents</h2>
<ul>
<li><a href="#overview"> Overview </a>
<li><a href="#commands"> Commands </a>
<li><a href="#technical"> Technical Information </a>
<li><a href="#caching"> Caching </a>
<li><a href="#compression"> Compression </a>
</ul>
<p>
<hr noshade>
<h2><a NAME="overview">Overview</a></h2>
<p>
(C) Copyright Greg Smith, 2002-2007
<p>
Shared device support allows multiple Hercules instances to share
devices. The device will be 'local' to one instance and 'remote'
to all other instances. The local instance is the 'server' for
that device and the remote instance is the 'client'. You do not
have to IPL an operating system on the device server. Any number
of Hercules instances can act as a server in a "Hercplex".
<p>
To use a device on a remote system, instead of specifying a file
name on the device config statement, you specify
<p>
<blockquote>
<code>ip_address_or_name:port:devnum</code>
</blockquote>
<p>
For example:
<pre class="jcl">
0100 3350 localhost:3990:0100
</pre>
<p>
which says there is a device server on the local host listening
on port 3990 and we want to use its 0100 device as 0100. The
default port is 3990 and the default remote device number is the
local device number. So we could say:
<pre class="jcl">
0100 3350 localhost
</pre>
<p>
instead, providing we don't actually have a file 'localhost'.
Interestingly, the instance on the local host listening on 3990
could have a statement:
<pre class="jcl">
0100 3350 192.168.200.1:<b>:0200</b>
</pre>
<p>
which means that instance in turn will use device <b>0200</b> on the
server at 192.168.200.1 listening on port 3990. The original
instance will have to 'hop' thru the second instance to get
to the real device.
<p class="box">
<b><u>NOTE</u>:</b> It is also important that the client's
configuration file device statement specifies the same <tt>'cu=xxxx'</tt>
control unit option value as is specified on the server.<br>
<br>
Not all dasd
control units support the same set of features or channel commands (CCWs).
If the two do not match then your guest and/or server will very likely
not function correctly. This is especially important on modern "MVS"
systems using 3390 dasds, which typically require <tt>'cu=3990-6'</tt>
to be specified on all of their dasd.<br>
<br>
For example: If the server has a device specified as: <tt>'0001 3390
"dasd filename..." <i><b>cu=3990-6</b></i>'</tt>, then the client must specify
the same <tt>'cu='</tt> value on its own device statement, such as:
<tt>'0123 3390 ipaddr:port:0001 <i><b>cu=3990-6</b></i>'</tt>
</p>
<p>
Device sharing can be 'split' between multiple instances.
For example, suppose instance A has:
<pre class="jcl">
SHRDPORT <b>3990</b>
0100 3350 localhost<b>:3991</b>
0101 3350 mvscat
</pre>
<p>
and instance B has:
<pre class="jcl">
SHRDPORT <b>3991</b>
0100 3350 mvsres
0101 3350 localhost
</pre>
<p>
Then each instance acts as both a client and as a server.
<p>
When 'SHRDPORT' is specified, thread 'shared_server' is started
at the end of Hercules initialization. In the example above,
neither Hercules instance can initialize their devices until the
server is started on each system. In this case, the device trying
to access a server gets the 'connecting' bit set on in the DEVBLK
and the device still needs to initialize. After the shared server
is started, a thread is attached for each device that is connecting
to complete the connection (which is the device init handler).
<p><br>
<h2><a NAME="commands">Commands</a></h2>
<p><pre class="jcl">
<b>SHRDPORT</b> [0 | <b>3990</b> | nnnn | START | STOP]
</pre>
<p>
The <code>shrdport</code> command defines the port number that the Shared
Device Server is to use to listen for remote connections on. The default
is <b>3990</b>. Setting <code>shrdport</code> to <b>0</b> stops the server
and resets the port number back to the default. Using the <code>STOP</code>
command also stops the server, but preserves the currently established
port number so that entering the <code>START</code> command will start
the server again using the same port number. Entering the command
without any argument displays the current value.
<p><pre class="jcl">
<b>SHRD</b> [TRACE[=nnnn]]
</pre>
<p>
The <code>shrd</code> command defines the desired number of trace table
entries. Specifying a non-zero value enables debug tracing of the Shared
Device Server. Specifying a value of 0 disables tracing. Entering the
command with no arguments displays the current setting. Use the command
<code>SHRD TRACE</code> to print the current trace table.
<p><br>
<h2><a NAME="technical">Technical Information</a></h2>
<p>
There are (at least) two approaches to sharing devices. One is to
execute the channel program on the server system. The server will
need to request from the client system information such as the ccw
and the data to be written, and will need to send to the client
data that has been read and status information. The second is to
execute the channel program on the client system. Here the client
system makes requests to the server system to read and write data.
<p>
The second approach is currently implemented. The first approach
arguably emulates 'more correctly'. However, an advantage of the
implemented approach is that it is easier because only the
client sends requests and only the server sends responses.
<p>
Both client and server have a DEVBLK structure for the device.
Absurdly, perhaps, in originally designing an implementation for
shared devices it was not clear what type of process should be the
server. It was a quantum leap forward to realize that it could
just be another Hercules instance.
<p>
<h3>Protocol</h3>
<p>
(If this section is as boring for you to read as it was for me
to write then please skip to the next section ;-)
<p>
The client sends an 8 byte request header and maybe some data:
<pre>
+-----+-----+-----+-----+-----+-----+-----+-----+
| cmd |flag | devnum | length | id |
+-----+-----+-----+-----+-----+-----+-----+-----+
<-------- length --------->
+----- . . . . . -----+
| data |
+----- . . . . . -----+
</pre>
<p>
'cmd' identifies the client request. The requests are:
<p>
<blockquote>
<dl>
<dt>0xe0 CONNECT<p><dd>
Connect to the server. This requires
the server to allocate resources to
support the connection. Typically issued
during device initialization or after being
disconnected after a network error or timeout.
<p>
<dt>0xe1 DISCONNECT<p><dd>
Disconnect from the server. The server
can now release the allocated resources
for the connection. Typically issued during
device close or detach.
<p>
<dt>0xe2 START<p><dd>
Start a channel program on the device.
If the device is busy or reserved by
another system then wait until the device
is available unless the NOWAIT flag bit
is set, then return a BUSY code. Once
START succeeds then the device is unavailable
until the END request.
<p>
<dt>0xe3 END<p><dd>
Channel program has ended. Any waiters
for the device can now retry.
<p>
<dt>0xe4 RESUME<p><dd>
Similar to START except a suspended
channel program has resumed.
<p>
<dt>0xe5 SUSPEND<p><dd>
Similar to END except a channel program
has suspended itself. If the channel
program is not resumed then the END
request is <i>not</i> issued.
<p>
<dt>0xe6 RESERVE<p><dd>
Makes the device unavailable to any other
system until a RELEASE request is issued.
<i>Must</i> be issued within the scope of START/END.
<p>
<dt>0xe7 RELEASE<p><dd>
Makes the device available to other systems
after the next END request.
<i>Must</i> be issued within the scope of
START/END.
<p>
<dt>0xe8 READ<p><dd>
Read from a device. A 4-byte 'record'
identifier is specified in the request
data to identify what data to read in the
device context.
<i>Must</i> be issued within the scope of START/END.
<p>
<dt>0xe9 WRITE<p><dd>
Write to a device. A 2-byte 'offset' and
a 4-byte 'record' is specified in the request
data, followed by the data to be written.
'record' identifies what data is to be written
in the device context and 'offset' and 'length'
identify what to update in 'record'.
<i>Must</i> be issued within the scope of START/END.
<p>
<dt>0xea SENSE<p><dd>
Retrieves the sense information after an i/o
error has occurred on the server side. This
is typically issued within the scope of the
channel program having the error. Client side
sense or concurrent sense will then pick up the
sense data relevant to the i/o error.
<i>Must</i> be issued within the scope of START/END.
<p>
<dt>0xeb QUERY<p><dd>
Obtain device information, typically during
device initialization.
<p>
<dt>0xec COMPRESS<p><dd>
Negotiate compression parameters. Notifies the
server what compression algorithms are supported
by the client and whether or not data sent back
and forth from the client or server should be
compressed or not. Typically issued after CONNECT.
<p>
NOTE: This action should actually be SETOPT or
some such; it was just easier to code a COMPRESS
specific SETOPT (less code).
</dl>
</blockquote>
<p><br>
'flag' qualifies the client request and varies by the request.
<blockquote>
<dl>
<dt>0x80 NOWAIT<p><dd>
For START, if the device is unavailable then
return BUSY instead of waiting for the device.
<p>
<dt>0x40 QUERY<p><dd>
Identifies the QUERY request:
<p>
<dt>0x41 DEVCHAR<p><dd>
Device characteristics data
<p>
<dt>0x42 DEVID<p><dd>
Device identifier data
<p>
<dt>0x43 DEVUSED<p><dd>
Hi used track/block (for dasdcopy)
<p>
<dt>0x48 CKDCYLS<p><dd>
Number cylinders for CKD device
<p>
<dt>0x4c FBAORIGIN<p><dd>
Origin block for FBA
<p>
<dt>0x4d FBANUMBLK<p><dd>
Number of FBA blocks
<p>
<dt>0x4e FBABLKSIZ<p><dd>
Size of an FBA block
<p>
<dt>0x3x COMP<p><dd>
For WRITE, data is compressed at offset 'x':
<p>
<dt>0x2x BZIP2<p><dd>
using bzip2
<p>
<dt>0x1x LIBZ<p><dd>
using zlib
<p>
<dt>0xxy<p><dd>
For COMPRESS, identifies the compression
algorithms supported by the client (0x2y for bzip2,
0x1y for zlib, 0x3y for both) and the zlib compression
parameter 'y' for sending otherwise uncompressed data
back and forth. If 'y' is zero (default) then no
uncompressed data is compressed between client & server.
</dl>
</blockquote>
<p><br>
'devnum' identifies the device by number on the server instance.
The device number may be different than the
device number on the client instance.
<p>
'id' identifies the client to the server. Each client has a unique
positive (non-zero) identifier. For the initial
CONNECT request 'id' is zero. After a successful
CONNECT, the server returns in the response header
the identifier to be used for all other requests
(including subsequent CONNECT requests). This is
saved in dev->rmtid.
<p>
'length' specifies the length of the data following the request header.
Currently length is non-zero for READ/WRITE requests.
<p><br>
The server sends an 8 byte response header and maybe some data:
<pre>
+-----+-----+-----+-----+-----+-----+-----+-----+
|code |stat | devnum | length | id |
+-----+-----+-----+-----+-----+-----+-----+-----+
<-------- length --------->
+----- . . . . . -----+
| data |
+----- . . . . . -----+
</pre>
<p>
'code' indicates the response to the request. OK (0x00) indicates
success however other codes also indicate success
but qualified in some manner:
<blockquote>
<dl>
<dt>0x80 ERROR<p><dd>
An error occurred. The server provides an error
message in the data section.
<p>
<dt>0x40 IOERR<p><dd>
An i/o error occurred during a READ/WRITE
request. The status byte has the 'unitstat'
data. This should signal the client to issue the
SENSE request to obtain the current sense data.
<p>
<dt>0x20 BUSY<p><dd>
Device was not available for a START request and
the NOWAIT flag bit was turned on.
<p>
<dt>0x10 COMP<p><dd>
Data returned is compressed. The status byte
indicates how the data is compressed (zlib or
bzip2) and at what offset the compressed data
starts (0 .. 15). This bit is only turned on
when both the 'code' and 'status' bytes would
otherwise be zero.
<p>
<dt>0x08 PURGE<p><dd>
START request was issued by the client. A list
of 'records' to be purged from local cache is
returned. These are 'records' that have been
updated since the last START/END request from
the client by other systems. Each record identifier
is a 4-byte field in the data segment. The number
of records then is 'length'/4. If the number of
records exceeds a threshold (16) then 'length'
will be zero indicating that the client should
purge all locally cached records for the device.
</dl>
</blockquote>
<p>
'stat' contains status information as a result of the request.
For READ/WRITE requests this contains the 'unitstat'
information if an IOERR occurred.
<p>
'devnum' specifies the server device number
<p>
'id' specifies the system identifier for the request.
<p>
'length' is the size of the data returned.
<p><br>
<h2><a NAME="caching">Caching</a></h2>
<p>
Cached records (eg CKD tracks or FBA blocks) are kept independently on
both the client and server sides. Whenever the client issues a START
request to initiate a channel program the server will return a list
of records to purge from the client's cache that have been updated by
other clients since the last START request. If the list is too large
the server will indicate that the client should purge all records for
the device.
<p><br>
<h2><a NAME="compression">Compression</a></h2>
<p>
Data that would normally be transferred uncompressed between client
and host can optionally be compressed by specifying the '<code>comp=</code>'
keyword on the device configuration statement or attach command.
For example:
<pre class="jcl">
0100 3350 192.168.2.12 comp=3
</pre>
<p>
The value of the 'comp=' keyword is the zlib compression parameter
which should be a number between 1 .. 9. A value closer to 1 means
less compression but less processor time to perform the compression.
A value closer to 9 means the data is compressed more but more processor
time is required.
<p>
If the server is on 'localhost' then you should not specify 'comp='.
Otherwise you are just stealing processor time to do compression/
uncompression from Hercules. If the server is on a local network
then I would recommend specifying a low value such as 1, 2 or 3.
We are on a curve here, trying to trade cpu cycles for network traffic
to derive an optimal throughput.
<p>
If the devices on the server are compressed devices (eg CCKD or CFBA)
then the 'records' (eg. track images or block groups) may be transferred
compressed regardless of the 'comp=' setting. This depends on whether
the client supports the compression type (zlib or bzip2) of the record
on the server and whether the record is actually compressed in the
server cache.
<p>
For example:
<p>
Suppose on the client that you execute one or more channel programs
to read a record on a ckd track, update a record on the same track,
and then read another (or the same) record on the track.
<p>
For the first read the server will read the track image and
pass it to the client as it was originally compressed in the file.
To update a portion of the track image the server must uncompress
the track image so data in it can be updated. When the client next
reads from the track image, the track image is uncompressed.
<p>
Specifying 'comp=' means that uncompressed data sent to the client
will be compressed. If the data to be sent to the client is already
compressed then the data is sent as is, unless the client has indicated
that it does not support that compression algorithm.
<p><br>
<hr noshade>
<p><center>
<a href="##" onclick="history.go(-1)"><img src="images/back.gif" border=0 alt="back"></a>
<p class="lastupd"><script language="Javascript">
document.write( "Last updated " + document.lastModified + "" );
</script></p>
</BODY>
</HTML>