data_lump.c

Go to the documentation of this file.

/* $Id: data_lump.c 5772 2009-03-30 13:28:11Z miconda $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * Kamailio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2003-01-19  support for duplication lump lists added (jiri)
 *  2003-03-31  added subst lumps --they expand in ip addr, port a.s.o (andrei)
 *  2003-04-01  added conditional lump support functions (andrei)
 *  2003-10-20  anchor_lump & del_lump will automatically choose the lump list
 *              based on  msg->eoh comparisons (andrei)
 *  2003-10-28  added extra checks (paranoia) for {anchor,del}_lump (andrei)
 *  2005-08-22  added init_lump_flags -initial flags- for all built lumps
 *              (bogdan)
 *  2005-08-23  del_nonshm_lump() -> del_flaged_lumps(LUMPFLAG_SHMEM) (bogdan)
 */

/*!
 * \file data_lump.c
 * \brief Kamailio Lump (internal message manipulation) functions
 */


#include "data_lump.h"
#include "dprint.h"
#include "mem/mem.h"
#include "globals.h"
#include "error.h"

#include <stdlib.h>
#include <string.h>

#ifdef DEBUG_DMALLOC
#include <dmalloc.h>
#endif

/*! \note WARNING: all lump add/insert operations expect a pkg_malloc'ed char* 
 * pointer the will be DEALLOCATED when the sip_msg is destroyed! */

enum lump_dir { LD_NEXT, LD_BEFORE, LD_AFTER };

int init_lump_flags = 0;

/*! \brief adds a header to the end
 * \return returns  pointer on success, 0 on error */
struct lump* append_new_lump(struct lump** list, char* new_hdr,
                     unsigned int len, enum _hdr_types_t type)
{
   struct lump** t;
   struct lump* tmp;
   
   for (t=list;*t;t=&((*t)->next));

   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      LM_ERR("out of pkg memory\n");
      return 0;
   }
      
   memset(tmp,0,sizeof(struct lump));
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD;
   tmp->u.value=new_hdr;
   tmp->len=len;
   *t=tmp;
   return tmp;
}



/*! \brief inserts a header to the beginning 
 *  \return returns pointer if success, 0 on error */
struct lump* insert_new_lump(struct lump** list, char* new_hdr,
                        unsigned int len, enum _hdr_types_t type)
{
   struct lump* tmp;

   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->next=*list;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD;
   tmp->u.value=new_hdr;
   tmp->len=len;
   *list=tmp;
   return tmp;
}



/*! \brief inserts a  header/data lump immediately after hdr 
 * \return returns pointer on success, 0 on error */
struct lump* insert_new_lump_after( struct lump* after, char* new_hdr,
                     unsigned int len, enum _hdr_types_t type)
{
   struct lump* tmp;

   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->after=after->after;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD;
   tmp->u.value=new_hdr;
   tmp->len=len;
   after->after=tmp;
   return tmp;
}



/*! \brief inserts a  header/data lump immediately before "before" 
 * \return returns pointer on success, 0 on error */
struct lump* insert_new_lump_before( struct lump* before, char* new_hdr,
                     unsigned int len, enum _hdr_types_t type)
{
   struct lump* tmp;

   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->before=before->before;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD;
   tmp->u.value=new_hdr;
   tmp->len=len;
   before->before=tmp;
   return tmp;
}



/*! \brief inserts a  subst lump immediately after hdr 
 * \return returns pointer on success, 0 on error */
struct lump* insert_subst_lump_after( struct lump* after,enum lump_subst subst,
                              enum _hdr_types_t type)
{
   struct lump* tmp;
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->after=after->after;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD_SUBST;
   tmp->u.subst=subst;
   tmp->len=0;
   after->after=tmp;
   return tmp;
}



/*! \brief inserts a  subst lump immediately before "before" 
 * \return returns pointer on success, 0 on error */
struct lump* insert_subst_lump_before( struct lump* before, 
                              enum lump_subst subst,
                              enum _hdr_types_t type)
{
   struct lump* tmp;
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->before=before->before;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD_SUBST;
   tmp->u.subst=subst;
   tmp->len=0;
   before->before=tmp;
   return tmp;
}



/*! \brief inserts a  cond lump immediately after hdr 
 * \return returns pointer on success, 0 on error */
struct lump* insert_cond_lump_after( struct lump* after,enum lump_conditions c,
                              enum _hdr_types_t type)
{
   struct lump* tmp;
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->after=after->after;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD_OPT;
   tmp->u.cond=c;
   tmp->len=0;
   after->after=tmp;
   return tmp;
}



/*! \brief inserts a  conditional lump immediately before "before" 
 * \return returns pointer on success, 0 on error */
struct lump* insert_cond_lump_before(  struct lump* before, 
                              enum lump_conditions c,
                              enum _hdr_types_t type)
{
   struct lump* tmp;
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->before=before->before;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->op=LUMP_ADD_OPT;
   tmp->u.cond=c;
   tmp->len=0;
   before->before=tmp;
   return tmp;
}



/*! \brief removes an already existing header/data lump */
/* WARNING: this function adds the lump either to the msg->add_rm or
 * msg->body_lumps list, depending on the offset being greater than msg->eoh,
 * so msg->eoh must be parsed (parse with HDR_EOH) if you think your lump
 *  might affect the body!! */
struct lump* del_lump(struct sip_msg* msg, unsigned int offset,
      unsigned int len, enum _hdr_types_t type)
{
   struct lump* tmp;
   struct lump* prev, *t;
   struct lump** list;

   /* extra checks */
   if (offset>msg->len){
      LM_CRIT("offset exceeds message size (%d > %d)"
               " aborting...\n", offset, msg->len);
      abort();
   }
   if (offset+len>msg->len){
      LM_CRIT("offset + len exceeds message"
            " size (%d + %d > %d)\n", offset, len,  msg->len);
      abort();
   }
   if (len==0){
      LM_WARN("called with 0 len (offset =%d)\n",  offset);
   }
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->op=LUMP_DEL;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->u.offset=offset;
   tmp->len=len;
   prev=0;
   /* check to see whether this might be a body lump */
   if ((msg->eoh) && (offset>(unsigned long)(msg->eoh-msg->buf)))
      list=&msg->body_lumps;
   else
      list=&msg->add_rm;
   for (t=*list;t; prev=t, t=t->next){
      /* insert it sorted after offset */
      if (((t->op==LUMP_DEL)||(t->op==LUMP_NOP))&&(t->u.offset>offset))
         break;
   }
   tmp->next=t;
   if (prev) prev->next=tmp;
   else *list=tmp;
   return tmp;
}



/*! \brief add an anchor
 * WARNING: this function adds the lump either to the msg->add_rm or
 * msg->body_lumps list, depending on the offset being greater than msg->eoh,
 * so msg->eoh must be parsed (parse with HDR_EOH) if you think your lump
 *  might affect the body!! */
struct lump* anchor_lump(struct sip_msg* msg, unsigned int offset,
      int unsigned len, enum _hdr_types_t type)
{
   struct lump* tmp;
   struct lump* prev, *t;
   struct lump** list;

   
   /* extra checks */
   if (offset>msg->len){
      LM_ERR("offset exceeds message size (%d > %d)...\n",
            offset, msg->len);
      return 0;
   }
   if (len){
      LM_WARN("called with len !=0 (%d)\n", len);
      if (offset+len>msg->len)
         LM_WARN("offset + len exceeds message"
               " size (%d + %d > %d)\n", offset, len,  msg->len);
   }
   
   tmp=pkg_malloc(sizeof(struct lump));
   if (tmp==0){
      ser_error=E_OUT_OF_MEM;
      LM_ERR("out of pkg memory\n");
      return 0;
   }
   memset(tmp,0,sizeof(struct lump));
   tmp->op=LUMP_NOP;
   tmp->type=type;
   tmp->flags=init_lump_flags;
   tmp->u.offset=offset;
   tmp->len=len;
   prev=0;
   /* check to see whether this might be a body lump */
   if ((msg->eoh) && (offset> (unsigned long)(msg->eoh-msg->buf)))
      list=&msg->body_lumps;
   else
      list=&msg->add_rm;
      
   for (t=*list;t; prev=t, t=t->next){
      /* insert it sorted after offset */
      if (((t->op==LUMP_DEL)||(t->op==LUMP_NOP))&&(t->u.offset>offset))
         break;
   }
   tmp->next=t;
   
   if (prev) prev->next=tmp;
   else *list=tmp;
   return tmp;
}



void free_lump(struct lump* lmp)
{
   if (lmp && (lmp->op==LUMP_ADD)){
      if (lmp->u.value){
         if (lmp->flags &(LUMPFLAG_DUPED|LUMPFLAG_SHMEM)){
            LM_CRIT("called on a not free-able lump:"
               "%p flags=%x\n", lmp, lmp->flags);
            abort();
         }else{
            pkg_free(lmp->u.value);
            lmp->u.value=0;
            lmp->len=0;
         }
      }
   }
}



void free_lump_list(struct lump* l)
{
   struct lump* t, *r, *foo,*crt;
   t=l;
   while(t){
      crt=t;
      t=t->next;

      r=crt->before;
      while(r){
         foo=r; r=r->before;
         free_lump(foo);
         pkg_free(foo);
      }
      r=crt->after;
      while(r){
         foo=r; r=r->after;
         free_lump(foo);
         pkg_free(foo);
      }
      
      /*clean current elem*/
      free_lump(crt);
      pkg_free(crt);
   }
}

/*! \brief free (shallow-ly) a lump and its after/before lists */
static void free_shallow_lump( struct lump *l )
{
   struct lump *r, *foo;

   r=l->before;
   while(r){
      foo=r; r=r->before;
      pkg_free(foo);
   }
   r=l->after;
   while(r){
      foo=r; r=r->after;
      pkg_free(foo);
   }
   pkg_free(l);
}

/*! \brief* duplicate (shallow-ly) a lump list into pkg memory */
static struct lump *dup_lump_list_r( struct lump *l, 
            enum lump_dir dir, int *error)
{
   int deep_error;
   struct lump *new_lump;

   deep_error=0; /* optimist: assume success in recursion */
   /* if at list end, terminate recursion successfully */
   if (!l) { *error=0; return 0; }
   /* otherwise duplicate current element */
   new_lump=pkg_malloc(sizeof(struct lump));
   if (!new_lump) { *error=1; return 0; }

   memcpy(new_lump, l, sizeof(struct lump));
   new_lump->flags=init_lump_flags|LUMPFLAG_DUPED;
   new_lump->next=new_lump->before=new_lump->after=0;

   switch(dir) {
      case LD_NEXT:  
            new_lump->before=dup_lump_list_r(l->before, 
                        LD_BEFORE, &deep_error);
            if (deep_error) goto deeperror;
            new_lump->after=dup_lump_list_r(l->after, 
                        LD_AFTER, &deep_error);
            if (deep_error) goto deeperror;
            new_lump->next=dup_lump_list_r(l->next, 
                        LD_NEXT, &deep_error);
            break;
      case LD_BEFORE:
            new_lump->before=dup_lump_list_r(l->before, 
                        LD_BEFORE, &deep_error);
            break;
      case LD_AFTER:
            new_lump->after=dup_lump_list_r(l->after, 
                        LD_AFTER, &deep_error);
            break;
      default:
            LM_CRIT("unknown dir: %d\n", dir );
            deep_error=1;
   }
   if (deep_error) goto deeperror;

   *error=0;
   return new_lump;

deeperror:
   LM_ERR("out of pkg mem\n");
   free_shallow_lump(new_lump);
   *error=1;
   return 0;
}



/*! \brief shallow pkg copy of a lump list
 *
 * \return if either original list empty or error occur returns, 0
 * is returned, pointer to the copy otherwise
 */
struct lump* dup_lump_list( struct lump *l )
{
   int deep_error;

   deep_error=0;
   return dup_lump_list_r(l, LD_NEXT, &deep_error);
}



/*! \brief Free duplicated lump list
 */
void free_duped_lump_list(struct lump* l)
{
   struct lump *r, *foo,*crt;
   while(l){
      crt=l;
      l=l->next;

      r=crt->before;
      while(r){
         foo=r; r=r->before;
         /* (+): if a new item was introduced to the shallow-ly
          * duped list, remove it completely, preserve it
          * otherwise (it is still referred by original list)
          */
         if (foo->flags!=LUMPFLAG_DUPED) 
               free_lump(foo);
         pkg_free(foo);
      }
      r=crt->after;
      while(r){
         foo=r; r=r->after;
         if (foo->flags!=LUMPFLAG_DUPED) /* (+) ... see above */
            free_lump(foo);
         pkg_free(foo);
      }
      
      /*clean current elem*/
      if (crt->flags!=LUMPFLAG_DUPED) /* (+) ... see above */
         free_lump(crt);
      pkg_free(crt);
   }
}


static inline int compare_flaged_lumps(const enum lump_flag flag1, const enum lump_flag flag2)
{
   return (flag1&flag2);
}


static inline int compare_not_flaged_lumps(const enum lump_flag flag1, const enum lump_flag flag2)
{
   return ((~flag1)&flag2);
}


/*!
 * \brief helper method for flagged lump deletion
 * \param lump_list list of lumps
 * \param flags flags for lumps that should be deleted
 * \param compare_lump_flags helper function that compares two lump flags
 */
static void del_flaged_lumps_helper(struct lump** lump_list,  const enum lump_flag flags,
         int (*compare_lump_flags) (const enum lump_flag flag1,
         const enum lump_flag flag2))
{
   struct lump *r, *foo, *crt, **prev, *prev_r;

   prev = lump_list;
   crt = *lump_list;

   while (crt) {
      if (compare_lump_flags(crt->flags, flags)) {
         /* unlink it */
         foo = crt;
         crt = crt->next;
         foo->next = 0;
         /* update the 'next' link of the previous lump */
         *prev = crt;
         /* entire before/after list must be removed */
         free_lump_list(foo);
      } else {
         /* check on before and prev list for flaged lumps */
         r = crt->after;
         prev_r = crt;
         while(r){
            foo=r; r=r->after;
            if (compare_lump_flags(foo->flags, flags)) {
               prev_r->after = r;
               free_lump(foo);
               pkg_free(foo);
            } else {
               prev_r = foo;
            }
         }
         /* before */
         r = crt->before;
         prev_r = crt;
         while(r){
            foo=r; r=r->before;
            if (compare_lump_flags(foo->flags, flags)) {
               prev_r->before = r;
               free_lump(foo);
               pkg_free(foo);
            } else {
               prev_r = foo;
            }
         }
         /* go to next lump */
         prev = &(crt->next);
         crt = crt->next;
      }
   }
}



/*!
 * \brief Delete flagged lumps
 * \param lump_list list of lumps
 * \param flags flags for lumps that should be deleted
 */
void del_flaged_lumps(struct lump** lump_list, const enum lump_flag flags)
{
   del_flaged_lumps_helper(lump_list, flags, compare_flaged_lumps);
}


/*!
 * \brief Delete not flagged lumps
 * \param lump_list list of lumps
 * \param not_flags flags for lumps that should not deleted
 */
void del_notflaged_lumps(struct lump** lump_list, const enum lump_flag not_flags)
{
   del_flaged_lumps_helper(lump_list, not_flags, compare_not_flaged_lumps);
}

---