examples/vm_power_manager/channel_monitor.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef CHANNEL_MONITOR_H_
  35 #define CHANNEL_MONITOR_H_
  36
  37 #include "channel_manager.h"
  38 #include "channel_commands.h"
  39
  40 struct core_share {
  41         unsigned int pcpu;
  42         /*
  43          * 1 CORE SHARE
  44          * 0 NOT SHARED
  45          */
  46         int status;
  47 };
  48
  49 struct policy {
  50         struct channel_packet pkt;
  51         uint32_t pfid[MAX_VFS];
  52         uint32_t port[MAX_VFS];
  53         unsigned int enabled;
  54         struct core_share core_share[MAX_VCPU_PER_VM];
  55 };
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61 /**
  62  * Setup the Channel Monitor resources required to initialize epoll.
  63  * Must be called first before calling other functions.
  64  *
  65  * @return
  66  *  - 0 on success.
  67  *  - Negative on error.
  68  */
  69 int channel_monitor_init(void);
  70
  71 /**
  72  * Run the channel monitor, loops forever on on epoll_wait.
  73  *
  74  *
  75  * @return
  76  *  None
  77  */
  78 void run_channel_monitor(void);
  79
  80 /**
  81  * Exit the Channel Monitor, exiting the epoll_wait loop and events processing.
  82  *
  83  * @return
  84  *  - 0 on success.
  85  *  - Negative on error.
  86  */
  87 void channel_monitor_exit(void);
  88
  89 /**
  90  * Add an open channel to monitor via epoll. A pointer to struct channel_info
  91  * will be registered with epoll for event processing.
  92  * It is thread-safe.
  93  *
  94  * @param chan_info
  95  *  Pointer to struct channel_info pointer.
  96  *
  97  * @return
  98  *  - 0 on success.
  99  *  - Negative on error.
 100  */
 101 int add_channel_to_monitor(struct channel_info **chan_info);
 102
 103 /**
 104  * Remove a previously added channel from epoll control.
 105  *
 106  * @param chan_info
 107  *  Pointer to struct channel_info.
 108  *
 109  * @return
 110  *  - 0 on success.
 111  *  - Negative on error.
 112  */
 113 int remove_channel_from_monitor(struct channel_info *chan_info);
 114
 115 #ifdef __cplusplus
 116 }
 117 #endif
 118
 119
 120 #endif /* CHANNEL_MONITOR_H_ */