lttv/lttv/hook.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include <config.h>
  21 #endif
  22
  23 #include <lttv/hook.h>
  24 #include <ltt/compiler.h>
  25 #include <ltt/ltt.h>
  26
  27 typedef struct _LttvHookClosure {
  28         LttvHook      hook;
  29         void         *hook_data;
  30         LttvHookPrio  prio;
  31         guint         ref_count;
  32 } LttvHookClosure;
  33
  34 gint lttv_hooks_prio_compare(LttvHookClosure *a, LttvHookClosure *b)
  35 {
  36         gint ret=0;
  37         if(a->prio < b->prio) ret = -1;
  38         else if(a->prio > b->prio) ret = 1;
  39         return ret;
  40 }
  41
  42
  43 LttvHooks *lttv_hooks_new(void)
  44 {
  45         return g_array_new(FALSE, FALSE, sizeof(LttvHookClosure));
  46 }
  47
  48
  49 void lttv_hooks_destroy(LttvHooks *h)
  50 {
  51         g_log(G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "lttv_hooks_destroy()");
  52         g_array_free(h, TRUE);
  53 }
  54
  55
  56 void lttv_hooks_add(LttvHooks *h, LttvHook f, void *hook_data, LttvHookPrio p)
  57 {
  58         LttvHookClosure *c, new_c;
  59         guint i;
  60
  61         if(unlikely(h == NULL))g_error("Null hook added");
  62
  63         new_c.hook = f;
  64         new_c.hook_data = hook_data;
  65         new_c.prio = p;
  66         new_c.ref_count = 1;
  67
  68         /* Preliminary check for duplication */
  69         /* only hook and hook data is checked */
  70         for(i = 0; i < h->len; i++) {
  71                 c = &g_array_index(h, LttvHookClosure, i);
  72                 if(new_c.hook == c->hook && new_c.hook_data == c->hook_data) {
  73                         g_assert(new_c.prio == c->prio);
  74                         c->ref_count++;
  75                         return;
  76                 }
  77         }
  78
  79
  80         for(i = 0; i < h->len; i++) {
  81                 c = &g_array_index(h, LttvHookClosure, i);
  82                 if(new_c.prio < c->prio) {
  83                         g_array_insert_val(h,i,new_c);
  84                         return;
  85                 }
  86         }
  87         if(i == h->len)
  88                 g_array_append_val(h,new_c);
  89 }
  90
  91 /* lttv_hooks_add_list
  92  *
  93  * Adds a sorted list into another sorted list.
  94  *
  95  * Note : h->len is modified, but only incremented. This assures
  96  * its coherence through the function.
  97  *
  98  * j is an index to the element following the last one added in the
  99  * destination array.
 100  */
 101 void lttv_hooks_add_list(LttvHooks *h, const LttvHooks *list)
 102 {
 103         guint i,j,k;
 104         LttvHookClosure *c;
 105         const LttvHookClosure *new_c;
 106
 107         if(unlikely(list == NULL)) return;
 108
 109         for(i = 0, j = 0 ; i < list->len; i++) {
 110                 new_c = &g_array_index(list, LttvHookClosure, i);
 111                 gboolean found=FALSE;
 112
 113                 /* Preliminary check for duplication */
 114                 /* only hook and hook data is checked, not priority */
 115                 for(k = 0; k < h->len; k++) {
 116                         c = &g_array_index(h, LttvHookClosure, k);
 117                         if(new_c->hook == c->hook && new_c->hook_data == c->hook_data) {
 118                                 /* Found another identical entry : increment its ref_count and
 119                                  * jump over the source index */
 120                                 g_assert(new_c->prio == c->prio);
 121                                 found=TRUE;
 122                                 c->ref_count++;
 123                                 break;
 124                         }
 125                 }
 126
 127                 if(!found) {
 128                         /* If not found, add it to the destination array */
 129                         while(j < h->len) {
 130                                 c = &g_array_index(h, LttvHookClosure, j);
 131                                 if(new_c->prio < c->prio) {
 132                                         g_array_insert_val(h,j,*new_c);
 133                                         j++;
 134                                         break;
 135                                 }
 136                                 else j++;
 137                         }
 138                         if(j == h->len) {
 139                                 g_array_append_val(h,*new_c);
 140                                 j++;
 141                         }
 142                 }
 143         }
 144 }
 145
 146
 147 void *lttv_hooks_remove(LttvHooks *h, LttvHook f)
 148 {
 149         unsigned i;
 150
 151         void *hook_data;
 152
 153         LttvHookClosure *c;
 154
 155         for(i = 0 ; i < h->len ; i++) {
 156                 c = &g_array_index(h, LttvHookClosure, i);
 157                 if(c->hook == f) {
 158                         if(c->ref_count == 1) {
 159                                 hook_data = c->hook_data;
 160                                 lttv_hooks_remove_by_position(h, i);
 161                                 return hook_data;
 162                         } else {
 163                                 g_assert(c->ref_count != 0);
 164                                 c->ref_count--;
 165                                 return NULL;  /* We do not want anyone to free a hook_data
 166                                                                  still referenced */
 167                         }
 168                 }
 169         }
 170         return NULL;
 171 }
 172
 173
 174 void lttv_hooks_remove_data(LttvHooks *h, LttvHook f, void *hook_data)
 175 {
 176         unsigned i;
 177
 178         LttvHookClosure *c;
 179
 180         for(i = 0 ; i < h->len ; i++) {
 181                 c = &g_array_index(h, LttvHookClosure, i);
 182                 if(c->hook == f && c->hook_data == hook_data) {
 183                         if(c->ref_count == 1) {
 184                                 lttv_hooks_remove_by_position(h, i);
 185                                 return;
 186                         } else {
 187                                 g_assert(c->ref_count != 0);
 188                                 c->ref_count--;
 189                                 return;
 190                         }
 191                 }
 192         }
 193 }
 194
 195
 196 void lttv_hooks_remove_list(LttvHooks *h, const LttvHooks *list)
 197 {
 198         guint i, j;
 199
 200         LttvHookClosure *c, *c_list;
 201
 202         if(list == NULL) return;
 203         g_assert(h != list);
 204         /* This iteration assume that both list are in the same order */
 205         for(i = 0, j = 0 ; i < h->len && j < list->len ;) {
 206                 c = &g_array_index(h, LttvHookClosure, i);
 207                 c_list = &g_array_index(list, LttvHookClosure, j);
 208                 if(c->hook == c_list->hook && c->hook_data == c_list->hook_data) {
 209                         if(c->ref_count == 1) {
 210                                 int count = h->len;
 211                                 lttv_hooks_remove_by_position(h, i);
 212                                 g_assert((count-1) == h->len);
 213                         } else {
 214                                 g_assert(c->ref_count != 0);
 215                                 c->ref_count--;
 216                         }
 217                         j++;
 218                 }
 219                 else i++;
 220         }
 221
 222         /* Normally the hooks in h are ordered as in list. If this is not the case,
 223            try harder here. */
 224
 225         if(unlikely(j < list->len)) {
 226                 for(; j < list->len ; j++) {
 227                         c_list = &g_array_index(list, LttvHookClosure, j);
 228                         lttv_hooks_remove_data(h, c_list->hook, c_list->hook_data);
 229                 }
 230         }
 231 }
 232
 233
 234 unsigned lttv_hooks_number(LttvHooks *h)
 235 {
 236         return h->len;
 237 }
 238
 239
 240 void lttv_hooks_get(LttvHooks *h, unsigned i, LttvHook *f, void **hook_data,
 241                 LttvHookPrio *p)
 242 {
 243         LttvHookClosure *c;
 244
 245         if(unlikely(i >= h->len))
 246         {
 247                 *f = NULL;
 248                 *hook_data = NULL;
 249                 *p = 0;
 250                 return;
 251         }
 252
 253         c = &g_array_index(h, LttvHookClosure, i);
 254         *f = c->hook;
 255         *hook_data = c->hook_data;
 256         *p = c->prio;
 257 }
 258
 259
 260 void lttv_hooks_remove_by_position(LttvHooks *h, unsigned i)
 261 {
 262         g_array_remove_index(h, i);
 263 }
 264
 265 gboolean lttv_hooks_call(LttvHooks *h, void *call_data)
 266 {
 267         gboolean ret, sum_ret = FALSE;
 268
 269         LttvHookClosure *c;
 270
 271         guint i;
 272
 273         if(likely(h != NULL)) {
 274                 for(i = 0 ; i < h->len ; i++) {
 275                         c = &g_array_index(h, LttvHookClosure, i);
 276                         ret = c->hook(c->hook_data,call_data);
 277                         sum_ret = sum_ret || ret;
 278                 }
 279         }
 280         return sum_ret;
 281 }
 282
 283
 284 gboolean lttv_hooks_call_check(LttvHooks *h, void *call_data)
 285 {
 286         LttvHookClosure *c;
 287
 288         guint i;
 289
 290         for(i = 0 ; i < h->len ; i++) {
 291                 c = &g_array_index(h, LttvHookClosure, i);
 292                 if(unlikely(c->hook(c->hook_data,call_data))) return TRUE;
 293         }
 294         return FALSE;
 295 }
 296
 297 /* Optimised for h1 == NULL, h2 != NULL. This is the case
 298  * for optimised computation (with specific by id hooks, but
 299  * no main hooks).
 300  *
 301  * The second case that should occur the most often is
 302  * h1 != NULL , h2 == NULL.
 303  */
 304 gint lttv_hooks_call_merge(LttvHooks *h1, void *call_data1,
 305                 LttvHooks *h2, void *call_data2)
 306 {
 307         gint ret, sum_ret = 0;
 308
 309         LttvHookClosure *c1, *c2;
 310
 311         guint i, j;
 312
 313         if(unlikely(h1 != NULL)) {
 314                 if(unlikely(h2 != NULL)) {
 315                         for(i = 0, j = 0 ; i < h1->len && j < h2->len ;) {
 316                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 317                                 c2 = &g_array_index(h2, LttvHookClosure, j);
 318                                 if(c1->prio <= c2->prio) {
 319                                         ret = c1->hook(c1->hook_data,call_data1);
 320                                         sum_ret = sum_ret | ret;
 321                                         i++;
 322                                 } else {
 323                                         ret = c2->hook(c2->hook_data,call_data2);
 324                                         sum_ret = sum_ret | ret;
 325                                         j++;
 326                                 }
 327                         }
 328                         /* Finish the last list with hooks left */
 329                         for(;i < h1->len; i++) {
 330                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 331                                 ret = c1->hook(c1->hook_data,call_data1);
 332                                 sum_ret = sum_ret | ret;
 333                         }
 334                         for(;j < h2->len; j++) {
 335                                 c2 = &g_array_index(h2, LttvHookClosure, j);
 336                                 ret = c2->hook(c2->hook_data,call_data2);
 337                                 sum_ret = sum_ret | ret;
 338                         }
 339                 } else {  /* h1 != NULL && h2 == NULL */
 340                         for(i = 0 ; i < h1->len ; i++) {
 341                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 342                                 ret = c1->hook(c1->hook_data,call_data1);
 343                                 sum_ret = sum_ret | ret;
 344                         }
 345                 }
 346         } else if(likely(h2 != NULL)) { /* h1 == NULL && h2 != NULL */
 347                  for(j = 0 ; j < h2->len ; j++) {
 348                         c2 = &g_array_index(h2, LttvHookClosure, j);
 349                         ret = c2->hook(c2->hook_data,call_data2);
 350                         sum_ret = sum_ret | ret;
 351                 }
 352         }
 353
 354         return sum_ret;
 355 }
 356
 357 gboolean lttv_hooks_call_check_merge(LttvHooks *h1, void *call_data1,
 358                 LttvHooks *h2, void *call_data2)
 359 {
 360         LttvHookClosure *c1, *c2;
 361
 362         guint i, j;
 363
 364         if(unlikely(h1 != NULL)) {
 365                 if(unlikely(h2 != NULL)) {
 366                         for(i = 0, j = 0 ; i < h1->len && j < h2->len ;) {
 367                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 368                                 c2 = &g_array_index(h2, LttvHookClosure, j);
 369                                 if(c1->prio <= c2->prio) {
 370                                         if(c1->hook(c1->hook_data,call_data1)) return TRUE;
 371                                         i++;
 372                                 } else {
 373                                         if(c2->hook(c2->hook_data,call_data2)) return TRUE;
 374                                         j++;
 375                                 }
 376                         }
 377                         /* Finish the last list with hooks left */
 378                         for(;i < h1->len; i++) {
 379                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 380                                 if(c1->hook(c1->hook_data,call_data1)) return TRUE;
 381                         }
 382                         for(;j < h2->len; j++) {
 383                                 c2 = &g_array_index(h2, LttvHookClosure, j);
 384                                 if(c2->hook(c2->hook_data,call_data2)) return TRUE;
 385                         }
 386                 } else { /* h2 == NULL && h1 != NULL */
 387                         for(i = 0 ; i < h1->len ; i++) {
 388                                 c1 = &g_array_index(h1, LttvHookClosure, i);
 389                                 if(c1->hook(c1->hook_data,call_data1)) return TRUE;
 390                         }
 391                 }
 392         } else if(likely(h2 != NULL)) { /* h1 == NULL && h2 != NULL */
 393                 for(j = 0 ; j < h2->len ; j++) {
 394                         c2 = &g_array_index(h2, LttvHookClosure, j);
 395                         if(c2->hook(c2->hook_data,call_data2)) return TRUE;
 396                 }
 397         }
 398
 399         return FALSE;
 400 }
 401
 402
 403 void lttv_hooks_print(const LttvHooks *h)
 404 {
 405         gboolean ret, sum_ret = FALSE;
 406
 407         LttvHookClosure *c;
 408
 409         guint i;
 410
 411         if(likely(h != NULL)) {
 412                 for(i = 0 ; i < h->len ; i++) {
 413                         c = &g_array_index(h, LttvHookClosure, i);
 414                         printf("%p:%i:%i,", c->hook, c->ref_count, c->prio);
 415                 }
 416                 printf("\n");
 417         }
 418
 419 }