1 ////////////////////////////////////////////////////////////////////////////////////
3 // FILE: device_driver.c
6 // This file is C source for SWAP driver.
8 // SEE ALSO: device_driver.h
9 // AUTHOR: L.Komkov, S.Dianov, S.Grekhov, A.Gerenkov
10 // COMPANY NAME: Samsung Research Center in Moscow
11 // DEPT NAME: Advanced Software Group
12 // CREATED: 2008.02.15
14 // REVISION DATE: 2008.12.03
16 ////////////////////////////////////////////////////////////////////////////////////
19 #include "device_driver.h" // device driver
20 #include "handlers_core.h"
21 #include <linux/notifier.h>
22 #include "sspt/sspt_procs.h"
25 extern unsigned long swap_sum_time;
26 extern unsigned long swap_sum_hit;
30 extern unsigned long imi_sum_time;
31 extern unsigned long imi_sum_hit;
34 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 17)
35 static BLOCKING_NOTIFIER_HEAD(swap_notifier_list);
38 EXPORT_SYMBOL_GPL(gl_nNotifyTgid);
40 DECLARE_WAIT_QUEUE_HEAD (notification_waiters_queue);
41 volatile unsigned notification_count;
43 static int device_mmap (struct file *filp, struct vm_area_struct *vma);
44 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 36)
45 static int device_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg);
47 static long device_ioctl (struct file *file, unsigned int cmd, unsigned long arg);
49 static int device_open(struct inode *, struct file *);
50 static int device_release(struct inode *, struct file *);
51 static ssize_t device_read(struct file *, char *, size_t, loff_t *);
52 static ssize_t device_write(struct file *, const char *, size_t, loff_t *);
54 static int gl_nDeviceOpened = 0;
55 static struct file_operations device_fops = {
58 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 36)
59 .ioctl = device_ioctl,
61 .unlocked_ioctl = device_ioctl,
64 .write = device_write,
66 .release = device_release
69 typedef void (* dbi_module_callback)();
71 int device_init (void)
74 nReserved = register_chrdev(0, device_name, &device_fops);
77 unregister_chrdev(nReserved, device_name);
78 EPRINTF("Cannot register character device!");
81 EPRINTF("New device node with major number [%d], was created\n", nReserved);
82 device_major = nReserved;
86 void device_down (void)
88 unregister_chrdev(device_major, device_name);
91 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 17)
92 void swap_register_notify (struct notifier_block *nb)
94 blocking_notifier_chain_register(&swap_notifier_list, nb);
96 EXPORT_SYMBOL_GPL(swap_register_notify);
98 void swap_unregister_notify (struct notifier_block *nb)
100 blocking_notifier_chain_unregister(&swap_notifier_list, nb);
102 EXPORT_SYMBOL_GPL(swap_unregister_notify);
105 void notify_user (event_id_t event_id)
107 ec_info.events_counters[event_id] += 1;
109 if (EVENT_EC_PROBE_RECORD == event_id)
111 // EC_PROBE_RECORD events happen to often. To reduce overhead user
112 // space will be notified only once per each EVENTS_AGGREGATION_USEC
113 static uint64_t timestamp_usec = 0;
115 uint64_t current_usec;
120 do_gettimeofday (&tv);
121 current_usec = 1000000ULL * (unsigned) tv.tv_sec + (unsigned) tv.tv_usec;
123 if (current_usec < timestamp_usec)
125 // Note: time from do_gettimeofday() may go backward
126 EPRINTF ("current_usec=%llu timestamp_usec=%llu", current_usec, timestamp_usec);
130 delta_usec = current_usec - timestamp_usec;
131 if (EVENTS_AGGREGATION_USEC > delta_usec)
133 // wait the time left
135 unsigned UNUSED left_usec = EVENTS_AGGREGATION_USEC - delta_usec;
136 #endif /* defined(__DEBUG) */
137 return; // supress notification
140 timestamp_usec = current_usec; // remember new time for the future use
141 } else if (EVENT_EC_START_CONDITION_SEEN == event_id) {
142 return; // supress notification
143 } else if (EVENT_EC_STOP_CONDITION_SEEN == event_id) {
144 return; // supress notification
147 ++notification_count;
148 wake_up_interruptible (¬ification_waiters_queue);
151 static int device_mmap (struct file *filp UNUSED, struct vm_area_struct *vma)
154 EPRINTF("Null pointer to buffer!");
157 return remap_vmalloc_range (vma, p_buffer, 0);
160 static int device_open(struct inode *inode, struct file *file)
162 /*if (gl_nDeviceOpened)
166 try_module_get(THIS_MODULE);
170 static int device_release(struct inode *inode, struct file *file)
173 module_put(THIS_MODULE);
177 static ssize_t device_read(struct file *filp, char *buffer, size_t length, loff_t * offset)
179 EPRINTF("Operation <<read>> not supported!");
183 static ssize_t device_write(struct file *filp, const char *buff, size_t len, loff_t * off)
185 EPRINTF("Operation <<write>> not supported!");
189 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 36)
190 static int device_ioctl (struct inode *inode UNUSED, struct file *file UNUSED, unsigned int cmd, unsigned long arg)
192 static long device_ioctl (struct file *file UNUSED, unsigned int cmd, unsigned long arg)
195 unsigned long spinlock_flags = 0L;
197 // DPRINTF("Command=%d", cmd);
200 case EC_IOCTL_SET_EC_MODE:
202 ioctl_general_t param;
203 unsigned long nIgnoredBytes = 0;
204 memset(¶m, '0', sizeof(ioctl_general_t));
205 nIgnoredBytes = copy_from_user (¶m, (void*)arg, sizeof(ioctl_general_t));
206 if (nIgnoredBytes > 0) {
210 if(SetECMode(param.m_unsignedLong) == -1) {
215 DPRINTF("Set EC Mode = %lu", param.m_unsignedLong);
218 case EC_IOCTL_GET_EC_MODE:
220 ioctl_general_t param;
221 unsigned long nIgnoredBytes = 0;
222 memset(¶m, '0', sizeof(ioctl_general_t));
223 param.m_unsignedLong = GetECMode();
224 nIgnoredBytes = copy_to_user ((void*)arg, ¶m, sizeof (ioctl_general_t));
225 if (nIgnoredBytes > 0) {
230 // DPRINTF("Get EC Mode = %lu", param.m_unsignedLong); // Frequent call
233 case EC_IOCTL_SET_BUFFER_SIZE:
235 ioctl_general_t param;
236 unsigned long nIgnoredBytes = 0;
237 memset(¶m, '0', sizeof(ioctl_general_t));
238 nIgnoredBytes = copy_from_user (¶m, (void*)arg, sizeof(ioctl_general_t));
239 if (nIgnoredBytes > 0) {
243 if (SetBufferSize(param.m_unsignedLong) == -1) {
248 DPRINTF("Set Buffer Size = %lu", param.m_unsignedLong);
251 case EC_IOCTL_GET_BUFFER_SIZE:
253 ioctl_general_t param;
254 unsigned long nIgnoredBytes = 0;
255 memset(¶m, '0', sizeof(ioctl_general_t));
256 param.m_unsignedLong = GetBufferSize();
257 nIgnoredBytes = copy_to_user ((void*)arg, ¶m, sizeof (ioctl_general_t));
258 if (nIgnoredBytes > 0) {
263 DPRINTF("Get Buffer Size = %lu", param.m_unsignedLong);
266 case EC_IOCTL_RESET_BUFFER:
268 if (ResetBuffer() == -1) {
273 DPRINTF("Reset Buffer");
276 case EC_IOCTL_GET_EC_INFO:
278 if (copy_ec_info_to_user_space ((ec_info_t *) arg) != 0) {
283 // DPRINTF("Get Buffer Status"); // Frequent call
286 case EC_IOCTL_CONSUME_BUFFER:
288 static ec_info_t ec_info_copy;
289 int nIgnoredBytes = 0;
291 nIgnoredBytes = copy_from_user (&ec_info_copy, (ec_info_t *) arg, sizeof (ec_info_t));
292 if(nIgnoredBytes > 0)
294 EPRINTF ("copy_from_user(%08X,%08X)=%d", (unsigned) arg, (unsigned) &ec_info_copy, nIgnoredBytes);
299 spin_lock_irqsave (&ec_spinlock, spinlock_flags);
302 if(ec_info.after_last > ec_info.first) {
303 ec_info.buffer_effect = ec_info.buffer_size;
305 if (ec_info.after_last == ec_info.buffer_effect) {
308 ec_info.first = ec_info_copy.after_last;
310 ec_info.trace_size = ec_info.trace_size - ec_info_copy.trace_size;
312 spin_unlock_irqrestore (&ec_spinlock, spinlock_flags);
314 // DPRINTF("Consume Buffer"); // Frequent call
317 case EC_IOCTL_ADD_PROBE:
319 unsigned long addr = arg;
320 result = add_probe(addr);
324 //@AGv: remove_probe expects probe address instead of name
325 /*case EC_IOCTL_REMOVE_PROBE:
327 char *probe_name = (char *) arg;
328 result = remove_probe (probe_name);
332 case EC_IOCTL_SET_APPDEPS:
335 result = copy_from_user(&size, (void *)arg, sizeof(size_t));
337 EPRINTF("Cannot copy deps size!");
341 DPRINTF("Deps size has been copied (%d)", size);
344 DPRINTF("Deps are size of 0");
348 deps = vmalloc(size);
350 EPRINTF("Cannot alloc mem for deps!");
354 DPRINTF("Mem for deps has been allocated");
356 result = copy_from_user(deps, (void *)arg, size);
358 EPRINTF("Cannot copy deps!");
362 DPRINTF("Deps has been copied successfully");
366 case EC_IOCTL_SET_PID:
370 result = copy_from_user(&_pid, (void *)arg, sizeof(unsigned int));
372 EPRINTF("Cannot copy pid!");
379 DPRINTF("EC_IOCTL_SET_PID pid:%d", inst_pid);
383 case EC_IOCTL_SET_PROFILEBUNDLE:
387 result = copy_from_user(&size, (void *)arg, sizeof(size_t));
389 EPRINTF("Cannot copy bundle size!");
393 DPRINTF("Bundle size has been copied");
395 bundle = vmalloc(size);
396 if (bundle == NULL) {
397 EPRINTF("Cannot alloc mem for bundle!");
401 DPRINTF("Mem for bundle has been alloced");
403 result = copy_from_user(bundle, (void *)arg, size);
405 EPRINTF("Cannot copy bundle!");
409 DPRINTF("Bundle has been copied successfully");
411 if (link_bundle() == -1) {
412 EPRINTF("Cannot link profile bundle!");
419 case EC_IOCTL_RESET_PROBES:
421 result = reset_probes();
425 case EC_IOCTL_UPDATE_CONDS:
428 struct cond *c, *c_tmp, *p_cond;
429 unsigned char *p_data;
432 err = copy_from_user(&args_cnt, (void *)arg, sizeof(int));
437 /* first, delete all the conds */
438 list_for_each_entry_safe(c, c_tmp, &cond_list.list, list) {
442 /* second, add new conds */
443 p_data = (unsigned char *)(arg + sizeof(int));
444 for (i = 0; i < args_cnt; i++) {
445 p_cond = kmalloc(sizeof(struct cond), GFP_KERNEL);
447 DPRINTF("Cannot alloc cond!");
451 err = copy_from_user(&p_cond->tmpl, p_data, sizeof(struct event_tmpl));
453 DPRINTF("Cannot copy cond from user!");
458 list_add(&(p_cond->list), &(cond_list.list));
459 p_data += sizeof(struct event_tmpl);
463 case EC_IOCTL_ATTACH:
465 unsigned long dbi_flags;
466 struct dbi_modules_handlers *local_mh;
467 struct dbi_modules_handlers_info *local_mhi;
469 dbi_module_callback dmc_start;
471 // call "start"-callback for all modules according module priority
472 local_mh = get_dbi_modules_handlers();
473 spin_lock_irqsave(&local_mh->lock, dbi_flags);
474 for (j = 0; j <= MAX_PRIORITY; j++) {
475 list_for_each_entry_rcu(local_mhi, &local_mh->modules_handlers, dbi_list_head) {
476 if (local_mhi->dbi_module_priority_start == j) {
477 if (local_mhi->dbi_module_callback_start != NULL) {
478 printk("Started module callback (start) %s\n", local_mhi->dbi_module->name);
479 dmc_start = (dbi_module_callback )local_mhi->dbi_module_callback_start;
485 spin_unlock_irqrestore(&local_mh->lock, dbi_flags);
487 result = ec_user_attach ();
488 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 17)
489 DPRINTF("EC_IOCTL_ATTACH calling notification chain");
490 blocking_notifier_call_chain(&swap_notifier_list, EC_IOCTL_ATTACH, (void*)NULL);
492 DPRINTF("Attach Probes");
495 case EC_IOCTL_ACTIVATE:
496 result = ec_user_activate ();
497 DPRINTF("Activate Probes");
499 case EC_IOCTL_STOP_AND_DETACH:
501 unsigned long nIgnoredBytes = 0;
502 unsigned long dbi_flags;
503 struct dbi_modules_handlers *local_mh;
504 struct dbi_modules_handlers_info *local_mhi;
505 unsigned int local_module_refcount = 0;
507 dbi_module_callback dmc_stop;
509 #ifdef OVERHEAD_DEBUG
510 printk("\nswap_sum_time = %ld in kprobe_handler()\n", swap_sum_time);
511 printk("swap_sum_hit = %ld in kprobe_handler()\n", swap_sum_hit);
516 printk("\n### imi_sum_time = %ld in install_mapped_ips()\n", imi_sum_time);
517 printk("### imi_sum_hit = %ld in install_mapped_ips()\n", imi_sum_hit);
519 if (imi_sum_hit != 0) {
520 printk("### time = %ld in install_mapped_ips()\n", imi_sum_time/imi_sum_hit);
526 local_mh = get_dbi_modules_handlers();
527 if(ec_user_stop() != 0) {
531 nIgnoredBytes = copy_ec_info_to_user_space ((ec_info_t*)arg);
532 if(nIgnoredBytes > 0) {
537 sspt_procs_free_all();
541 DPRINTF("Stop and Detach Probes");
542 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 17)
543 DPRINTF("EC_IOCTL_STOP_AND_DETACH calling notification chain");
544 blocking_notifier_call_chain(&swap_notifier_list, EC_IOCTL_STOP_AND_DETACH, (void*)&gl_nNotifyTgid);
546 // call "stop"-callback for all modules according module priority
547 spin_lock_irqsave(&local_mh->lock, dbi_flags);
548 for (j = 0; j <= MAX_PRIORITY; j++) {
549 list_for_each_entry_rcu(local_mhi, &local_mh->modules_handlers, dbi_list_head) {
550 if (local_mhi->dbi_module_priority_stop == j) {
551 if (local_mhi->dbi_module_callback_stop != NULL) {
552 printk("Started module callback (stop) %s\n", local_mhi->dbi_module->name);
553 dmc_stop = (dbi_module_callback )local_mhi->dbi_module_callback_stop;
559 spin_unlock_irqrestore(&local_mh->lock, dbi_flags);
561 spin_lock_irqsave(&local_mh->lock, dbi_flags);
562 list_for_each_entry_rcu(local_mhi, &local_mh->modules_handlers, dbi_list_head) {
563 local_module_refcount = module_refcount(local_mhi->dbi_module);
564 if (local_module_refcount == 1) {
565 module_put(local_mhi->dbi_module);
567 else if (local_module_refcount > 1) {
568 printk("local_module_refcount too much - force set refcount to zero\n");
569 while (local_module_refcount--)
570 module_put(local_mhi->dbi_module);
573 spin_unlock_irqrestore(&local_mh->lock, dbi_flags);
576 case EC_IOCTL_WAIT_NOTIFICATION:
578 static ec_info_t ec_info_copy;
580 ioctl_wait_notification_t ioctl_args;
582 result = copy_from_user (&ioctl_args, (void *) arg, sizeof (ioctl_args));
589 result = wait_event_interruptible (notification_waiters_queue, ioctl_args.notification_count != notification_count);
592 result = -EINTR; // woken by signal (ERESTARTSYS 512)
596 ioctl_args.notification_count = notification_count;
598 result = copy_to_user ((void *) arg, &ioctl_args, sizeof (ioctl_args));
605 // FIXME: synchronization is necessary here (ec_info must be locked).
606 // ENTER_CRITICAL_SECTION
607 memcpy (&ec_info_copy, &ec_info, sizeof (ec_info_copy));
608 // LEAVE_CRITICAL_SECTION
610 result = copy_to_user ((void *) ioctl_args.p_ec_info, &ec_info_copy, sizeof (ec_info_t));
613 EPRINTF ("copy_to_user(%08X,%08X)=%d", (unsigned) ioctl_args.p_ec_info, (unsigned) &ec_info_copy, result);
620 case EC_IOCTL_US_EVENT:
622 ioctl_us_event_t ioctl_args;
623 result = copy_from_user (&ioctl_args, (void *) arg, sizeof (ioctl_args));
627 EPRINTF ("copy_from_user() failure");
631 if(ioctl_args.len == 0){
633 EPRINTF ("invalid event length!");
636 char *buf = kmalloc(ioctl_args.len, GFP_KERNEL);
639 EPRINTF ("failed to alloc mem for event!");
642 result = copy_from_user (buf, (void *) ioctl_args.data, ioctl_args.len);
645 EPRINTF ("failed to copy event from user space!");
648 result = put_us_event(buf, ioctl_args.len);
653 // DPRINTF("User Space Event"); // Frequent call
657 case EC_IOCTL_SET_EVENT_MASK:
660 result = copy_from_user (&mask, (void *) arg, sizeof (mask));
667 result = set_event_mask (mask);
672 DPRINTF("Set Event Mask = %d", mask);
676 case EC_IOCTL_GET_EVENT_MASK:
679 result = get_event_mask(&mask);
684 result = copy_to_user ((void *) arg, &mask, sizeof (mask));
689 DPRINTF("Get Event Mask = %d", mask);
693 case EC_IOCTL_SET_PREDEF_UPROBES:
698 ioctl_predef_uprobes_info_t data;
699 result = copy_from_user (&data, (void *) arg, sizeof (data));
706 result = set_predef_uprobes (&data);
711 DPRINTF("Set Predefined User Space Probes");
715 case EC_IOCTL_GET_PREDEF_UPROBES:
720 result = get_predef_uprobes((ioctl_predef_uprobes_info_t *)arg);
725 DPRINTF("Get Predefined User Space Probes");
729 case EC_IOCTL_GET_PREDEF_UPROBES_SIZE:
732 result = get_predef_uprobes_size(&size);
737 result = copy_to_user ((void *) arg, &size, sizeof (size));
742 DPRINTF("Get Size of Predefined User Space Probes");
747 EPRINTF ("Unknown driver command = %u", cmd);