2 * drivers/s390/char/monreader.c
4 * Character device driver for reading z/VM *MONITOR service records.
6 * Copyright (C) 2004 IBM Corporation, IBM Deutschland Entwicklung GmbH.
8 * Author: Gerald Schaefer <geraldsc@de.ibm.com>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/errno.h>
15 #include <linux/types.h>
16 #include <linux/kernel.h>
17 #include <linux/miscdevice.h>
18 #include <linux/ctype.h>
19 #include <linux/spinlock.h>
20 #include <linux/interrupt.h>
21 #include <asm/uaccess.h>
22 #include <asm/ebcdic.h>
23 #include <asm/extmem.h>
24 #include <linux/poll.h>
25 #include "../net/iucv.h"
28 //#define MON_DEBUG /* Debug messages on/off */
30 #define MON_NAME "monreader"
32 #define P_INFO(x...) printk(KERN_INFO MON_NAME " info: " x)
33 #define P_ERROR(x...) printk(KERN_ERR MON_NAME " error: " x)
34 #define P_WARNING(x...) printk(KERN_WARNING MON_NAME " warning: " x)
37 #define P_DEBUG(x...) printk(KERN_DEBUG MON_NAME " debug: " x)
39 #define P_DEBUG(x...) do {} while (0)
42 #define MON_COLLECT_SAMPLE 0x80
43 #define MON_COLLECT_EVENT 0x40
44 #define MON_SERVICE "*MONITOR"
45 #define MON_IN_USE 0x01
46 #define MON_MSGLIM 255
48 static char mon_dcss_name[9] = "MONDCSS\0";
53 iucv_MessagePending local_eib;
60 iucv_handle_t iucv_handle;
61 struct mon_msg *msg_array[MON_MSGLIM];
62 unsigned int write_index;
63 unsigned int read_index;
64 atomic_t msglim_count;
66 atomic_t iucv_connected;
67 atomic_t iucv_severed;
70 static unsigned long mon_in_use = 0;
72 static unsigned long mon_dcss_start;
73 static unsigned long mon_dcss_end;
75 static DECLARE_WAIT_QUEUE_HEAD(mon_read_wait_queue);
76 static DECLARE_WAIT_QUEUE_HEAD(mon_conn_wait_queue);
78 static u8 iucv_host[8] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
80 static u8 user_data_connect[16] = {
81 /* Version code, must be 0x01 for shared mode */
84 MON_COLLECT_SAMPLE | MON_COLLECT_EVENT,
85 /* DCSS name in EBCDIC, 8 bytes padded with blanks */
86 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
87 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
90 static u8 user_data_sever[16] = {
91 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
92 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
96 /******************************************************************************
98 *****************************************************************************/
100 * Create the 8 bytes EBCDIC DCSS segment name from
101 * an ASCII name, incl. padding
104 dcss_mkname(char *ascii_name, char *ebcdic_name)
108 for (i = 0; i < 8; i++) {
109 if (ascii_name[i] == '\0')
111 ebcdic_name[i] = toupper(ascii_name[i]);
114 ebcdic_name[i] = ' ';
115 ASCEBC(ebcdic_name, 8);
119 * print appropriate error message for segment_load()/segment_type()
123 mon_segment_warn(int rc, char* seg_name)
127 P_WARNING("cannot load/query segment %s, does not exist\n",
131 P_WARNING("cannot load/query segment %s, not running on VM\n",
135 P_WARNING("cannot load/query segment %s, hardware error\n",
139 P_WARNING("cannot load/query segment %s, is a multi-part "
140 "segment\n", seg_name);
143 P_WARNING("cannot load/query segment %s, overlaps with "
144 "storage\n", seg_name);
147 P_WARNING("cannot load/query segment %s, overlaps with "
148 "already loaded dcss\n", seg_name);
151 P_WARNING("cannot load/query segment %s, already loaded in "
152 "incompatible mode\n", seg_name);
155 P_WARNING("cannot load/query segment %s, out of memory\n",
159 P_WARNING("cannot load/query segment %s, exceeds kernel "
160 "mapping range\n", seg_name);
163 P_WARNING("cannot load/query segment %s, return value %i\n",
169 static inline unsigned long
170 mon_mca_start(struct mon_msg *monmsg)
172 return monmsg->local_eib.ln1msg1.iprmmsg1_u32;
175 static inline unsigned long
176 mon_mca_end(struct mon_msg *monmsg)
178 return monmsg->local_eib.ln1msg2.ipbfln1f;
182 mon_mca_type(struct mon_msg *monmsg, u8 index)
184 return *((u8 *) mon_mca_start(monmsg) + monmsg->mca_offset + index);
188 mon_mca_size(struct mon_msg *monmsg)
190 return mon_mca_end(monmsg) - mon_mca_start(monmsg) + 1;
194 mon_rec_start(struct mon_msg *monmsg)
196 return *((u32 *) (mon_mca_start(monmsg) + monmsg->mca_offset + 4));
200 mon_rec_end(struct mon_msg *monmsg)
202 return *((u32 *) (mon_mca_start(monmsg) + monmsg->mca_offset + 8));
206 mon_check_mca(struct mon_msg *monmsg)
208 if ((mon_rec_end(monmsg) <= mon_rec_start(monmsg)) ||
209 (mon_rec_start(monmsg) < mon_dcss_start) ||
210 (mon_rec_end(monmsg) > mon_dcss_end) ||
211 (mon_mca_type(monmsg, 0) == 0) ||
212 (mon_mca_size(monmsg) % 12 != 0) ||
213 (mon_mca_end(monmsg) <= mon_mca_start(monmsg)) ||
214 (mon_mca_end(monmsg) > mon_dcss_end) ||
215 (mon_mca_start(monmsg) < mon_dcss_start) ||
216 ((mon_mca_type(monmsg, 1) == 0) && (mon_mca_type(monmsg, 2) == 0)))
218 P_DEBUG("READ, IGNORED INVALID MCA\n\n");
225 mon_send_reply(struct mon_msg *monmsg, struct mon_private *monpriv)
230 P_DEBUG("read, REPLY: pathid = 0x%04X, msgid = 0x%08X, trgcls = "
232 monmsg->local_eib.ippathid, monmsg->local_eib.ipmsgid,
233 monmsg->local_eib.iptrgcls);
234 rc = iucv_reply_prmmsg(monmsg->local_eib.ippathid,
235 monmsg->local_eib.ipmsgid,
236 monmsg->local_eib.iptrgcls,
238 atomic_dec(&monpriv->msglim_count);
239 if (likely(!monmsg->msglim_reached)) {
241 monmsg->mca_offset = 0;
242 monpriv->read_index = (monpriv->read_index + 1) %
244 atomic_dec(&monpriv->read_ready);
246 monmsg->replied_msglim = 1;
248 P_ERROR("read, IUCV reply failed with rc = %i\n\n", rc);
254 static inline struct mon_private *
258 struct mon_private *monpriv;
260 monpriv = kzalloc(sizeof(struct mon_private), GFP_KERNEL);
262 P_ERROR("no memory for monpriv\n");
265 for (i = 0; i < MON_MSGLIM; i++) {
266 monpriv->msg_array[i] = kzalloc(sizeof(struct mon_msg),
268 if (!monpriv->msg_array[i]) {
269 P_ERROR("open, no memory for msg_array\n");
270 for (j = 0; j < i; j++)
271 kfree(monpriv->msg_array[j]);
279 mon_read_debug(struct mon_msg *monmsg, struct mon_private *monpriv)
282 u8 msg_type[2], mca_type;
283 unsigned long records_len;
285 records_len = mon_rec_end(monmsg) - mon_rec_start(monmsg) + 1;
287 memcpy(msg_type, &monmsg->local_eib.iptrgcls, 2);
289 mca_type = mon_mca_type(monmsg, 0);
290 EBCASC(&mca_type, 1);
292 P_DEBUG("read, mon_read_index = %i, mon_write_index = %i\n",
293 monpriv->read_index, monpriv->write_index);
294 P_DEBUG("read, pathid = 0x%04X, msgid = 0x%08X, trgcls = 0x%08X\n",
295 monmsg->local_eib.ippathid, monmsg->local_eib.ipmsgid,
296 monmsg->local_eib.iptrgcls);
297 P_DEBUG("read, msg_type = '%c%c', mca_type = '%c' / 0x%X / 0x%X\n",
298 msg_type[0], msg_type[1], mca_type ? mca_type : 'X',
299 mon_mca_type(monmsg, 1), mon_mca_type(monmsg, 2));
300 P_DEBUG("read, MCA: start = 0x%lX, end = 0x%lX\n",
301 mon_mca_start(monmsg), mon_mca_end(monmsg));
302 P_DEBUG("read, REC: start = 0x%X, end = 0x%X, len = %lu\n\n",
303 mon_rec_start(monmsg), mon_rec_end(monmsg), records_len);
304 if (mon_mca_size(monmsg) > 12)
305 P_DEBUG("READ, MORE THAN ONE MCA\n\n");
310 mon_next_mca(struct mon_msg *monmsg)
312 if (likely((mon_mca_size(monmsg) - monmsg->mca_offset) == 12))
314 P_DEBUG("READ, NEXT MCA\n\n");
315 monmsg->mca_offset += 12;
319 static inline struct mon_msg *
320 mon_next_message(struct mon_private *monpriv)
322 struct mon_msg *monmsg;
324 if (!atomic_read(&monpriv->read_ready))
326 monmsg = monpriv->msg_array[monpriv->read_index];
327 if (unlikely(monmsg->replied_msglim)) {
328 monmsg->replied_msglim = 0;
329 monmsg->msglim_reached = 0;
331 monmsg->mca_offset = 0;
332 P_WARNING("read, message limit reached\n");
333 monpriv->read_index = (monpriv->read_index + 1) %
335 atomic_dec(&monpriv->read_ready);
336 return ERR_PTR(-EOVERFLOW);
342 /******************************************************************************
344 *****************************************************************************/
346 mon_iucv_ConnectionComplete(iucv_ConnectionComplete *eib, void *pgm_data)
348 struct mon_private *monpriv = (struct mon_private *) pgm_data;
350 P_DEBUG("IUCV connection completed\n");
351 P_DEBUG("IUCV ACCEPT (from *MONITOR): Version = 0x%02X, Event = "
352 "0x%02X, Sample = 0x%02X\n",
353 eib->ipuser[0], eib->ipuser[1], eib->ipuser[2]);
354 atomic_set(&monpriv->iucv_connected, 1);
355 wake_up(&mon_conn_wait_queue);
359 mon_iucv_ConnectionSevered(iucv_ConnectionSevered *eib, void *pgm_data)
361 struct mon_private *monpriv = (struct mon_private *) pgm_data;
363 P_ERROR("IUCV connection severed with rc = 0x%X\n",
364 (u8) eib->ipuser[0]);
365 atomic_set(&monpriv->iucv_severed, 1);
366 wake_up(&mon_conn_wait_queue);
367 wake_up_interruptible(&mon_read_wait_queue);
371 mon_iucv_MessagePending(iucv_MessagePending *eib, void *pgm_data)
373 struct mon_private *monpriv = (struct mon_private *) pgm_data;
375 P_DEBUG("IUCV message pending\n");
376 memcpy(&monpriv->msg_array[monpriv->write_index]->local_eib, eib,
377 sizeof(iucv_MessagePending));
378 if (atomic_inc_return(&monpriv->msglim_count) == MON_MSGLIM) {
379 P_WARNING("IUCV message pending, message limit (%i) reached\n",
381 monpriv->msg_array[monpriv->write_index]->msglim_reached = 1;
383 monpriv->write_index = (monpriv->write_index + 1) % MON_MSGLIM;
384 atomic_inc(&monpriv->read_ready);
385 wake_up_interruptible(&mon_read_wait_queue);
388 static iucv_interrupt_ops_t mon_iucvops = {
389 .ConnectionComplete = mon_iucv_ConnectionComplete,
390 .ConnectionSevered = mon_iucv_ConnectionSevered,
391 .MessagePending = mon_iucv_MessagePending,
394 /******************************************************************************
396 *****************************************************************************/
398 mon_open(struct inode *inode, struct file *filp)
401 struct mon_private *monpriv;
404 * only one user allowed
406 if (test_and_set_bit(MON_IN_USE, &mon_in_use))
409 monpriv = mon_alloc_mem();
414 * Register with IUCV and connect to *MONITOR service
416 monpriv->iucv_handle = iucv_register_program("my_monreader ",
421 if (!monpriv->iucv_handle) {
422 P_ERROR("failed to register with iucv driver\n");
426 P_INFO("open, registered with IUCV\n");
428 rc = iucv_connect(&monpriv->pathid, MON_MSGLIM, user_data_connect,
429 MON_SERVICE, iucv_host, IPRMDATA, NULL, NULL,
430 monpriv->iucv_handle, NULL);
432 P_ERROR("iucv connection to *MONITOR failed with "
433 "IPUSER SEVER code = %i\n", rc);
438 * Wait for connection confirmation
440 wait_event(mon_conn_wait_queue,
441 atomic_read(&monpriv->iucv_connected) ||
442 atomic_read(&monpriv->iucv_severed));
443 if (atomic_read(&monpriv->iucv_severed)) {
444 atomic_set(&monpriv->iucv_severed, 0);
445 atomic_set(&monpriv->iucv_connected, 0);
449 P_INFO("open, established connection to *MONITOR service\n\n");
450 filp->private_data = monpriv;
451 return nonseekable_open(inode, filp);
454 iucv_unregister_program(monpriv->iucv_handle);
456 for (i = 0; i < MON_MSGLIM; i++)
457 kfree(monpriv->msg_array[i]);
459 clear_bit(MON_IN_USE, &mon_in_use);
464 mon_close(struct inode *inode, struct file *filp)
467 struct mon_private *monpriv = filp->private_data;
470 * Close IUCV connection and unregister
472 rc = iucv_sever(monpriv->pathid, user_data_sever);
474 P_ERROR("close, iucv_sever failed with rc = %i\n", rc);
476 P_INFO("close, terminated connection to *MONITOR service\n");
478 rc = iucv_unregister_program(monpriv->iucv_handle);
480 P_ERROR("close, iucv_unregister failed with rc = %i\n", rc);
482 P_INFO("close, unregistered with IUCV\n");
484 atomic_set(&monpriv->iucv_severed, 0);
485 atomic_set(&monpriv->iucv_connected, 0);
486 atomic_set(&monpriv->read_ready, 0);
487 atomic_set(&monpriv->msglim_count, 0);
488 monpriv->write_index = 0;
489 monpriv->read_index = 0;
491 for (i = 0; i < MON_MSGLIM; i++)
492 kfree(monpriv->msg_array[i]);
494 clear_bit(MON_IN_USE, &mon_in_use);
499 mon_read(struct file *filp, char __user *data, size_t count, loff_t *ppos)
501 struct mon_private *monpriv = filp->private_data;
502 struct mon_msg *monmsg;
506 monmsg = mon_next_message(monpriv);
508 return PTR_ERR(monmsg);
511 if (filp->f_flags & O_NONBLOCK)
513 ret = wait_event_interruptible(mon_read_wait_queue,
514 atomic_read(&monpriv->read_ready) ||
515 atomic_read(&monpriv->iucv_severed));
518 if (unlikely(atomic_read(&monpriv->iucv_severed)))
520 monmsg = monpriv->msg_array[monpriv->read_index];
524 monmsg->pos = mon_mca_start(monmsg) + monmsg->mca_offset;
525 mon_read_debug(monmsg, monpriv);
527 if (mon_check_mca(monmsg))
530 /* read monitor control element (12 bytes) first */
531 mce_start = mon_mca_start(monmsg) + monmsg->mca_offset;
532 if ((monmsg->pos >= mce_start) && (monmsg->pos < mce_start + 12)) {
533 count = min(count, (size_t) mce_start + 12 - monmsg->pos);
534 ret = copy_to_user(data, (void *) (unsigned long) monmsg->pos,
538 monmsg->pos += count;
539 if (monmsg->pos == mce_start + 12)
540 monmsg->pos = mon_rec_start(monmsg);
545 if (monmsg->pos <= mon_rec_end(monmsg)) {
546 count = min(count, (size_t) mon_rec_end(monmsg) - monmsg->pos
548 ret = copy_to_user(data, (void *) (unsigned long) monmsg->pos,
552 monmsg->pos += count;
553 if (monmsg->pos > mon_rec_end(monmsg))
554 mon_next_mca(monmsg);
558 ret = mon_send_reply(monmsg, monpriv);
567 mon_poll(struct file *filp, struct poll_table_struct *p)
569 struct mon_private *monpriv = filp->private_data;
571 poll_wait(filp, &mon_read_wait_queue, p);
572 if (unlikely(atomic_read(&monpriv->iucv_severed)))
574 if (atomic_read(&monpriv->read_ready))
575 return POLLIN | POLLRDNORM;
579 static struct file_operations mon_fops = {
580 .owner = THIS_MODULE,
582 .release = &mon_close,
587 static struct miscdevice mon_dev = {
590 .minor = MISC_DYNAMIC_MINOR,
593 /******************************************************************************
595 *****************************************************************************/
601 if (!MACHINE_IS_VM) {
602 P_ERROR("not running under z/VM, driver not loaded\n");
606 rc = segment_type(mon_dcss_name);
608 mon_segment_warn(rc, mon_dcss_name);
611 if (rc != SEG_TYPE_SC) {
612 P_ERROR("segment %s has unsupported type, should be SC\n",
617 rc = segment_load(mon_dcss_name, SEGMENT_SHARED,
618 &mon_dcss_start, &mon_dcss_end);
620 mon_segment_warn(rc, mon_dcss_name);
623 dcss_mkname(mon_dcss_name, &user_data_connect[8]);
625 rc = misc_register(&mon_dev);
627 P_ERROR("misc_register failed, rc = %i\n", rc);
630 P_INFO("Loaded segment %s from %p to %p, size = %lu Byte\n",
631 mon_dcss_name, (void *) mon_dcss_start, (void *) mon_dcss_end,
632 mon_dcss_end - mon_dcss_start + 1);
636 segment_unload(mon_dcss_name);
643 segment_unload(mon_dcss_name);
644 WARN_ON(misc_deregister(&mon_dev) != 0);
649 module_init(mon_init);
650 module_exit(mon_exit);
652 module_param_string(mondcss, mon_dcss_name, 9, 0444);
653 MODULE_PARM_DESC(mondcss, "Name of DCSS segment to be used for *MONITOR "
654 "service, max. 8 chars. Default is MONDCSS");
656 MODULE_AUTHOR("Gerald Schaefer <geraldsc@de.ibm.com>");
657 MODULE_DESCRIPTION("Character device driver for reading z/VM "
658 "monitor service records.");
659 MODULE_LICENSE("GPL");