XrdOucBuffer.hh

Go to the documentation of this file.

#ifndef __OUC_BUFF__
#define __OUC_BUFF__
/******************************************************************************/
/*                                                                            */
/*                       X r d O u c B u f f e r . h h                        */
/*                                                                            */
/* (c) 2013 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD 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 Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <cstdlib>
 
#include "XrdOuc/XrdOucChain.hh"
#include "XrdSys/XrdSysPthread.hh"
 
/******************************************************************************/
/*                        X r d O u c B u f f P o o l                         */
/******************************************************************************/
 
class XrdOucBuffer;
  
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdOucBuffPool
{
friend class XrdOucBuffer;
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       XrdOucBuffer *Alloc(int sz);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline int          MaxSize() const {return maxBsz;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       XrdOucBuffPool(int minsz=4096, int  maxsz=65536,
                      int minh=1,     int  maxh=16,
                      int rate=1);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
      ~XrdOucBuffPool() {delete [] bSlot;}
 
private:
static int            alignit;
 
struct BuffSlot
      {XrdSysMutex    SlotMutex;
       XrdOucBuffer  *buffFree;
       int            size;
       short          numbuff;
       short          maxbuff;
 
       void           Recycle(XrdOucBuffer *bP);
 
                      BuffSlot() : buffFree(0), size(0),
                                   numbuff(0),  maxbuff(0) {}
                     ~BuffSlot();
      };
 
BuffSlot *bSlot;
int       incBsz;
int       shfBsz;
int       rndBsz;
int       maxBsz;
int       slots;
};
 
/******************************************************************************/
/*                          X r d O u c B u f f e r                           */
/******************************************************************************/
 
class XrdOucBuffer
{
friend class XrdOucBuffPool;
 
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline char         *Buffer() const {return data;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline int           BuffSize() const {return size;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
      XrdOucBuffer  *Clone(bool trim=true);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline char         *Data() const {return data+doff;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline char         *Data(int &dataL) const {dataL = dlen; return data+doff;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline int           DataLen() {return dlen;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       XrdOucBuffer *Highjack(int bPsz=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline void         Recycle()  {buffPool->bSlot[slot].Recycle(this);}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       bool         Resize(int newsz);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline void         SetLen(int dataL, int dataO=0) {dlen = dataL; doff = dataO;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
      XrdOucBuffer(char *buff, int blen);
 
private:
      XrdOucBuffer(XrdOucBuffPool *pP, int snum)
                  : data(0), dlen(0), doff(0), size(pP->bSlot[snum].size),
                    slot(snum), buffPool(pP) {}
 
      XrdOucBuffer()
                  : data(0), dlen(0), doff(0), size(0), slot(0), buffPool(0) {}
 
     ~XrdOucBuffer() {if (data) free(data);}
 
      char           *data;
      int             dlen;
      int             doff;
      int             size;
      int             slot;
union{XrdOucBuffer   *buffNext;
      XrdOucBuffPool *buffPool;
     };
};
#endif