XrdPollE Class Reference

#include <XrdPollE.hh>

Inheritance diagram for XrdPollE:

Collaboration diagram for XrdPollE:

Public Member Functions
	XrdPollE (struct epoll_event *ptab, int numfd, int pfd, int wfd)
	~XrdPollE ()
void	Disable (XrdPollInfo &pInfo, const char *etxt=0)
int	Enable (XrdPollInfo &pInfo)
void	Start (XrdSysSemaphore *syncp, int &rc)
Public Member Functions inherited from XrdPoll
	XrdPoll ()
virtual	~XrdPoll ()

Protected Member Functions
void	Exclude (XrdPollInfo &pInfo)
int	Include (XrdPollInfo &pInfo)
const char *	x2Text (unsigned int evf, char *buff)
Protected Member Functions inherited from XrdPoll
int	getRequest ()

Additional Inherited Members
Static Public Member Functions inherited from XrdPoll
static int	Attach (XrdPollInfo &pInfo)
static void	Detach (XrdPollInfo &pInfo)
static int	Finish (XrdPollInfo &pInfo, const char *etxt=0)
static char *	Poll2Text (short events)
static int	Setup (int numfd)
static int	Stats (char *buff, int blen, int do_sync=0)
Public Attributes inherited from XrdPoll
int	PID
pthread_t	TID
Static Public Attributes inherited from XrdPoll
static XrdPoll *	Pollers [XRD_NUMPOLLERS] = {0, 0, 0}
Static Protected Member Functions inherited from XrdPoll
static XrdPoll *	newPoller (int pollid, int numfd)
Protected Attributes inherited from XrdPoll
int	CmdFD
int	numEnabled
int	numEvents
int	numInterrupts
int	PipeBlen
char *	PipeBuff
struct pollfd	PipePoll
XrdSysMutex	PollPipe
PipeData	ReqBuff
int	ReqFD
Static Protected Attributes inherited from XrdPoll
static const char *	TraceID = "Poll"

Detailed Description

Definition at line 40 of file XrdPollE.hh.

Constructor & Destructor Documentation

XrdPollE()

XrdPollE::XrdPollE ( struct epoll_event * ptab, int numfd, int pfd, int wfd )

inline

Definition at line 50 of file XrdPollE.hh.

                    : WaitFdSem(0), WaitFdSem2(0)
                      {PollTab = ptab; PollMax = numfd; PollDfd = pfd;
                       WaitFd = wfd;
                      }

~XrdPollE()

XrdPollE::~XrdPollE

(

)

Definition at line 88 of file XrdPollE.icc.

{
   if (PollTab) free(PollTab);
   if (WaitFd >= 0) close(WaitFd);
   if (PollDfd >= 0) close(PollDfd);
}

References close.

Member Function Documentation

Disable()

void XrdPollE::Disable ( XrdPollInfo & pInfo, const char * etxt = 0 )

virtual

Implements XrdPoll.

Definition at line 119 of file XrdPollE.icc.

{
 
// Simply return if the link is already disabled
//
   if (!pInfo.isEnabled) return;
 
// If Linux 2.6.9 we use EPOLLONESHOT to automatically disable a polled fd.
// So, the Disable() method need not do anything. Prior kernels did not have
// this mechanism so we need to do this manually.
//
#ifndef EPOLLONESHOT
   struct epoll_event myEvents = {0, (void *)&pInfo};
 
// Disable this fd. Unlike solaris, epoll_ctl() does not block when the pollfd
// is being waited upon by another thread.
//
   if (epoll_ctl(PollDfd, EPOLL_CTL_MOD, pInfo.FD, &myEvents))
      {Log.Emsg("Poll", errno, "disable link", lp->ID); return;}
#endif
 
// Trace this event
//
   pInfo.isEnabled = false;
   TRACEI(POLL, "Poller " <<PID <<" async disabling link " <<pInfo.FD);
 
// Check if this link needs to be rescheduled. If so, the caller better have
// the link opMutex lock held for this to work!
//
   if (etxt && Finish(pInfo, etxt)) Sched.Schedule((XrdJob *)&pInfo.Link);
}

References XrdSysError::Emsg(), XrdPollInfo::FD, XrdPoll::Finish(), XrdPollInfo::isEnabled, XrdPollInfo::Link, XrdPoll::PID, XrdScheduler::Schedule(), and TRACEI.

Referenced by Exclude().

Here is the call graph for this function:

Here is the caller graph for this function:

Enable()

int XrdPollE::Enable ( XrdPollInfo & pInfo )

virtual

Implements XrdPoll.

Definition at line 155 of file XrdPollE.icc.

{
   struct epoll_event myEvents = {ePollEvents, {(void *)&pInfo}};
 
// Simply return if the link is already enabled
//
   if (pInfo.isEnabled) return 1;
 
// Enable this fd. Unlike solaris, epoll_ctl() does not block when the pollfd
// is being waited upon by another thread.
//
   pInfo.isEnabled = true;
   if (epoll_ctl(PollDfd, EPOLL_CTL_MOD, pInfo.FD, &myEvents))
      {Log.Emsg("Poll", errno, "enable link", pInfo.Link.ID);
       pInfo.isEnabled = false;
       return 0;
      }
 
// Do final processing
//
   TRACE(POLL, "Poller " <<PID <<" enabled " <<pInfo.Link.ID);
   numEnabled++;
   return 1;
}

References XrdSysError::Emsg(), XrdPollInfo::FD, XrdLink::ID, XrdPollInfo::isEnabled, XrdPollInfo::Link, XrdPoll::numEnabled, XrdPoll::PID, and TRACE.

Here is the call graph for this function:

Exclude()

void XrdPollE::Exclude ( XrdPollInfo & pInfo )

protectedvirtual

Implements XrdPoll.

Definition at line 184 of file XrdPollE.icc.

{
 
// Make sure this link is not enabled
//
   if (pInfo.isEnabled)
      {Log.Emsg("Poll", "Detach of enabled link", pInfo.Link.ID);
       Disable(pInfo);
      }
 
// Forcibly remove the link from the poll set
//
   remFD(pInfo, 0);
 
// Wait to make sure the poll thread has completed handling the last set of
// events which may have included our Link. The handing includes examining the
// Link's PollInfo before deciding if to schedule the Link. After we return,
// the PollInfo may be reset and the Link could be subsequently reused so we
// must make sure that the there are no more events.
// This is a separate issue from ensuring that if this Link is Scheduled it
// has completed processing. In the usual flow this is ensured by calling
// Close -> Detach -> Exclude from within the Link's schedule task.
//
   Wait4Poller();
}

References Disable(), XrdSysError::Emsg(), XrdLink::ID, XrdPollInfo::isEnabled, and XrdPollInfo::Link.

Here is the call graph for this function:

Include()

int XrdPollE::Include ( XrdPollInfo & pInfo )

protectedvirtual

Implements XrdPoll.

Definition at line 246 of file XrdPollE.icc.

{
   struct epoll_event myEvent = {0, {(void *)&pInfo}};
   int rc;
 
// Add this fd to the poll set
//
   if ((rc = epoll_ctl(PollDfd, EPOLL_CTL_ADD, pInfo.FD, &myEvent)) < 0)
      Log.Emsg("Poll", errno, "include link", pInfo.Link.ID);
 
// All done
//
   return rc == 0;
}

References XrdSysError::Emsg(), XrdPollInfo::FD, XrdLink::ID, and XrdPollInfo::Link.

Here is the call graph for this function:

Start()

void XrdPollE::Start ( XrdSysSemaphore * syncp, int & rc )

virtual

Implements XrdPoll.

Definition at line 295 of file XrdPollE.icc.

{
   char eBuff[64];
   int rc, i, numpolled, num2sched;
   unsigned int waitFdEvents;
   bool haveWaiters;
   XrdJob *jfirst, *jlast;
   const short pollOK = EPOLLIN | EPOLLPRI;
   XrdLink *lp;
   XrdPollInfo *pInfo;
 
   if ((rc = AddWaitFd()))
      {retcode = rc;
       syncsem->Post();
       return;
      }
 
// Indicate to the starting thread that all went well
//
   retcode = 0;
   syncsem->Post();
 
// Now start dispatching links that are ready
//
   do {do {numpolled = epoll_wait(PollDfd, PollTab, PollMax, -1);}
          while (numpolled < 0 && errno == EINTR);
       if (numpolled == 0) continue;
       if (numpolled <  0)
          {Log.Emsg("Poll", errno, "poll for events");
           abort();
          }
       numEvents += numpolled;
 
       // Checkout which links must be dispatched (no need to lock)
       //
       jfirst = jlast = 0; num2sched = 0;
       haveWaiters = false; waitFdEvents = 0;
       for (i = 0; i < numpolled; i++)
           {if (PollTab[i].data.ptr == &WaitFd)
              {haveWaiters = true; waitFdEvents = PollTab[i].events;}
            else if ((pInfo = (XrdPollInfo *)PollTab[i].data.ptr))
              {if (!(pInfo->isEnabled) && pInfo->FD >= 0)
                  remFD(*pInfo, PollTab[i].events);
                  else {pInfo->isEnabled = 0;
                        if (!(PollTab[i].events & pollOK)
                        ||   (PollTab[i].events & POLLRDHUP))
                           Finish(*pInfo, x2Text(PollTab[i].events, eBuff));
                        lp = &(pInfo->Link);
                        lp->NextJob = jfirst; jfirst = (XrdJob *)lp;
                        if (!jlast) jlast=(XrdJob *)lp;
                        num2sched++;
#ifndef EPOLLONESHOT
                        PollTab[i].events  = 0;
                        if (epoll_ctl(PollDfd,EPOLL_CTL_MOD,pInfo.FD,&PollTab[i]))
                           Log.Emsg("Poll",errno,"disable link",pInfo.Link.ID);
#endif
                       }
              } else Log.Emsg("Poll", "null link event!!!!");
           }
 
       // Schedule the polled links
       //
       if (num2sched == 1) Sched.Schedule(jfirst);
          else if (num2sched) Sched.Schedule(num2sched, jfirst, jlast);
 
       if (haveWaiters) HandleWaitFd(waitFdEvents);
      } while(1);
}

References XrdSysError::Emsg(), XrdPollInfo::FD, XrdPoll::Finish(), XrdLink::ID, XrdPollInfo::isEnabled, XrdPollInfo::Link, XrdJob::NextJob, XrdPoll::numEvents, XrdSysSemaphore::Post(), XrdScheduler::Schedule(), and x2Text().

Here is the call graph for this function:

x2Text()

const char * XrdPollE::x2Text ( unsigned int evf, char * buff )

protected

Definition at line 391 of file XrdPollE.icc.

{
   if (events & EPOLLERR) return "socket error";
 
   if (events & (EPOLLHUP | EPOLLRDHUP)) return "hangup";
 
   sprintf(buff, "unusual event (%.4x)", events);
   return buff;
}

References EPOLLRDHUP.

Referenced by Start().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• XrdPollE.hh
• XrdPollE.icc