src/base/pollevent.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  */
  30
  31 #ifndef __POLLEVENT_H__
  32 #define __POLLEVENT_H__
  33
  34 #include <poll.h>
  35
  36 #include <vector>
  37
  38 #include "sim/core.hh"
  39
  40 class Checkpoint;
  41 class PollQueue;
  42
  43 class PollEvent : public Serializable
  44 {
  45   private:
  46     friend class PollQueue;
  47
  48   protected:
  49     pollfd pfd;
  50     PollQueue *queue;
  51     bool enabled;
  52
  53   public:
  54     PollEvent(int fd, int event);
  55     virtual ~PollEvent();
  56
  57     void disable();
  58     void enable();
  59     virtual void process(int revent) = 0;
  60
  61     bool queued() { return queue != 0; }
  62
  63     void serialize(CheckpointOut &cp) const override;
  64     void unserialize(CheckpointIn &cp) override;
  65 };
  66
  67 class PollQueue
  68 {
  69   private:
  70     typedef std::vector<PollEvent *> eventvec_t;
  71     eventvec_t events;
  72
  73     pollfd *poll_fds;
  74     int max_size;
  75     int num_fds;
  76
  77   public:
  78     PollQueue();
  79     ~PollQueue();
  80
  81     void copy();
  82     void remove(PollEvent *event);
  83     void schedule(PollEvent *event);
  84     void service();
  85
  86   public:
  87     static void setupAsyncIO(int fd, bool set);
  88 };
  89
  90 extern PollQueue pollQueue;
  91
  92 #endif // __POLLEVENT_H__