]> git.stg.codes - stg.git/blobdiff - projects/stargazer/traffcounter_impl.cpp
Fight Optional
[stg.git] / projects / stargazer / traffcounter_impl.cpp
index 3f6eb0c0f9980e4486ab04284a686b4b11a4fad1..9b0fd966d9a2732e456b60f176c8200e5bed6ccb 100644 (file)
 #include <csignal>
 #include <cassert>
 #include <cstdio> // fopen and similar
+#include <cstdlib> // strtol
 
 #include "stg/common.h"
 #include "stg/locker.h"
+#include "stg/const.h" // MONITOR_TIME_DELAY_SEC
 #include "traffcounter_impl.h"
 #include "stg_timer.h"
+#include "users_impl.h"
 
 #define FLUSH_TIME  (10)
 #define REMOVE_TIME  (31)
 
+using STG::TraffCounterImpl;
+
 const char protoName[PROTOMAX][8] =
 {"TCP", "UDP", "ICMP", "TCP_UDP", "ALL"};
 
@@ -55,12 +60,12 @@ tcp = 0, udp, icmp, tcp_udp, all
 };
 
 //-----------------------------------------------------------------------------
-TRAFFCOUNTER_IMPL::TRAFFCOUNTER_IMPL(USERS * u, const TARIFFS *, const std::string & fn)
-    : WriteServLog(GetStgLogger()),
+TraffCounterImpl::TraffCounterImpl(UsersImpl * u, const std::string & fn)
+    : WriteServLog(Logger::get()),
       rulesFileName(fn),
       monitoring(false),
+      touchTimeP(stgTime - MONITOR_TIME_DELAY_SEC),
       users(u),
-      running(false),
       stopped(true),
       addUserNotifier(*this),
       delUserNotifier(*this)
@@ -72,146 +77,120 @@ dirName[DIR_NUM] = "NULL";
 
 users->AddNotifierUserAdd(&addUserNotifier);
 users->AddNotifierUserDel(&delUserNotifier);
-
-pthread_mutex_init(&mutex, NULL);
 }
 //-----------------------------------------------------------------------------
-TRAFFCOUNTER_IMPL::~TRAFFCOUNTER_IMPL()
+TraffCounterImpl::~TraffCounterImpl()
 {
-pthread_mutex_destroy(&mutex);
 }
 //-----------------------------------------------------------------------------
-int TRAFFCOUNTER_IMPL::Start()
+int TraffCounterImpl::Start()
 {
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 
 if (!stopped)
     return 0;
 
 if (ReadRules())
     {
-    WriteServLog("TRAFFCOUNTER: Cannot read rules.");
+    printfd(__FILE__, "TraffCounterImpl::Start() - Cannot read rules\n");
+    WriteServLog("TraffCounter: Cannot read rules.");
     return -1;
     }
 
-printfd(__FILE__, "TRAFFCOUNTER::Start()\n");
+printfd(__FILE__, "TraffCounter::Start()\n");
 int h = users->OpenSearch();
-USER_PTR u;
-if (!h)
-    {
-    WriteServLog("TRAFFCOUNTER: Cannot get users.");
-    return -1;
-    }
+assert(h && "USERS::OpenSearch is always correct");
+UserImpl * u;
 
 while (users->SearchNext(h, &u) == 0)
-    {
     SetUserNotifiers(u);
-    }
 users->CloseSearch(h);
 
-running = true;
-if (pthread_create(&thread, NULL, Run, this))
-    {
-    WriteServLog("TRAFFCOUNTER: Error: Cannot start thread!");
-    return -1;
-    }
+m_thread = std::jthread([this](auto token){ Run(token); });
 return 0;
 }
 //-----------------------------------------------------------------------------
-int TRAFFCOUNTER_IMPL::Stop()
+int TraffCounterImpl::Stop()
 {
 if (stopped)
     return 0;
 
-running = false;
+m_thread.request_stop();
 
 int h = users->OpenSearch();
-if (!h)
-    {
-    WriteServLog("TRAFFCOUNTER: Fatal error: Cannot get users.");
-    return -1;
-    }
+assert(h && "USERS::OpenSearch is always correct");
 
-USER_PTR u;
+UserImpl * u;
 while (users->SearchNext(h, &u) == 0)
-    {
     UnSetUserNotifiers(u);
-    }
 users->CloseSearch(h);
 
 //5 seconds to thread stops itself
 struct timespec ts = {0, 200000000};
 for (int i = 0; i < 25 && !stopped; i++)
-    {
     nanosleep(&ts, NULL);
-    }
 
-//after 5 seconds waiting thread still running. now kill it
 if (!stopped)
-    {
-    printfd(__FILE__, "kill TRAFFCOUNTER thread.\n");
-    if (pthread_kill(thread, SIGINT))
-        {
-        return -1;
-        }
-    printfd(__FILE__, "TRAFFCOUNTER killed\n");
-    }
-printfd(__FILE__, "TRAFFCOUNTER::Stop()\n");
+{
+    m_thread.detach();
+    return -1;
+}
+
+m_thread.join();
+
+printfd(__FILE__, "TraffCounter::Stop()\n");
 
 return 0;
 }
 //-----------------------------------------------------------------------------
-void * TRAFFCOUNTER_IMPL::Run(void * data)
+void TraffCounterImpl::Run(std::stop_token token)
 {
-TRAFFCOUNTER_IMPL * tc = static_cast<TRAFFCOUNTER_IMPL *>(data);
-tc->stopped = false;
+sigset_t signalSet;
+sigfillset(&signalSet);
+pthread_sigmask(SIG_BLOCK, &signalSet, NULL);
+
+stopped = false;
 int c = 0;
 
 time_t touchTime = stgTime - MONITOR_TIME_DELAY_SEC;
 struct timespec ts = {0, 500000000};
-while (tc->running)
+while (!token.stop_requested())
     {
     nanosleep(&ts, 0);
-    if (!tc->running)
+    if (token.stop_requested())
         {
-        tc->FlushAndRemove();
+        FlushAndRemove();
         break;
         }
 
-    if (tc->monitoring && (touchTime + MONITOR_TIME_DELAY_SEC <= stgTime))
+    if (monitoring && (touchTime + MONITOR_TIME_DELAY_SEC <= stgTime))
         {
-        std::string monFile(tc->monitorDir + "/traffcounter_r");
-        printfd(__FILE__, "Monitor=%d file TRAFFCOUNTER %s\n", tc->monitoring, monFile.c_str());
+        std::string monFile(monitorDir + "/traffcounter_r");
+        printfd(__FILE__, "Monitor=%d file TraffCounter %s\n", monitoring, monFile.c_str());
         touchTime = stgTime;
-        TouchFile(monFile.c_str());
+        TouchFile(monFile);
         }
 
     if (++c % FLUSH_TIME == 0)
-        tc->FlushAndRemove();
+        FlushAndRemove();
     }
 
-tc->stopped = true;
-return NULL;
+stopped = true;
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::Process(const RAW_PACKET & rawPacket)
+void TraffCounterImpl::process(const RawPacket & rawPacket)
 {
-if (!running)
-    return;
-
-static time_t touchTime = stgTime - MONITOR_TIME_DELAY_SEC;
-
-if (monitoring && (touchTime + MONITOR_TIME_DELAY_SEC <= stgTime))
+if (monitoring && (touchTimeP + MONITOR_TIME_DELAY_SEC <= stgTime))
     {
-    static std::string monFile = monitorDir + "/traffcounter_p";
-    printfd(__FILE__, "Monitor=%d file TRAFFCOUNTER %s\n", monitoring, monFile.c_str());
-    touchTime = stgTime;
-    TouchFile(monFile.c_str());
+    std::string monFile = monitorDir + "/traffcounter_p";
+    printfd(__FILE__, "Monitor=%d file TraffCounter %s\n", monitoring, monFile.c_str());
+    touchTimeP = stgTime;
+    TouchFile(monFile);
     }
 
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 
-//printfd(__FILE__, "TRAFFCOUNTER::Process()\n");
+//printfd(__FILE__, "TraffCounter::Process()\n");
 //TODO replace find with lower_bound.
 
 // Searching a new packet in a tree.
@@ -240,7 +219,7 @@ if (pi != packets.end())
     return;
     }
 
-PACKET_EXTRA_DATA ed;
+PacketExtraData ed;
 
 // Packet not found - add new packet
 
@@ -285,16 +264,16 @@ if (ed.userUPresent ||
     }
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::FlushAndRemove()
+void TraffCounterImpl::FlushAndRemove()
 {
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 
-int oldPacketsSize = packets.size();
-int oldIp2packetsSize = ip2packets.size();
+Packets::size_type oldPacketsSize = packets.size();
+Index::size_type oldIp2packetsSize = ip2packets.size();
 
 pp_iter pi;
 pi = packets.begin();
-std::map<RAW_PACKET, PACKET_EXTRA_DATA> newPackets;
+Packets newPackets;
 ip2packets.erase(ip2packets.begin(), ip2packets.end());
 while (pi != packets.end())
     {
@@ -348,49 +327,6 @@ while (pi != packets.end())
             }
         }
 
-    /*//Removing
-    if (stgTime - pi->second.updateTime > REMOVE_TIME)
-        {
-        // Remove packet and references from ip2packets index
-        //printfd(__FILE__, "+++ Removing +++\n");
-        pair<ip2p_iter, ip2p_iter> be(
-                ip2packets.equal_range(pi->first.GetSrcIP()));
-        while (be.first != be.second)
-            {
-            // Have a reference to a packet?
-            if (be.first->second == pi)
-                {
-                ip2packets.erase(be.first++);
-                //printfd(__FILE__, "Remove U from ip2packets %s\n", inet_ntostring(pi->first.GetSrcIP()).c_str());
-                }
-            else
-                {
-                ++be.first;
-                }
-            }
-
-        //printfd(__FILE__, "-------------------\n");
-        be = ip2packets.equal_range(pi->first.GetDstIP());
-        while (be.first != be.second)
-            {
-            // Have a reference to a packet?
-            if (be.first->second == pi)
-                {
-                ip2packets.erase(be.first++);
-                //printfd(__FILE__, "Remove D from ip2packets %s\n", inet_ntostring(pi->first.GetDstIP()).c_str());
-                }
-            else
-                {
-                ++be.first;
-                }
-            }
-        //printfd(__FILE__, "Remove packet\n");
-        packets.erase(pi++);
-        }
-    else
-        {
-        ++pi;
-        }*/
     if (stgTime - pi->second.updateTime < REMOVE_TIME)
         {
         std::pair<pp_iter, bool> res = newPackets.insert(*pi);
@@ -411,13 +347,13 @@ printfd(__FILE__, "FlushAndRemove() packets: %d(rem %d) ip2packets: %d(rem %d)\n
 
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::AddUser(USER_PTR user)
+void TraffCounterImpl::AddUser(UserImpl * user)
 {
 printfd(__FILE__, "AddUser: %s\n", user->GetLogin().c_str());
 uint32_t uip = user->GetCurrIP();
 std::pair<ip2p_iter, ip2p_iter> pi;
 
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 // Find all packets with IP belongs to this user
 pi = ip2packets.equal_range(uip);
 
@@ -425,7 +361,7 @@ while (pi.first != pi.second)
     {
     if (pi.first->second->first.GetSrcIP() == uip)
         {
-        assert((!pi.first->second->second.userUPresent || 
+        assert((!pi.first->second->second.userUPresent ||
                  pi.first->second->second.userU == user) &&
                "U user present but it's not current user");
 
@@ -436,7 +372,7 @@ while (pi.first != pi.second)
 
     if (pi.first->second->first.GetDstIP() == uip)
         {
-        assert((!pi.first->second->second.userDPresent || 
+        assert((!pi.first->second->second.userDPresent ||
                  pi.first->second->second.userD == user) &&
                "D user present but it's not current user");
 
@@ -449,12 +385,12 @@ while (pi.first != pi.second)
     }
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::DelUser(uint32_t uip)
+void TraffCounterImpl::DelUser(uint32_t uip)
 {
 printfd(__FILE__, "DelUser: %s \n", inet_ntostring(uip).c_str());
 std::pair<ip2p_iter, ip2p_iter> pi;
 
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 pi = ip2packets.equal_range(uip);
 
 while (pi.first != pi.second)
@@ -502,7 +438,7 @@ while (pi.first != pi.second)
 ip2packets.erase(pi.first, pi.second);
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::SetUserNotifiers(USER_PTR user)
+void TraffCounterImpl::SetUserNotifiers(UserImpl * user)
 {
 // Adding user. Adding notifiers to user.
 TRF_IP_BEFORE ipBNotifier(*this, user);
@@ -514,7 +450,7 @@ ipAfterNotifiers.push_front(ipANotifier);
 user->AddCurrIPAfterNotifier(&(*ipAfterNotifiers.begin()));
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::UnSetUserNotifiers(USER_PTR user)
+void TraffCounterImpl::UnSetUserNotifiers(UserImpl * user)
 {
 // Removing user. Removing notifiers from user.
 std::list<TRF_IP_BEFORE>::iterator bi;
@@ -545,28 +481,27 @@ while (ai != ipAfterNotifiers.end())
     }
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::DeterminateDir(const RAW_PACKET & packet,
+void TraffCounterImpl::DeterminateDir(const RawPacket & packet,
                                        int * dirU, // Direction for incoming packet
                                        int * dirD) const // Direction for outgoing packet
 {
-bool addrMatchU;
-bool portMatchU;
-bool addrMatchD;
-bool portMatchD;
+bool addrMatchU = false;
+bool portMatchU = false;
+bool addrMatchD = false;
+bool portMatchD = false;
 bool foundU = false; // Was rule for U found ?
 bool foundD = false; // Was rule for D found ?
 //printfd(__FILE__, "foundU=%d, foundD=%d\n", foundU, foundD);
 
 enum { ICMP_RPOTO = 1, TCP_PROTO = 6, UDP_PROTO = 17 };
 
-std::list<RULE>::const_iterator ln;
+std::list<Rule>::const_iterator ln;
 ln = rules.begin();
 
 while (ln != rules.end())
     {
     if (!foundU)
         {
-        addrMatchU = false;
         portMatchU = false;
 
         switch (ln->proto)
@@ -606,14 +541,12 @@ while (ln != rules.end())
             foundU = true;
             *dirU = ln->dir;
             //printfd(__FILE__, "Up rule ok! %d\n", ln->dir);
-            //PrintRule(ln->rule);
             }
 
         } //if (!foundU)
 
     if (!foundD)
         {
-        addrMatchD = false;
         portMatchD = false;
 
         switch (ln->proto)
@@ -653,7 +586,6 @@ while (ln != rules.end())
             foundD = true;
             *dirD = ln->dir;
             //printfd(__FILE__, "Down rule ok! %d\n", ln->dir);
-            //PrintRule(ln->rule);
             }
         } //if (!foundD)
 
@@ -665,20 +597,13 @@ if (!foundU)
 
 if (!foundD)
     *dirD = DIR_NUM;
-
-return;
-};
-//-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::SetRulesFile(const std::string & fn)
-{
-rulesFileName = fn;
 }
 //-----------------------------------------------------------------------------
-bool TRAFFCOUNTER_IMPL::ReadRules(bool test)
+bool TraffCounterImpl::ReadRules(bool test)
 {
-//printfd(__FILE__, "TRAFFCOUNTER::ReadRules()\n");
+//printfd(__FILE__, "TraffCounter::ReadRules()\n");
 
-RULE rul;
+Rule rul;
 FILE * f;
 char str[1024];
 char tp[100];   // protocol
@@ -690,7 +615,8 @@ f = fopen(rulesFileName.c_str(), "rt");
 
 if (!f)
     {
-    WriteServLog("File %s cannot be oppened.", rulesFileName.c_str());
+    printfd(__FILE__, "TraffCounterImpl::ReadRules() - File '%s' cannot be opened.\n", rulesFileName.c_str());
+    WriteServLog("File '%s' cannot be oppened.", rulesFileName.c_str());
     return true;
     }
 
@@ -702,10 +628,11 @@ while (fgets(str, 1023, f))
         continue;
         }
 
-    r = sscanf(str,"%s %s %s", tp, ta, td);
+    r = sscanf(str,"%99s %99s %99s", tp, ta, td);
     if (r != 3)
         {
-        WriteServLog("Error in file %s. There must be 3 parameters. Line %d.", rulesFileName.c_str(), lineNumber);
+        printfd(__FILE__, "TraffCounterImpl::ReadRules() - Error in file '%s' at line %d. There must be 3 parameters.\n", rulesFileName.c_str(), lineNumber);
+        WriteServLog("Error in file '%s' at line %d. There must be 3 parameters.", rulesFileName.c_str(), lineNumber);
         fclose(f);
         return true;
         }
@@ -713,13 +640,13 @@ while (fgets(str, 1023, f))
     rul.proto = 0xff;
     rul.dir = 0xff;
 
-    for (int i = 0; i < PROTOMAX; i++)
+    for (uint8_t i = 0; i < PROTOMAX; i++)
         {
         if (strcasecmp(tp, protoName[i]) == 0)
             rul.proto = i;
         }
 
-    for (int i = 0; i < DIR_NUM + 1; i++)
+    for (uint32_t i = 0; i < DIR_NUM + 1; i++)
         {
         if (td == dirName[i])
             rul.dir = i;
@@ -727,6 +654,7 @@ while (fgets(str, 1023, f))
 
     if (rul.dir == 0xff || rul.proto == 0xff)
         {
+        printfd(__FILE__, "TraffCounterImpl::ReadRules() - Error in file '%s' at line %d.\n", rulesFileName.c_str(), lineNumber);
         WriteServLog("Error in file %s. Line %d.",
                      rulesFileName.c_str(), lineNumber);
         fclose(f);
@@ -735,6 +663,7 @@ while (fgets(str, 1023, f))
 
     if (ParseAddress(ta, &rul) != 0)
         {
+        printfd(__FILE__, "TraffCounterImpl::ReadRules() - Error in file '%s' at line %d. Error in adress.\n", rulesFileName.c_str(), lineNumber);
         WriteServLog("Error in file %s. Error in adress. Line %d.",
                      rulesFileName.c_str(), lineNumber);
         fclose(f);
@@ -742,7 +671,6 @@ while (fgets(str, 1023, f))
         }
     if (!test)
         rules.push_back(rul);
-    //PrintRule(rul);
     }
 
 fclose(f);
@@ -758,34 +686,34 @@ rul.proto = all;
 if (!test)
     rules.push_back(rul);
 
-//PrintRule(rul);
-
 return false;
 }
 //-----------------------------------------------------------------------------
-int TRAFFCOUNTER_IMPL::Reload()
+int TraffCounterImpl::Reload()
 {
-STG_LOCKER lock(&mutex, __FILE__, __LINE__);
+std::lock_guard<std::mutex> lock(m_mutex);
 
 if (ReadRules(true))
     {
-    WriteServLog("TRAFFCOUNTER: Cannot reload rules. Errors found.");
+    printfd(__FILE__, "TraffCounterImpl::Reload() - Failed to reload rules.\n");
+    WriteServLog("TraffCounter: Cannot reload rules. Errors found.");
     return -1;
     }
 
 FreeRules();
 ReadRules();
-WriteServLog("TRAFFCOUNTER: Reload rules successfull.");
+printfd(__FILE__, "TraffCounterImpl::Reload() -  Reloaded rules successfully.\n");
+WriteServLog("TraffCounter: Reloaded rules successfully.");
 return 0;
 }
 //-----------------------------------------------------------------------------
-bool TRAFFCOUNTER_IMPL::ParseAddress(const char * ta, RULE * rule) const
+bool TraffCounterImpl::ParseAddress(const char * ta, Rule * rule) const
 {
 char addr[50], mask[20], port1[20], port2[20], ports[40];
 
-int len = strlen(ta);
+size_t len = strlen(ta);
 char n = 0;
-int i, p;
+size_t i, p;
 memset(addr, 0, sizeof(addr));
 for (i = 0; i < len; i++)
     {
@@ -829,6 +757,7 @@ if (n == ':')
     // port
     if (!(rule->proto == tcp || rule->proto == udp || rule->proto == tcp_udp))
         {
+        printfd(__FILE__, "TraffCounterImpl::ParseAddress() - No ports specified for this protocol.\n");
         WriteServLog("No ports specified for this protocol.");
         return true;
         }
@@ -860,33 +789,32 @@ else
     }
 
 // Convert strings to mask, ports and IP
-int prt1, prt2, msk;
-unsigned ip;
+uint16_t prt1, prt2, msk;
+struct in_addr ipaddr;
 char *res;
 
-msk = strtol(mask, &res, 10);
+msk = static_cast<uint16_t>(strtol(mask, &res, 10));
 if (*res != 0)
     return true;
 
-prt1 = strtol(port1, &res, 10);
+prt1 = static_cast<uint16_t>(strtol(port1, &res, 10));
 if (*res != 0)
     return true;
 
-prt2 = strtol(port2, &res, 10);
+prt2 = static_cast<uint16_t>(strtol(port2, &res, 10));
 if (*res != 0)
     return true;
 
-int r = inet_aton(addr, (struct in_addr*)&ip);
+int r = inet_aton(addr, &ipaddr);
 if (r == 0)
     return true;
 
-rule->ip = ip;
+rule->ip = ipaddr.s_addr;
 rule->mask = CalcMask(msk);
-//msk = 1;
-//printfd(__FILE__, "msk=%d mask=%08X   mask=%08X\n", msk, rule->mask, (0xFFffFFff << (32 - msk)));
 
-if ((ip & rule->mask) != ip)
+if ((ipaddr.s_addr & rule->mask) != ipaddr.s_addr)
     {
+    printfd(__FILE__, "TraffCounterImpl::ParseAddress() - Address does'n match mask.\n");
     WriteServLog("Address does'n match mask.");
     return true;
     }
@@ -897,49 +825,21 @@ rule->port2 = prt2;
 return false;
 }
 //-----------------------------------------------------------------------------
-uint32_t TRAFFCOUNTER_IMPL::CalcMask(uint32_t msk) const
+uint32_t TraffCounterImpl::CalcMask(uint32_t msk) const
 {
 if (msk >= 32) return 0xFFffFFff;
 if (msk == 0) return 0;
 return htonl(0xFFffFFff << (32 - msk));
 }
 //---------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::FreeRules()
+void TraffCounterImpl::FreeRules()
 {
 rules.clear();
 }
 //-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::PrintRule(RULE rule) const
-{
-printf("%15s   ", inet_ntostring(rule.ip).c_str());
-printf("mask=%08X ", rule.mask);
-printf("port1=%5d ", rule.port1);
-printf("port2=%5d ", rule.port2);
-switch (rule.proto)
-    {
-    case 0:
-        printf("TCP     ");
-        break;
-    case 1:
-        printf("UDP     ");
-        break;
-    case 2:
-        printf("ICMP    ");
-        break;
-    case 3:
-        printf("TCP_UDP ");
-        break;
-    case 4:
-        printf("ALL     ");
-        break;
-    }
-printf("dir=%d \n", rule.dir);
-return;
-}
-//-----------------------------------------------------------------------------
-void TRAFFCOUNTER_IMPL::SetMonitorDir(const std::string & monitorDir)
+void TraffCounterImpl::SetMonitorDir(const std::string & dir)
 {
-TRAFFCOUNTER_IMPL::monitorDir = monitorDir;
-monitoring = (monitorDir != "");
+monitorDir = dir;
+monitoring = !monitorDir.empty();
 }
 //-----------------------------------------------------------------------------