1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
22 #include "inspircd_config.h"
23 #include "configreader.h"
32 #include "transport.h"
34 /* $ModDesc: Provides zlib link support for servers */
35 /* $LinkerFlags: -lz */
36 /* $ModDep: transport.h */
39 * Compressed data is transmitted across the link in the following format:
42 * +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
44 * +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
46 * Where: n is the size of a frame, in network byte order, 4 bytes.
47 * Z0 through Zn are Zlib compressed data, n bytes in length.
49 * If the module fails to read the entire frame, then it will buffer
50 * the portion of the last frame it received, then attempt to read
51 * the next part of the frame next time a write notification arrives.
53 * ZLIB_BEST_COMPRESSION (9) is used for all sending of data with
54 * a flush after each frame. A frame may contain multiple lines
55 * and should be treated as raw binary data.
59 enum izip_status { IZIP_OPEN, IZIP_CLOSED };
61 const unsigned int CHUNK = 128 * 1024;
63 class CountedBuffer : public classbase
65 std::string buffer; /* Current buffer contents */
66 unsigned int amount_expected; /* Amount of data expected */
73 void AddData(unsigned char* data, int data_length)
75 //printf("ADDDATA\n");
76 buffer.append((const char*)data, data_length);
77 this->NextFrameSize();
78 //printf("SIZE=%d %d\n",buffer.length(), data_length);
83 if ((!amount_expected) && (buffer.length() >= 4))
85 /* We have enough to read an int -
86 * Yes, this is safe, but its ugly. Give me
87 * a nicer way to read 4 bytes from a binary
88 * stream, and push them into a 32 bit int,
89 * and i'll consider replacing this.
91 amount_expected = ntohl((buffer[3] << 24) | (buffer[2] << 16) | (buffer[1] << 8) | buffer[0]);
92 //printf("EXPECT: %02x %02x %02x %02x\n", buffer[0], buffer[1], buffer[2], buffer[3]);
93 buffer = buffer.substr(4);
94 //printf("NEXTFRAME FS=%d SIZE=%d\n",amount_expected, buffer.length());
98 int GetFrame(unsigned char* frame, int maxsize)
102 /* We know how much we're expecting...
103 * Do we have enough yet?
105 if (buffer.length() >= amount_expected)
108 for (unsigned int i = 0; i < amount_expected; i++, j++)
109 frame[i] = buffer[i];
111 buffer = buffer.substr(j);
117 /* Not enough for a frame yet, COME AGAIN! */
122 /** Represents an ZIP user's extra data
124 class izip_session : public classbase
127 z_stream c_stream; /* compression stream */
128 z_stream d_stream; /* decompress stream */
131 CountedBuffer* inbuf;
135 class ModuleZLib : public Module
137 izip_session sessions[MAX_DESCRIPTORS];
138 float total_out_compressed;
139 float total_in_compressed;
140 float total_out_uncompressed;
141 float total_in_uncompressed;
145 ModuleZLib(InspIRCd* Me)
148 ServerInstance->PublishInterface("InspSocketHook", this);
150 total_out_compressed = total_in_compressed = 0;
151 total_out_uncompressed = total_out_uncompressed = 0;
154 virtual ~ModuleZLib()
158 virtual Version GetVersion()
160 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
163 void Implements(char* List)
165 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = 1;
166 List[I_OnStats] = List[I_OnRequest] = 1;
169 virtual char* OnRequest(Request* request)
171 ISHRequest* ISR = (ISHRequest*)request;
172 if (strcmp("IS_NAME", request->GetId()) == 0)
176 else if (strcmp("IS_HOOK", request->GetId()) == 0)
181 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
183 catch (ModuleException& e)
189 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
191 return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
193 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
197 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
204 virtual int OnStats(char symbol, userrec* user, string_list &results)
208 std::string sn = ServerInstance->Config->ServerName;
210 float outbound_r = 100 - ((total_out_compressed / (total_out_uncompressed + 0.001)) * 100);
211 float inbound_r = 100 - ((total_in_compressed / (total_in_uncompressed + 0.001)) * 100);
213 float total_compressed = total_in_compressed + total_out_compressed;
214 float total_uncompressed = total_in_uncompressed + total_out_uncompressed;
216 float total_r = 100 - ((total_compressed / (total_uncompressed + 0.001)) * 100);
218 char outbound_ratio[MAXBUF], inbound_ratio[MAXBUF], combined_ratio[MAXBUF];
220 sprintf(outbound_ratio, "%3.2f%%", outbound_r);
221 sprintf(inbound_ratio, "%3.2f%%", inbound_r);
222 sprintf(combined_ratio, "%3.2f%%", total_r);
224 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS outbound_compressed = "+ConvToStr(total_out_compressed));
225 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS inbound_compressed = "+ConvToStr(total_in_compressed));
226 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS outbound_uncompressed = "+ConvToStr(total_out_uncompressed));
227 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS inbound_uncompressed = "+ConvToStr(total_in_uncompressed));
228 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS outbound_ratio = "+outbound_ratio);
229 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS inbound_ratio = "+inbound_ratio);
230 results.push_back(sn+" 304 "+user->nick+" :ZIPSTATS combined_ratio = "+combined_ratio);
237 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
239 izip_session* session = &sessions[fd];
241 /* allocate deflate state */
243 session->status = IZIP_OPEN;
245 session->inbuf = new CountedBuffer();
246 ServerInstance->Log(DEBUG,"session->inbuf ALLOC = %d, %08x", fd, session->inbuf);
248 session->c_stream.zalloc = (alloc_func)0;
249 session->c_stream.zfree = (free_func)0;
250 session->c_stream.opaque = (voidpf)0;
252 session->d_stream.zalloc = (alloc_func)0;
253 session->d_stream.zfree = (free_func)0;
254 session->d_stream.opaque = (voidpf)0;
257 virtual void OnRawSocketConnect(int fd)
259 OnRawSocketAccept(fd, "", 0);
262 virtual void OnRawSocketClose(int fd)
264 CloseSession(&sessions[fd]);
267 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
269 izip_session* session = &sessions[fd];
271 if (session->status == IZIP_CLOSED)
274 unsigned char compr[CHUNK + 1];
276 readresult = read(fd, compr, CHUNK);
280 session->inbuf->AddData(compr, readresult);
284 while ((size = session->inbuf->GetFrame(compr, CHUNK)) != 0)
286 unsigned char localbuf[count + 1];
288 session->d_stream.next_in = (Bytef*)compr;
289 session->d_stream.avail_in = 0;
290 session->d_stream.next_out = (Bytef*)localbuf;
291 if (inflateInit(&session->d_stream) != Z_OK)
294 while ((session->d_stream.total_out < count) && (session->d_stream.total_in < (unsigned int)size))
296 session->d_stream.avail_in = session->d_stream.avail_out = 1;
297 if (inflate(&session->d_stream, Z_NO_FLUSH) == Z_STREAM_END)
301 inflateEnd(&session->d_stream);
303 localbuf[session->d_stream.total_out] = 0;
304 str_out.append((const char*)localbuf);
305 total_in_compressed += readresult;
306 readresult = session->d_stream.total_out;
307 total_in_uncompressed += session->d_stream.total_out;
310 memcpy(buffer, str_out.data(), str_out.length() > count ? count : str_out.length());
311 readresult = str_out.length();
313 return (readresult > 0);
316 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
318 ServerInstance->Log(DEBUG,"Compressing %d bytes", count);
320 izip_session* session = &sessions[fd];
325 ServerInstance->Log(DEBUG,"Nothing to do!");
329 if(session->status != IZIP_OPEN)
331 CloseSession(session);
335 unsigned char compr[CHUNK];
337 if (deflateInit(&session->c_stream, Z_BEST_COMPRESSION) != Z_OK)
339 ServerInstance->Log(DEBUG,"Deflate init failed");
342 session->c_stream.next_in = (Bytef*)buffer;
343 session->c_stream.next_out = compr+4;
345 while ((session->c_stream.total_in < (unsigned int)count) && (session->c_stream.total_out < CHUNK))
347 session->c_stream.avail_in = session->c_stream.avail_out = 1; /* force small buffers */
348 if (deflate(&session->c_stream, Z_NO_FLUSH) != Z_OK)
350 ServerInstance->Log(DEBUG,"Couldnt deflate!");
351 CloseSession(session);
355 /* Finish the stream, still forcing small buffers: */
358 session->c_stream.avail_out = 1;
359 if (deflate(&session->c_stream, Z_FINISH) == Z_STREAM_END)
363 deflateEnd(&session->c_stream);
365 total_out_uncompressed += ocount;
366 total_out_compressed += session->c_stream.total_out;
368 int x = htonl(session->c_stream.total_out);
369 /** XXX: We memcpy it onto the start of the buffer like this to save ourselves a write().
370 * A memcpy of 4 or so bytes is less expensive and gives the tcp stack more chance of
371 * assembling the frame size into the same packet as the compressed frame.
373 memcpy(compr, &x, sizeof(x));
375 session->outbuf.append((const char*)compr, session->c_stream.total_out+4);
377 int ret = write(fd, session->outbuf.data(), session->outbuf.length());
380 session->outbuf = session->outbuf.substr(ret);
389 session->outbuf = "";
395 session->outbuf = "";
400 ServerInstance->Log(DEBUG,"Sending frame of size %d", ntohl(x));
402 /* ALL LIES the lot of it, we havent really written
403 * this amount, but the layer above doesnt need to know.
408 void CloseSession(izip_session* session)
410 if (session->status = IZIP_OPEN)
412 session->status = IZIP_CLOSED;
413 session->outbuf = "";
414 delete session->inbuf;
420 class ModuleZLibFactory : public ModuleFactory
431 virtual Module * CreateModule(InspIRCd* Me)
433 return new ModuleZLib(Me);
438 extern "C" void * init_module( void )
440 return new ModuleZLibFactory;