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 #include "netlink-restriction.h"
  28
  29 /* 10 seconds */
  30 #define CONTR_TIMER_INTERVAL 10
  31
  32 /**
  33  * @brief key for processes tree
  34  */
  35 typedef struct {
  36         stc_app_state_e ground;  /**< application state foreground/background */
  37 } stc_process_value_s;
  38
  39 /**
  40  * @brief value for processes tree
  41  */
  42 typedef struct {
  43         pid_t pid;  /**< process id */
  44         GArray *childs;  /**< child pids */
  45 } stc_process_key_s;
  46
  47 /**
  48  * @brief key for apps tree
  49  */
  50 typedef struct {
  51         gchar *pkg_id;  /**< package id */
  52         gchar *app_id;  /**< application id */
  53 } stc_app_key_s;
  54
  55 /**
  56  * @brief value for apps tree
  57  */
  58 typedef struct {
  59         uint32_t classid;  /**< classid for a package */
  60         stc_app_type_e type;  /**< type of application */
  61         stc_data_counter_s data_usage;
  62         stc_data_counter_s counter;
  63         GTree *processes;  /**< applications instances */
  64 } stc_app_value_s;
  65
  66 /**
  67  * @brief key for rstn_rules tree
  68  */
  69 typedef struct {
  70         gchar *app_id;
  71         gchar *ifname;
  72         gchar *imsi;
  73         stc_iface_type_e iftype;
  74         stc_roaming_type_e roaming;
  75 } stc_rstn_key_s;
  76
  77 /**
  78  * @brief value for rstn_rules tree
  79  */
  80 typedef struct {
  81         uint64_t restriction_id;
  82         uint32_t classid;
  83         stc_restriction_state_e rst_state;
  84         stc_data_counter_s limit;
  85         stc_data_counter_s warn_limit;
  86         stc_data_counter_s counter;
  87         gboolean in_limit_reached;
  88         gboolean out_limit_reached;
  89         gboolean warn_limit_crossed_notified;
  90         gboolean rstn_limit_crossed_notified;
  91 } stc_rstn_value_s;
  92
  93 /**
  94  * @brief structure to store system info
  95  */
  96 typedef struct {
  97         int contr_sock;  /**< socket used for getting kernel counters */
  98         guint contr_timer_id;  /**< timer id for periodically getting kernel counters */
  99         guint contr_gsource_id;
 100         stc_data_counter_s du_curr;  /**< current data usage */
 101         GTree *rstns;  /**< restriction rules */
 102         gboolean rstns_tree_updated;
 103         GTree *apps;  /**< monitored applications */
 104         gboolean apps_tree_updated;
 105         GSList *background_pids; /**< list of background pids */
 106 } stc_system_s;
 107
 108 /**
 109  * @brief initializes stc monitor module
 110  */
 111 stc_error_e stc_monitor_init(void);
 112
 113 /**
 114  * @brief deinitializes stc monitor module
 115  */
 116 stc_error_e stc_monitor_deinit(void);
 117
 118 /**
 119  * @brief creates an application entry
 120  */
 121 stc_error_e stc_monitor_application_add(const stc_app_key_s app_key,
 122                                         const stc_app_value_s app_value);
 123
 124 /**
 125  * @brief associates process to an application
 126  */
 127 stc_error_e stc_monitor_process_add(const stc_app_key_s app_key,
 128                                     const stc_process_key_s proc_key,
 129                                     const stc_process_value_s proc_value);
 130
 131 /**
 132  * @brief removes associated process from respective application
 133  */
 134 stc_error_e stc_monitor_process_remove(pid_t pid);
 135
 136 /**
 137  * @brief updates process's ground attribute
 138  */
 139 stc_error_e stc_monitor_process_update_ground(const stc_app_key_s app_key,
 140                                               const stc_process_key_s proc_key,
 141                                               stc_app_state_e ground);
 142
 143 void stc_monitor_update_rstn_by_default_connection(void *default_connection);
 144
 145 stc_error_e stc_monitor_rstns_tree_add(const table_restrictions_info *info);
 146
 147 stc_error_e stc_monitor_rstns_tree_remove(const table_restrictions_info *info);
 148
 149 int stc_monitor_get_counter_socket(void);
 150
 151 #endif /* __STC_MONITOR_H__ */