src/monitor/include/stc-monitor.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __STC_MONITOR_H__
  18 #define __STC_MONITOR_H__
  19
  20 #include <glib.h>
  21 #include "stc-error.h"
  22 #include "stc-manager.h"
  23 #include "stc-restriction.h"
  24 #include "stc-manager-util.h"
  25 #include "table-restrictions.h"
  26 #include "helper-nl.h"
  27
  28 /* 1 seconds */
  29 #define CONTR_TIMER_INTERVAL 1
  30
  31 /**
  32  * @brief enumeration for data limit types
  33  */
  34 typedef enum {
  35         STC_RSTN_LIMIT_TYPE_DATA_WARN,
  36         STC_RSTN_LIMIT_TYPE_DATA,
  37         STC_RSTN_LIMIT_TYPE_MONTHLY,
  38         STC_RSTN_LIMIT_TYPE_WEEKLY,
  39         STC_RSTN_LIMIT_TYPE_DAILY,
  40         STC_RSTN_LIMIT_TYPE_MAX
  41 } stc_rstn_limit_type_e;
  42
  43
  44 /**
  45  * @brief key for processes tree
  46  */
  47 typedef struct {
  48         stc_app_state_e ground;  /**< application state foreground/background */
  49 } stc_process_value_s;
  50
  51 /**
  52  * @brief value for processes tree
  53  */
  54 typedef struct {
  55         pid_t pid;  /**< process id */
  56 } stc_process_key_s;
  57
  58 /**
  59  * @brief key for apps tree
  60  */
  61 typedef struct {
  62         gchar *pkg_id;  /**< package id */
  63         gchar *app_id;  /**< application id */
  64 } stc_app_key_s;
  65
  66 /**
  67  * @brief value for apps tree
  68  */
  69 typedef struct {
  70         uint32_t classid;  /**< classid for a package */
  71         stc_app_type_e type;  /**< type of application */
  72         stc_data_counter_s data_usage;
  73         stc_data_counter_s counter;
  74         GTree *processes;  /**< applications instances */
  75 } stc_app_value_s;
  76
  77 /**
  78  * @brief key for rstn_rules tree
  79  */
  80 typedef struct {
  81         gchar *app_id;
  82         gchar *ifname;
  83         gchar *subscriber_id;
  84         stc_iface_type_e iftype;
  85         stc_roaming_type_e roaming;
  86 } stc_rstn_key_s;
  87
  88 /**
  89  * @brief value for rstn_rules tree
  90  */
  91 typedef struct {
  92         uint64_t restriction_id;
  93         uint32_t classid;
  94         stc_rstn_state_e rstn_state;
  95         stc_rstn_type_e rstn_type;
  96
  97         int64_t counter[STC_RSTN_LIMIT_TYPE_MAX];
  98         int64_t limit[STC_RSTN_LIMIT_TYPE_MAX];
  99         int32_t limit_exceeded;
 100         int32_t limit_notified;
 101
 102         int month_start_date;
 103         time_t month_start_ts;
 104 } stc_rstn_value_s;
 105
 106 /**
 107  * @brief structure to store system info
 108  */
 109 typedef struct {
 110         int contr_sock;  /**< socket used for getting kernel counters */
 111         guint contr_timer_id;  /**< timer id for periodically getting kernel counters */
 112         guint contr_gsource_id;
 113         stc_data_counter_s du_curr;  /**< current data usage */
 114         GTree *rstns;  /**< restriction rules */
 115         gboolean rstns_tree_updated;
 116         GTree *apps;  /**< monitored applications */
 117         gboolean apps_tree_updated;
 118         guint background_state;
 119         time_t last_month_ts;
 120         time_t last_week_ts;
 121         time_t last_day_ts;
 122         int month_start_date;
 123 } stc_system_s;
 124
 125 /**
 126  * @brief initializes stc monitor module
 127  */
 128 stc_error_e stc_monitor_init(void);
 129
 130 /**
 131  * @brief deinitializes stc monitor module
 132  */
 133 stc_error_e stc_monitor_deinit(void);
 134
 135 /**
 136  * @brief creates an application entry
 137  */
 138 stc_error_e stc_monitor_application_add(const stc_app_key_s app_key,
 139                                         const stc_app_value_s app_value);
 140
 141 /**
 142  * @brief associates process to an application
 143  */
 144 stc_error_e stc_monitor_process_add(const stc_app_key_s app_key,
 145                                     const stc_process_key_s proc_key,
 146                                     const stc_process_value_s proc_value);
 147
 148 /**
 149  * @brief removes associated process from respective application
 150  */
 151 stc_error_e stc_monitor_process_remove(pid_t pid);
 152
 153 /**
 154  * @brief updates process's ground attribute
 155  */
 156 stc_error_e stc_monitor_process_update_ground(const stc_app_key_s app_key,
 157                                               const stc_process_key_s proc_key,
 158                                               stc_app_state_e ground);
 159
 160 void stc_monitor_update_rstn_by_default_connection(void *default_connection);
 161
 162 stc_error_e stc_monitor_rstns_tree_add(const table_restrictions_info *info);
 163
 164 stc_error_e stc_monitor_rstns_tree_remove(const table_restrictions_info *info);
 165
 166 stc_error_e stc_monitor_check_excn_by_cmdline(char *cmdline);
 167
 168 int stc_monitor_get_counter_socket(void);
 169
 170 #endif /* __STC_MONITOR_H__ */