Optimized (much faster, more efficient, less cpu usage)

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2269 e03df62e-2008-0410-955e-edbf42e46eb7

2 files changed, 251 insertions, 125 deletions

diff --git a/include/xline.h b/include/xline.h
index fed1415d4..9ba1358aa 100644
--- a/include/xline.h
+++ b/include/xline.h
@@ -150,7 +150,8 @@ void stats_e(userrec* user);
 void gline_set_creation_time(char* host, time_t create_time);
 void qline_set_creation_time(char* nick, time_t create_time);
 void zline_set_creation_time(char* ip, time_t create_time);
-
+void eline_set_creation_time(char* host, time_t create_time);
+	
 bool zline_make_global(const char* ipaddr);
 bool qline_make_global(const char* nickname);
 
diff --git a/src/xline.cpp b/src/xline.cpp
index 7a6db9a61..f7c615a36 100644
--- a/src/xline.cpp
+++ b/src/xline.cpp
@@ -100,14 +100,51 @@ extern file_cache MOTD;
 extern file_cache RULES;
 extern address_cache IP;
 
+/* Version two, now with optimized expiry!
+ *
+ * Because the old way was horrendously slow, the new way of expiring xlines is very
+ * very efficient. I have improved the efficiency of the algorithm in two ways:
+ *
+ * (1) There are now two lists of items for each linetype. One list holds permenant
+ *     items, and the other list holds temporary items (ones which will expire).
+ *     Items which are on the permenant list are NEVER checked at all by the
+ *     expire_lines() function.
+ * (2) The temporary xline lists are always kept in strict numerical order, keyed by 
+ *     current time + duration. This means that the line which is due to expire the
+ *     soonest is always pointed at by vector::begin(), so a simple while loop can
+ *     very efficiently, very quickly and above all SAFELY pick off the first few
+ *     items in the vector which need zapping.
+ *
+ *     -- Brain
+ */
+
+
+
 extern time_t TIME;
 
+/* Lists for temporary lines with an expiry time */
+
 std::vector<KLine> klines;
 std::vector<GLine> glines;
 std::vector<ZLine> zlines;
 std::vector<QLine> qlines;
 std::vector<ELine> elines;
 
+/* Seperate lists for perm XLines that isnt checked by expiry functions */
+
+std::vector<KLine> pklines;
+std::vector<GLine> pglines;
+std::vector<ZLine> pzlines;
+std::vector<QLine> pqlines;
+std::vector<ELine> pelines;
+
+
+bool GSortComparison ( const GLine one, const GLine two );
+bool ZSortComparison ( const ZLine one, const ZLine two );
+bool ESortComparison ( const ELine one, const ELine two );
+bool QSortComparison ( const QLine one, const QLine two );
+bool KSortComparison ( const KLine one, const KLine two );
+
 // Reads the default bans from the config file.
 // only a very small number of bans are defined
 // this way these days, such as qlines against 
@@ -164,7 +201,15 @@ void add_gline(long duration, const char* source,const char* reason,const char*
 	strlcpy(item.source,source,255);
 	item.n_matches = 0;
 	item.set_time = TIME;
-	glines.push_back(item);
+	if (duration)
+	{
+		glines.push_back(item);
+		sort(glines.begin(), glines.end(),GSortComparison);
+	}
+	else
+	{
+		pglines.push_back(item);
+	}
 }
 
 // adds an e:line (exception to bans)
@@ -179,7 +224,15 @@ void add_eline(long duration, const char* source, const char* reason, const char
         strlcpy(item.source,source,255);
         item.n_matches = 0;
         item.set_time = TIME;
-        elines.push_back(item);
+	if (duration)
+	{
+        	elines.push_back(item);
+		sort(elines.begin(), elines.end(),ESortComparison);
+	}
+	else
+	{
+		pelines.push_back(item);
+	}
 }
 
 // adds a q:line
@@ -195,7 +248,15 @@ void add_qline(long duration, const char* source, const char* reason, const char
 	item.n_matches = 0;
 	item.is_global = false;
 	item.set_time = TIME;
-	qlines.push_back(item);
+	if (duration)
+	{
+		qlines.push_back(item);
+		sort(qlines.begin(), qlines.end(),QSortComparison);
+	}
+	else
+	{
+		pqlines.push_back(item);
+	}
 }
 
 // adds a z:line
@@ -217,7 +278,15 @@ void add_zline(long duration, const char* source, const char* reason, const char
 	item.n_matches = 0;
 	item.is_global = false;
 	item.set_time = TIME;
-	zlines.push_back(item);
+	if (duration)
+	{
+		zlines.push_back(item);
+		sort(zlines.begin(), zlines.end(),ZSortComparison);
+	}
+	else
+	{
+		pzlines.push_back(item);
+	}
 }
 
 // adds a k:line
@@ -232,7 +301,15 @@ void add_kline(long duration, const char* source, const char* reason, const char
 	strlcpy(item.source,source,255);
 	item.n_matches = 0;
 	item.set_time = TIME;
-	klines.push_back(item);
+	if (duration)
+	{
+		klines.push_back(item);
+		sort(klines.begin(), klines.end(),KSortComparison);
+	}
+	else
+	{
+		pklines.push_back(item);
+	}
 }
 
 // deletes a g:line, returns true if the line existed and was removed
@@ -247,6 +324,14 @@ bool del_gline(const char* hostmask)
 			return true;
 		}
 	}
+	for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
+	{
+		if (!strcasecmp(hostmask,i->hostmask))
+		{
+			pglines.erase(i);
+			return true;
+		}
+	}
 	return false;
 }
 
@@ -262,6 +347,14 @@ bool del_eline(const char* hostmask)
                         return true;
                 }
         }
+	for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)
+	{
+		if (!strcasecmp(hostmask,i->hostmask))
+		{
+			pelines.erase(i);
+			return true;
+		}
+	}
         return false;
 }
 
@@ -277,6 +370,14 @@ bool del_qline(const char* nickname)
 			return true;
 		}
 	}
+	for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
+	{
+		if (!strcasecmp(nickname,i->nick))
+		{
+			pqlines.erase(i);
+			return true;
+		}
+	}
 	return false;
 }
 
@@ -318,6 +419,14 @@ bool del_zline(const char* ipaddr)
 			return true;
 		}
 	}
+	for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
+	{
+		if (!strcasecmp(ipaddr,i->ipaddr))
+		{
+			pzlines.erase(i);
+			return true;
+		}
+	}
 	return false;
 }
 
@@ -333,6 +442,14 @@ bool del_kline(const char* hostmask)
 			return true;
 		}
 	}
+	for (std::vector<KLine>::iterator i = pklines.begin(); i != pklines.end(); i++)
+	{
+		if (!strcasecmp(hostmask,i->hostmask))
+		{
+			pklines.erase(i);
+			return true;
+		}
+	}
 	return false;
 }
 
@@ -343,12 +460,11 @@ char* matches_qline(const char* nick)
 	if (qlines.empty())
 		return NULL;
 	for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
-	{
 		if (match(nick,i->nick))
-		{
 			return i->reason;
-		}
-	}
+	for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
+		if (match(nick,i->nick))
+			return i->reason;
 	return NULL;
 }
 
@@ -359,12 +475,11 @@ char* matches_gline(const char* host)
         if (glines.empty())
                 return NULL;
 	for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
-	{
 		if (match(host,i->hostmask))
-		{
 			return i->reason;
-		}
-	}
+	for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
+		if (match(host,i->hostmask))
+			return i->reason;
 	return NULL;
 }
 
@@ -375,12 +490,11 @@ char* matches_exception(const char* host)
 	char host2[MAXBUF];
 	snprintf(host2,MAXBUF,"*@%s",host);
         for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
-        {
                 if ((match(host,i->hostmask)) || (match(host2,i->hostmask)))
-                {
                         return i->reason;
-                }
-        }
+	for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)
+		if ((match(host,i->hostmask)) || (match(host2,i->hostmask)))
+			return i->reason;
         return NULL;
 }
 
@@ -395,9 +509,38 @@ void gline_set_creation_time(char* host, time_t create_time)
 			return;
 		}
 	}
+	for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
+	{
+		if (!strcasecmp(host,i->hostmask))
+		{
+			i->set_time = create_time;
+			return;
+		}
+	}
 	return ;	
 }
 
+void eline_set_creation_time(char* host, time_t create_time)
+{
+	for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
+	{
+		if (!strcasecmp(host,i->hostmask))
+		{
+			i->set_time = create_time;
+			return;
+		}
+	}
+	for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)	
+	{
+		if (!strcasecmp(host,i->hostmask))
+		{
+			i->set_time = create_time;
+			return;
+		}
+	}
+	return;
+}
+
 void qline_set_creation_time(char* nick, time_t create_time)
 {
 	for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
@@ -408,7 +551,15 @@ void qline_set_creation_time(char* nick, time_t create_time)
 			return;
 		}
 	}
-	return ;	
+	for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
+	{
+		if (!strcasecmp(nick,i->nick))
+		{
+			i->set_time = create_time;
+			return;
+		}
+	}
+	return;
 }
 
 void zline_set_creation_time(char* ip, time_t create_time)
@@ -421,7 +572,15 @@ void zline_set_creation_time(char* ip, time_t create_time)
 			return;
 		}
 	}
-	return ;	
+	for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
+	{
+		if (!strcasecmp(ip,i->ipaddr))
+		{
+			i->set_time = create_time;
+			return;
+		}
+	}
+	return;
 }
 
 // returns a pointer to the reason if an ip address matches a zline, NULL if it didnt match
@@ -431,12 +590,11 @@ char* matches_zline(const char* ipaddr)
         if (zlines.empty())
                 return NULL;
 	for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
-	{
 		if (match(ipaddr,i->ipaddr))
-		{
 			return i->reason;
-		}
-	}
+	for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
+		if (match(ipaddr,i->ipaddr))
+			return i->reason;
 	return NULL;
 }
 
@@ -447,118 +605,85 @@ char* matches_kline(const char* host)
         if (klines.empty())
                 return NULL;
 	for (std::vector<KLine>::iterator i = klines.begin(); i != klines.end(); i++)
-	{
 		if (match(host,i->hostmask))
-		{
 			return i->reason;
-		}
-	}
+	for (std::vector<KLine>::iterator i = pklines.begin(); i != pklines.end(); i++)
+		if (match(host,i->hostmask))
+			return i->reason;
 	return NULL;
 }
 
+bool GSortComparison ( const GLine one, const GLine two )
+{
+	return (one.duration + one.set_time) < (two.duration + two.set_time);
+}
+
+bool ESortComparison ( const ELine one, const ELine two )
+{
+        return (one.duration + one.set_time) < (two.duration + two.set_time);
+}
+
+bool ZSortComparison ( const ZLine one, const ZLine two )
+{
+	return (one.duration + one.set_time) < (two.duration + two.set_time);
+}
+
+bool KSortComparison ( const KLine one, const KLine two )
+{
+        return (one.duration + one.set_time) < (two.duration + two.set_time);
+}
+
+bool QSortComparison ( const QLine one, const QLine two )
+{
+        return (one.duration + one.set_time) < (two.duration + two.set_time);
+}
+
 // removes lines that have expired
 
 void expire_lines()
 {
-	bool go_again = true;
 	time_t current = TIME;
-	
-	// because we mess up an iterator when we remove from the vector, we must bail from
-	// the loop early if we delete an item, therefore this outer while loop is required.
-	//
-	// 30/11/2005-- I can imagine that if we get a large number of *lines, this would perform dog slow.
-	// While we try and think of a better solution, for now I've simply split the loops up, instead of
-	// one huge while () -- this means if we remove a g-line, we only need to re-check glines, not z/g/.
-	// lines too, hopefully a little faster, even if it looks a little messier ;) --w00t
 
-	while (go_again)
-	{
-		go_again = false;
+	/* Because we now store all our XLines in sorted order using (i->duration + i->set_time) as a key, this
+	 * means that to expire the XLines we just need to do a while, picking off the top few until there are
+	 * none left at the head of the queue that are after the current time.
+	 */
 
-		for (std::vector<KLine>::iterator i = klines.begin(); i != klines.end(); i++)
-		{
-			if ((current > (i->duration + i->set_time)) && (i->duration > 0))
-			{
-				WriteOpers("Expiring timed K-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
-				klines.erase(i);
-				go_again = true;
-				break;
-			}
-		}
+	while ((glines.size()) && (current > (glines.begin()->duration + glines.begin()->set_time)))
+	{
+		std::vector<GLine>::iterator i = glines.begin();
+		WriteOpers("Expiring timed G-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
+		glines.erase(i);
 	}
 
-	go_again = true;
-
-	while (go_again)
+	while ((elines.size()) && (current > (elines.begin()->duration + elines.begin()->set_time)))
 	{
-		go_again = false;
-
-                for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
-                {
-                        if ((current > (i->duration + i->set_time)) && (i->duration > 0))
-                        {
-                                WriteOpers("Expiring timed E-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
-                                elines.erase(i);
-                                go_again = true;
-                                break;
-                        }
-                }
+		std::vector<ELine>::iterator i = elines.begin();
+		WriteOpers("Expiring timed E-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
+		elines.erase(i);
 	}
 
-	go_again = true;
-
-	while (go_again)
+	while ((zlines.size()) && (current > (zlines.begin()->duration + zlines.begin()->set_time)))
 	{
-		go_again = false;
-
-		for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
-		{
-			if ((current > (i->duration + i->set_time)) && (i->duration > 0))
-			{
-				WriteOpers("Expiring timed G-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
-				glines.erase(i);
-				go_again = true;
-				break;
-			}
-		}
+		std::vector<ZLine>::iterator i = zlines.begin();
+		WriteOpers("Expiring timed Z-Line %s (set by %s %d seconds ago)",i->ipaddr,i->source,i->duration);
+		zlines.erase(i);
 	}
 
-	go_again = true;
-
-	while (go_again)
+	while ((klines.size()) && (current > (klines.begin()->duration + klines.begin()->set_time)))
 	{
-		go_again = false;
-
-		for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
-		{
-			if ((current > (i->duration + i->set_time)) && (i->duration > 0))
-			{
-				WriteOpers("Expiring timed Z-Line %s (set by %s %d seconds ago)",i->ipaddr,i->source,i->duration);
-				zlines.erase(i);
-				go_again = true;
-				break;
-			}
-		}
+		std::vector<KLine>::iterator i = klines.begin();
+		WriteOpers("Expiring timed K-Line %s (set by %s %d seconds ago)",i->hostmask,i->source,i->duration);
+		klines.erase(i);
 	}
 
-	go_again = true;
-
-
-	while (go_again)
+	while ((qlines.size()) && (current > (qlines.begin()->duration + qlines.begin()->set_time)))
 	{
-		go_again = false;
-
-		for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
-		{
-			if ((current > (i->duration + i->set_time)) && (i->duration > 0))
-			{
-				WriteOpers("Expiring timed Q-Line %s (set by %s %d seconds ago)",i->nick,i->source,i->duration);
-				qlines.erase(i);
-				go_again = true;
-				break;
-			}
-		}
+		std::vector<QLine>::iterator i = qlines.begin();
+		WriteOpers("Expiring timed Q-Line %s (set by %s %d seconds ago)",i->nick,i->source,i->duration);
+		qlines.erase(i);
 	}
+	
 }
 
 // applies lines, removing clients and changing nicks etc as applicable
@@ -586,7 +711,7 @@ void apply_lines()
 					if (matches_exception(host))
 						continue;
 				}
-				if (glines.size())
+				if (glines.size() || pglines.size())
 				{
 					char* check = matches_gline(host);
 					if (check)
@@ -598,7 +723,7 @@ void apply_lines()
 						break;
 					}
 				}
-				if (klines.size())
+				if (klines.size() || pklines.size())
 				{
 					char* check = matches_kline(host);
 					if (check)
@@ -610,7 +735,7 @@ void apply_lines()
 						break;
 					}
 				}
-				if (qlines.size())
+				if (qlines.size() || pqlines.size())
 				{
 					char* check = matches_qline(u->second->nick);
 					if (check)
@@ -622,7 +747,7 @@ void apply_lines()
 						break;
 					}
 				}
-				if (zlines.size())
+				if (zlines.size() || pzlines.size())
 				{
 					char* check = matches_zline(u->second->ip);
 					if (check)
@@ -642,39 +767,39 @@ void apply_lines()
 void stats_k(userrec* user)
 {
 	for (std::vector<KLine>::iterator i = klines.begin(); i != klines.end(); i++)
-	{
 		WriteServ(user->fd,"216 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
-	}
+	for (std::vector<KLine>::iterator i = pklines.begin(); i != pklines.end(); i++)
+		WriteServ(user->fd,"216 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
 }
 
 void stats_g(userrec* user)
 {
 	for (std::vector<GLine>::iterator i = glines.begin(); i != glines.end(); i++)
-	{
 		WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
-	}
+	for (std::vector<GLine>::iterator i = pglines.begin(); i != pglines.end(); i++)
+		WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
 }
 
 void stats_q(userrec* user)
 {
 	for (std::vector<QLine>::iterator i = qlines.begin(); i != qlines.end(); i++)
-	{
 		WriteServ(user->fd,"217 %s :%s %d %d %s %s",user->nick,i->nick,i->set_time,i->duration,i->source,i->reason);
-	}
+	for (std::vector<QLine>::iterator i = pqlines.begin(); i != pqlines.end(); i++)
+		WriteServ(user->fd,"217 %s :%s %d %d %s %s",user->nick,i->nick,i->set_time,i->duration,i->source,i->reason);
 }
 
 void stats_z(userrec* user)
 {
 	for (std::vector<ZLine>::iterator i = zlines.begin(); i != zlines.end(); i++)
-	{
 		WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->ipaddr,i->set_time,i->duration,i->source,i->reason);
-	}
+	for (std::vector<ZLine>::iterator i = pzlines.begin(); i != pzlines.end(); i++)
+		WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->ipaddr,i->set_time,i->duration,i->source,i->reason);
 }
 
 void stats_e(userrec* user)
 {
         for (std::vector<ELine>::iterator i = elines.begin(); i != elines.end(); i++)
-        {
                 WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
-        }
+	for (std::vector<ELine>::iterator i = pelines.begin(); i != pelines.end(); i++)
+		WriteServ(user->fd,"223 %s :%s %d %d %s %s",user->nick,i->hostmask,i->set_time,i->duration,i->source,i->reason);
 }