gst/debugutils/efence.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 1999-2001 Erik Walthinsen <omega@cse.ogi.edu>
   4  * Copyright (C) 2002 David A. Schleef <ds@schleef.org>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25 #include <gst/gst.h>
  26
  27 #include <string.h>
  28 #include <unistd.h>
  29 #include <sys/mman.h>
  30
  31 #include "efence.h"
  32
  33 #ifndef MAP_ANONYMOUS
  34 #ifdef MAP_ANON
  35 #define MAP_ANONYMOUS MAP_ANON
  36 #else
  37 /* assume we don't need it */
  38 #define MAP_ANONYMOUS 0
  39 #endif
  40 #endif
  41
  42 GST_DEBUG_CATEGORY_STATIC (gst_efence_debug);
  43 #define GST_CAT_DEFAULT  gst_efence_debug
  44
  45 /* Filter signals and args */
  46 enum
  47 {
  48   /* FILL ME */
  49   LAST_SIGNAL
  50 };
  51
  52 enum
  53 {
  54   ARG_0,
  55   ARG_FENCE_TOP
  56 };
  57
  58 static GstStaticPadTemplate gst_efence_sink_factory =
  59 GST_STATIC_PAD_TEMPLATE ("sink",
  60     GST_PAD_SINK,
  61     GST_PAD_ALWAYS,
  62     GST_STATIC_CAPS_ANY);
  63
  64 static GstStaticPadTemplate gst_efence_src_factory =
  65 GST_STATIC_PAD_TEMPLATE ("src",
  66     GST_PAD_SRC,
  67     GST_PAD_ALWAYS,
  68     GST_STATIC_CAPS_ANY);
  69
  70 static void gst_efence_base_init (gpointer g_class);
  71 static void gst_efence_class_init (GstEFenceClass * klass);
  72 static void gst_efence_init (GstEFence * filter);
  73
  74 static void gst_efence_set_property (GObject * object, guint prop_id,
  75     const GValue * value, GParamSpec * pspec);
  76 static void gst_efence_get_property (GObject * object, guint prop_id,
  77     GValue * value, GParamSpec * pspec);
  78
  79 static GstFlowReturn gst_efence_chain (GstPad * pad, GstBuffer * buf);
  80 static GstFlowReturn gst_efence_getrange (GstPad * pad, guint64 offset,
  81     guint length, GstBuffer ** buffer);
  82 static gboolean gst_efence_checkgetrange (GstPad * pad);
  83 static gboolean gst_efence_activate_src_pull (GstPad * pad, gboolean active);
  84
  85 static GstElementClass *parent_class = NULL;
  86
  87 typedef struct _GstFencedBuffer GstFencedBuffer;
  88 struct _GstFencedBuffer
  89 {
  90   GstBuffer buffer;
  91   void *region;
  92   unsigned int length;
  93 };
  94
  95 GType gst_fenced_buffer_get_type (void);
  96 static void gst_fenced_buffer_finalize (GstFencedBuffer * buf);
  97 static GstFencedBuffer *gst_fenced_buffer_copy (const GstBuffer * buffer);
  98 static void *gst_fenced_buffer_alloc (GstBuffer * buffer, unsigned int length,
  99     gboolean fence_top);
 100 static GstFlowReturn gst_efence_buffer_alloc (GstPad * pad, guint64 offset,
 101     guint size, GstCaps * caps, GstBuffer ** buf);
 102
 103 #define GST_TYPE_FENCED_BUFFER (gst_fenced_buffer_get_type())
 104
 105 #define GST_IS_FENCED_BUFFER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_FENCED_BUFFER))
 106 #define GST_FENCED_BUFFER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_FENCED_BUFFER, GstFencedBuffer))
 107
 108 GType
 109 gst_gst_efence_get_type (void)
 110 {
 111   static GType plugin_type = 0;
 112
 113   if (!plugin_type) {
 114     static const GTypeInfo plugin_info = {
 115       sizeof (GstEFenceClass),
 116       gst_efence_base_init,
 117       NULL,
 118       (GClassInitFunc) gst_efence_class_init,
 119       NULL,
 120       NULL,
 121       sizeof (GstEFence),
 122       0,
 123       (GInstanceInitFunc) gst_efence_init,
 124     };
 125
 126     plugin_type = g_type_register_static (GST_TYPE_ELEMENT,
 127         "GstEFence", &plugin_info, 0);
 128   }
 129   return plugin_type;
 130 }
 131
 132 static void
 133 gst_efence_base_init (gpointer g_class)
 134 {
 135   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 136
 137   gst_element_class_add_pad_template (element_class,
 138       gst_static_pad_template_get (&gst_efence_sink_factory));
 139   gst_element_class_add_pad_template (element_class,
 140       gst_static_pad_template_get (&gst_efence_src_factory));
 141   gst_element_class_set_details_simple (element_class, "Electric Fence",
 142       "Testing",
 143       "This element converts a stream of normal GStreamer buffers into a "
 144       "stream of buffers that are allocated in such a way that out-of-bounds "
 145       "access to data in the buffer is more likely to cause segmentation "
 146       "faults.  This allocation method is very similar to the debugging tool "
 147       "\"Electric Fence\".", "David A. Schleef <ds@schleef.org>");
 148 }
 149
 150 /* initialize the plugin's class */
 151 static void
 152 gst_efence_class_init (GstEFenceClass * klass)
 153 {
 154   GObjectClass *gobject_class;
 155
 156   gobject_class = (GObjectClass *) klass;
 157
 158   parent_class = g_type_class_peek_parent (klass);
 159
 160   gobject_class->set_property = gst_efence_set_property;
 161   gobject_class->get_property = gst_efence_get_property;
 162
 163   g_object_class_install_property (gobject_class, ARG_FENCE_TOP,
 164       g_param_spec_boolean ("fence-top", "Fence Top",
 165           "Align buffers with top of fenced region", TRUE, G_PARAM_READWRITE));
 166 }
 167
 168 /* initialize the new element
 169  * instantiate pads and add them to element
 170  * set functions
 171  * initialize structure
 172  */
 173 static void
 174 gst_efence_init (GstEFence * filter)
 175 {
 176   filter->sinkpad =
 177       gst_pad_new_from_static_template (&gst_efence_sink_factory, "sink");
 178   gst_pad_set_getcaps_function (filter->sinkpad,
 179       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 180   gst_pad_set_setcaps_function (filter->sinkpad,
 181       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 182   gst_pad_set_chain_function (filter->sinkpad,
 183       GST_DEBUG_FUNCPTR (gst_efence_chain));
 184   gst_pad_set_bufferalloc_function (filter->sinkpad,
 185       GST_DEBUG_FUNCPTR (gst_efence_buffer_alloc));
 186   gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
 187
 188   filter->srcpad =
 189       gst_pad_new_from_static_template (&gst_efence_src_factory, "src");
 190   gst_pad_set_getcaps_function (filter->srcpad,
 191       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 192   gst_pad_set_setcaps_function (filter->srcpad,
 193       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 194   gst_pad_set_checkgetrange_function (filter->srcpad,
 195       GST_DEBUG_FUNCPTR (gst_efence_checkgetrange));
 196   gst_pad_set_getrange_function (filter->srcpad,
 197       GST_DEBUG_FUNCPTR (gst_efence_getrange));
 198   gst_pad_set_activatepull_function (filter->srcpad,
 199       GST_DEBUG_FUNCPTR (gst_efence_activate_src_pull));
 200
 201   gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
 202
 203   filter->fence_top = TRUE;
 204 }
 205
 206 /* chain function
 207  * this function does the actual processing
 208  */
 209
 210 static GstFlowReturn
 211 gst_efence_chain (GstPad * pad, GstBuffer * buffer)
 212 {
 213   GstEFence *efence;
 214   GstBuffer *copy;
 215
 216   efence = GST_EFENCE (GST_OBJECT_PARENT (pad));
 217   g_return_val_if_fail (GST_IS_EFENCE (efence), GST_FLOW_ERROR);
 218
 219   if (GST_IS_FENCED_BUFFER (buffer)) {
 220     GST_DEBUG_OBJECT (efence, "Passing on existing fenced buffer with caps %"
 221         GST_PTR_FORMAT, GST_BUFFER_CAPS (buffer));
 222     return gst_pad_push (efence->srcpad, buffer);
 223   }
 224
 225   copy = (GstBuffer *) gst_fenced_buffer_copy (buffer);
 226
 227   GST_DEBUG_OBJECT (efence, "Pushing newly fenced buffer with caps %"
 228       GST_PTR_FORMAT ", data=%p, size=%u", GST_BUFFER_CAPS (copy),
 229       GST_BUFFER_DATA (copy), GST_BUFFER_SIZE (copy));
 230
 231   gst_buffer_unref (buffer);
 232
 233   return gst_pad_push (efence->srcpad, copy);
 234 }
 235
 236 static GstFlowReturn
 237 gst_efence_getrange (GstPad * pad, guint64 offset,
 238     guint length, GstBuffer ** buffer)
 239 {
 240   GstEFence *efence;
 241   GstFlowReturn ret;
 242   GstBuffer *ownbuf;
 243   GstPad *peer;
 244
 245   efence = GST_EFENCE (GST_OBJECT_PARENT (pad));
 246
 247   peer = gst_pad_get_peer (efence->sinkpad);
 248   if (!peer)
 249     return GST_FLOW_NOT_LINKED;
 250
 251   if ((ret = gst_pad_get_range (peer, offset, length, buffer)) != GST_FLOW_OK)
 252     goto beach;
 253
 254   ownbuf = (GstBuffer *) gst_fenced_buffer_copy (*buffer);
 255   gst_buffer_unref ((GstBuffer *) * buffer);
 256   *buffer = ownbuf;
 257
 258 beach:
 259   gst_object_unref (peer);
 260   return ret;
 261 }
 262
 263 static gboolean
 264 gst_efence_checkgetrange (GstPad * pad)
 265 {
 266   GstEFence *efence = GST_EFENCE (GST_OBJECT_PARENT (pad));
 267
 268   return gst_pad_check_pull_range (efence->sinkpad);
 269 }
 270
 271 static gboolean
 272 gst_efence_activate_src_pull (GstPad * pad, gboolean active)
 273 {
 274   GstEFence *efence = GST_EFENCE (GST_OBJECT_PARENT (pad));
 275
 276   return gst_pad_activate_pull (efence->sinkpad, active);
 277 }
 278
 279 static GstFlowReturn
 280 gst_efence_buffer_alloc (GstPad * pad, guint64 offset,
 281     guint size, GstCaps * caps, GstBuffer ** buf)
 282 {
 283   GstBuffer *buffer;
 284   GstEFence *efence;
 285
 286   g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
 287   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
 288
 289   efence = GST_EFENCE (GST_OBJECT_PARENT (pad));
 290
 291   buffer = (GstBuffer *) gst_mini_object_new (GST_TYPE_FENCED_BUFFER);
 292
 293   GST_BUFFER_DATA (buffer) = gst_fenced_buffer_alloc (buffer, size,
 294       efence->fence_top);
 295   GST_BUFFER_SIZE (buffer) = size;
 296   GST_BUFFER_OFFSET (buffer) = offset;
 297
 298   if (caps)
 299     gst_buffer_set_caps (buffer, caps);
 300
 301   *buf = buffer;
 302
 303   GST_DEBUG_OBJECT (efence, "Allocated buffer of size %u, caps: %"
 304       GST_PTR_FORMAT, GST_BUFFER_SIZE (buffer), GST_BUFFER_CAPS (buffer));
 305
 306   return GST_FLOW_OK;
 307 }
 308
 309 static void
 310 gst_efence_set_property (GObject * object, guint prop_id,
 311     const GValue * value, GParamSpec * pspec)
 312 {
 313   GstEFence *filter;
 314
 315   g_return_if_fail (GST_IS_EFENCE (object));
 316   filter = GST_EFENCE (object);
 317
 318   switch (prop_id) {
 319     case ARG_FENCE_TOP:
 320       filter->fence_top = g_value_get_boolean (value);
 321       break;
 322     default:
 323       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 324       break;
 325   }
 326 }
 327
 328 static void
 329 gst_efence_get_property (GObject * object, guint prop_id,
 330     GValue * value, GParamSpec * pspec)
 331 {
 332   GstEFence *filter;
 333
 334   g_return_if_fail (GST_IS_EFENCE (object));
 335   filter = GST_EFENCE (object);
 336
 337   switch (prop_id) {
 338     case ARG_FENCE_TOP:
 339       g_value_set_boolean (value, filter->fence_top);
 340       break;
 341     default:
 342       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 343       break;
 344   }
 345 }
 346
 347 /* entry point to initialize the plug-in
 348  * initialize the plug-in itself
 349  * register the element factories and pad templates
 350  * register the features
 351  */
 352 static gboolean
 353 plugin_init (GstPlugin * plugin)
 354 {
 355   if (!gst_element_register (plugin, "efence", GST_RANK_NONE, GST_TYPE_EFENCE))
 356     return FALSE;
 357
 358   GST_DEBUG_CATEGORY_INIT (gst_efence_debug, "efence", 0,
 359       "Debug output from the efence element");
 360
 361   /* plugin initialisation succeeded */
 362   return TRUE;
 363 }
 364
 365 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 366     GST_VERSION_MINOR,
 367     "efence",
 368     "This element converts a stream of normal GStreamer buffers into a "
 369     "stream of buffers that are allocated in such a way that out-of-bounds "
 370     "access to data in the buffer is more likely to cause segmentation "
 371     "faults.  This allocation method is very similar to the debugging tool "
 372     "\"Electric Fence\".",
 373     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
 374
 375
 376 static GstBufferClass *fenced_buffer_parent_class = NULL;
 377
 378 static void
 379 gst_fenced_buffer_finalize (GstFencedBuffer * buffer)
 380 {
 381   GstFencedBuffer *fenced_buffer;
 382
 383   GST_DEBUG ("free buffer=%p", buffer);
 384
 385   fenced_buffer = GST_FENCED_BUFFER (buffer);
 386
 387   /* free our data */
 388   if (GST_BUFFER_DATA (buffer)) {
 389     GST_DEBUG ("free region %p %d", fenced_buffer->region,
 390         fenced_buffer->length);
 391     munmap (fenced_buffer->region, fenced_buffer->length);
 392   }
 393
 394   GST_MINI_OBJECT_CLASS (fenced_buffer_parent_class)->finalize (GST_MINI_OBJECT
 395       (buffer));
 396 }
 397
 398 static GstFencedBuffer *
 399 gst_fenced_buffer_copy (const GstBuffer * buffer)
 400 {
 401   GstBuffer *copy;
 402   void *ptr;
 403   guint mask;
 404
 405   g_return_val_if_fail (buffer != NULL, NULL);
 406
 407   /* create a fresh new buffer */
 408   copy = (GstBuffer *) gst_mini_object_new (GST_TYPE_FENCED_BUFFER);
 409
 410   /* we simply copy everything from our parent */
 411   ptr = gst_fenced_buffer_alloc (GST_BUFFER (copy),
 412       GST_BUFFER_SIZE (buffer), TRUE);
 413   memcpy (ptr, GST_BUFFER_DATA (buffer), GST_BUFFER_SIZE (buffer));
 414
 415   /* copy relevant flags */
 416   mask = GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_IN_CAPS |
 417       GST_BUFFER_FLAG_DELTA_UNIT;
 418   GST_MINI_OBJECT (copy)->flags |= GST_MINI_OBJECT (buffer)->flags & mask;
 419
 420   GST_BUFFER_DATA (copy) = ptr;
 421   GST_BUFFER_SIZE (copy) = GST_BUFFER_SIZE (buffer);
 422   GST_BUFFER_TIMESTAMP (copy) = GST_BUFFER_TIMESTAMP (buffer);
 423   GST_BUFFER_DURATION (copy) = GST_BUFFER_DURATION (buffer);
 424   GST_BUFFER_OFFSET (copy) = GST_BUFFER_OFFSET (buffer);
 425   GST_BUFFER_OFFSET_END (copy) = GST_BUFFER_OFFSET_END (buffer);
 426
 427   if (GST_BUFFER_CAPS (buffer))
 428     GST_BUFFER_CAPS (copy) = gst_caps_ref (GST_BUFFER_CAPS (buffer));
 429   else
 430     GST_BUFFER_CAPS (copy) = NULL;
 431
 432   GST_DEBUG ("Copied buffer %p with ts %" GST_TIME_FORMAT
 433       ", caps: %" GST_PTR_FORMAT, buffer,
 434       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (copy)), GST_BUFFER_CAPS (copy));
 435
 436   return GST_FENCED_BUFFER (copy);
 437 }
 438
 439 void *
 440 gst_fenced_buffer_alloc (GstBuffer * buffer, unsigned int length,
 441     gboolean fence_top)
 442 {
 443   int alloc_size;
 444   void *region;
 445   GstFencedBuffer *fenced_buffer = (GstFencedBuffer *) buffer;
 446   int page_size;
 447
 448   GST_DEBUG ("buffer=%p length=%d fence_top=%d", buffer, length, fence_top);
 449
 450   if (length == 0)
 451     return NULL;
 452
 453 #ifdef _SC_PAGESIZE
 454   page_size = sysconf (_SC_PAGESIZE);
 455 #else
 456   page_size = getpagesize ();
 457 #endif
 458
 459   /* Allocate a complete page, and one on either side */
 460   alloc_size = ((length - 1) & ~(page_size - 1)) + page_size;
 461   alloc_size += 2 * page_size;
 462
 463   region = mmap (NULL, alloc_size, PROT_READ | PROT_WRITE,
 464       MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
 465   if (region == MAP_FAILED) {
 466     g_warning ("mmap failed");
 467     return NULL;
 468   }
 469 #if 0
 470   munmap (region, page_size);
 471   munmap (region + alloc_size - page_size, page_size);
 472
 473   fenced_buffer->region = region + page_size;
 474   fenced_buffer->length = alloc_size - page_size;
 475 #else
 476   mprotect (region, page_size, PROT_NONE);
 477   mprotect ((char *) region + alloc_size - page_size, page_size, PROT_NONE);
 478
 479   fenced_buffer->region = region;
 480   fenced_buffer->length = alloc_size;
 481 #endif
 482
 483   GST_DEBUG ("new region %p %d", fenced_buffer->region, fenced_buffer->length);
 484
 485   if (fence_top) {
 486     int offset;
 487
 488     /* Align to top of region, but force alignment to 4 bytes */
 489     offset = alloc_size - page_size - length;
 490     offset &= ~0x3;
 491     return (void *) ((char *) region + offset);
 492   } else {
 493     return (void *) ((char *) region + page_size);
 494   }
 495 }
 496
 497 static void
 498 gst_fenced_buffer_class_init (gpointer g_class, gpointer class_data)
 499 {
 500   GstMiniObjectClass *mini_object_class = GST_MINI_OBJECT_CLASS (g_class);
 501
 502   fenced_buffer_parent_class = g_type_class_peek_parent (g_class);
 503
 504   mini_object_class->finalize =
 505       (GstMiniObjectFinalizeFunction) gst_fenced_buffer_finalize;
 506   mini_object_class->copy = (GstMiniObjectCopyFunction) gst_fenced_buffer_copy;
 507 }
 508
 509 GType
 510 gst_fenced_buffer_get_type (void)
 511 {
 512   static GType fenced_buf_type = 0;
 513
 514   if (G_UNLIKELY (!fenced_buf_type)) {
 515     static const GTypeInfo fenced_buf_info = {
 516       sizeof (GstBufferClass),
 517       NULL,
 518       NULL,
 519       (GClassInitFunc) gst_fenced_buffer_class_init,
 520       NULL,
 521       NULL,
 522       sizeof (GstFencedBuffer),
 523       0,
 524       NULL,
 525     };
 526
 527     fenced_buf_type = g_type_register_static (GST_TYPE_BUFFER,
 528         "GstFencedBuffer", &fenced_buf_info, 0);
 529   }
 530   return fenced_buf_type;
 531 }