2 * IRC - Internet Relay Chat, ircd/list.c
3 * Copyright (C) 1990 Jarkko Oikarinen and
4 * University of Oulu, Finland
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 1, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include "ircd_alloc.h"
28 #include "ircd_events.h"
29 #include "ircd_reply.h"
30 #include "ircd_string.h"
47 #include <stddef.h> /* offsetof */
48 #include <unistd.h> /* close */
52 static struct liststats {
54 } clients, connections, users, servs, links;
57 static unsigned int clientAllocCount;
58 static struct Client* clientFreeList;
60 static unsigned int connectionAllocCount;
61 static struct Connection* connectionFreeList;
63 static unsigned int slinkAllocCount;
64 static struct SLink* slinkFreeList;
69 struct Connection* con;
72 * pre-allocate MAXCONNECTIONS clients and connections
74 for (i = 0; i < MAXCONNECTIONS; ++i) {
75 cptr = (struct Client*) MyMalloc(sizeof(struct Client));
76 cli_next(cptr) = clientFreeList;
77 clientFreeList = cptr;
80 con = (struct Connection*) MyMalloc(sizeof(struct Connection));
81 con_next(con) = connectionFreeList;
82 connectionFreeList = con;
83 ++connectionAllocCount;
87 memset(&clients, 0, sizeof(clients));
88 memset(&connections, 0, sizeof(connections));
89 memset(&users, 0, sizeof(users));
90 memset(&servs, 0, sizeof(servs));
91 memset(&links, 0, sizeof(links));
95 static struct Client* alloc_client(void)
97 struct Client* cptr = clientFreeList;
100 cptr = (struct Client*) MyMalloc(sizeof(struct Client));
103 clientFreeList = cli_next(cptr);
109 memset(cptr, 0, sizeof(struct Client));
114 static void dealloc_client(struct Client* cptr)
116 assert(cli_verify(cptr));
117 assert(0 == cli_connect(cptr));
123 cli_next(cptr) = clientFreeList;
124 clientFreeList = cptr;
129 static struct Connection* alloc_connection(void)
131 struct Connection* con = connectionFreeList;
134 con = (struct Connection*) MyMalloc(sizeof(struct Connection));
135 ++connectionAllocCount;
137 connectionFreeList = con_next(con);
143 memset(con, 0, sizeof(struct Connection));
144 timer_init(&(con_proc(con)));
149 static void dealloc_connection(struct Connection* con)
151 assert(con_verify(con));
152 assert(!t_active(&(con_proc(con))));
153 assert(!t_onqueue(&(con_proc(con))));
155 Debug((DEBUG_LIST, "Deallocating connection %p", con));
157 if (con_dns_reply(con))
158 --(con_dns_reply(con)->ref_count);
159 if (-1 < con_fd(con))
161 MsgQClear(&(con_sendQ(con)));
162 client_drop_sendq(con);
163 DBufClear(&(con_recvQ(con)));
164 if (con_listener(con))
165 release_listener(con_listener(con));
171 con_next(con) = connectionFreeList;
172 connectionFreeList = con;
178 * Create a new struct Client structure and set it to initial state.
180 * from == NULL, create local client (a client connected to a socket).
182 * from != NULL, create remote client (behind a socket associated with
183 * the client defined by 'from').
184 * ('from' is a local client!!).
186 struct Client* make_client(struct Client *from, int status)
188 struct Client* cptr = 0;
189 struct Connection* con = 0;
191 assert(!from || cli_verify(from));
193 cptr = alloc_client();
196 assert(!cli_magic(cptr));
197 assert(0 == from || 0 != cli_connect(from));
199 if (!from) { /* local client, allocate a struct Connection */
200 con = alloc_connection();
203 assert(!con_magic(con));
205 con_magic(con) = CONNECTION_MAGIC;
206 con_fd(con) = -1; /* initialize struct Connection */
207 con_freeflag(con) = 0;
208 con_nextnick(con) = CurrentTime - NICK_DELAY;
209 con_nexttarget(con) = CurrentTime - (TARGET_DELAY * (STARTTARGETS - 1));
210 con_handler(con) = UNREGISTERED_HANDLER;
211 con_client(con) = cptr;
213 cli_local(cptr) = 1; /* Set certain fields of the struct Client */
214 cli_since(cptr) = cli_lasttime(cptr) = cli_firsttime(cptr) = CurrentTime;
215 cli_lastnick(cptr) = TStime();
217 con = cli_connect(from); /* use 'from's connection */
220 assert(con_verify(con));
222 cli_magic(cptr) = CLIENT_MAGIC;
223 cli_connect(cptr) = con; /* set the connection and other fields */
224 cli_status(cptr) = status;
225 cli_hnext(cptr) = cptr;
226 strcpy(cli_username(cptr), "unknown");
231 void free_connection(struct Connection* con)
236 assert(con_verify(con));
237 assert(0 == con_client(con));
239 dealloc_connection(con); /* deallocate the connection */
242 void free_client(struct Client* cptr)
247 * forget to remove the client from the hash table?
249 assert(cli_verify(cptr));
250 assert(cli_hnext(cptr) == cptr);
251 /* or from linked list? */
252 assert(cli_next(cptr) == 0);
253 assert(cli_prev(cptr) == 0);
255 Debug((DEBUG_LIST, "Freeing client %s [%p], connection %p", cli_name(cptr),
256 cptr, cli_connect(cptr)));
259 destroy_auth_request(cli_auth(cptr), 0);
261 /* Make sure we didn't magically get re-added to the list */
262 assert(cli_next(cptr) == 0);
263 assert(cli_prev(cptr) == 0);
265 if (cli_from(cptr) == cptr) { /* in other words, we're local */
267 /* timer must be marked as not active */
268 if (!cli_freeflag(cptr) && !t_active(&(cli_proc(cptr))))
269 dealloc_connection(cli_connect(cptr)); /* connection not open anymore */
271 if (-1 < cli_fd(cptr) && cli_freeflag(cptr) & FREEFLAG_SOCKET)
272 socket_del(&(cli_socket(cptr))); /* queue a socket delete */
273 if (cli_freeflag(cptr) & FREEFLAG_TIMER)
274 timer_del(&(cli_proc(cptr))); /* queue a timer delete */
278 cli_connect(cptr) = 0;
280 dealloc_client(cptr); /* actually destroy the client */
283 struct Server *make_server(struct Client *cptr)
285 struct Server *serv = cli_serv(cptr);
287 assert(cli_verify(cptr));
291 serv = (struct Server*) MyMalloc(sizeof(struct Server));
293 memset(serv, 0, sizeof(struct Server)); /* All variables are 0 by default */
297 cli_serv(cptr) = serv;
298 cli_serv(cptr)->lag = 60000;
300 DupString(serv->last_error_msg, "<>"); /* String must be non-empty */
302 return cli_serv(cptr);
306 * Taken the code from ExitOneClient() for this and placed it here.
309 void remove_client_from_list(struct Client *cptr)
311 assert(cli_verify(cptr));
312 assert(con_verify(cli_connect(cptr)));
313 assert(!cli_prev(cptr) || cli_verify(cli_prev(cptr)));
314 assert(!cli_next(cptr) || cli_verify(cli_next(cptr)));
317 /* Only try remove cptr from the list if it IS in the list.
318 * cli_next(cptr) cannot be NULL here, as &me is always the end
319 * the list, and we never remove &me. -GW
324 cli_next(cli_prev(cptr)) = cli_next(cptr);
326 GlobalClientList = cli_next(cptr);
327 cli_prev(GlobalClientList) = 0;
329 cli_prev(cli_next(cptr)) = cli_prev(cptr);
331 cli_next(cptr) = cli_prev(cptr) = 0;
333 if (IsUser(cptr) && cli_user(cptr)) {
334 add_history(cptr, 0);
337 if (cli_user(cptr)) {
338 free_user(cli_user(cptr));
342 if (cli_serv(cptr)) {
343 if (cli_serv(cptr)->user) {
344 free_user(cli_serv(cptr)->user);
345 cli_serv(cptr)->user = 0;
347 if (cli_serv(cptr)->client_list)
348 MyFree(cli_serv(cptr)->client_list);
349 MyFree(cli_serv(cptr)->last_error_msg);
350 MyFree(cli_serv(cptr));
359 * Although only a small routine, it appears in a number of places
360 * as a collection of a few lines...functions like this *should* be
361 * in this file, shouldnt they ? after all, this is list.c, isn't it ?
364 void add_client_to_list(struct Client *cptr)
366 assert(cli_verify(cptr));
367 assert(cli_next(cptr) == 0);
368 assert(cli_prev(cptr) == 0);
371 * Since we always insert new clients to the top of the list,
372 * this should mean the "me" is the bottom most item in the list.
373 * XXX - don't always count on the above, things change
376 cli_next(cptr) = GlobalClientList;
377 GlobalClientList = cptr;
379 cli_prev(cli_next(cptr)) = cptr;
383 /* WARNING: Major CPU sink!
385 * This is a debugging routine meant to verify the integrity of the client
386 * linked list. It is meant to be comprehensive, to detect *any* corruption
387 * of that list. This means that it will be majorly CPU-intensive, and
388 * should *only* be enabled on servers that have DEBUGMODE enabled. Ignore
389 * this warning at your peril!
391 void verify_client_list(void)
393 struct Client *client, *prev = 0, *sentinel = 0;
394 extern unsigned int ircrandom(void);
396 for (client = GlobalClientList; client; client = cli_next(client)) {
397 /* Verify that this is a valid client, not a free'd one */
398 assert(cli_verify(client));
399 /* Verify that the list hasn't suddenly jumped around */
400 assert(cli_prev(client) == prev);
401 /* Verify that the list hasn't become circular */
402 assert(cli_next(client) != GlobalClientList);
403 assert(!sentinel || client != sentinel);
405 prev = client; /* Remember what should preceed us */
406 if (!(ircrandom() % 50)) /* probabilistic loop detector */
410 #endif /* DEBUGMODE */
413 * Look for ptr in the linked listed pointed to by link.
415 struct SLink *find_user_link(struct SLink *lp, struct Client *ptr)
419 if (lp->value.cptr == ptr)
427 struct SLink* make_link(void)
429 struct SLink* lp = slinkFreeList;
431 slinkFreeList = lp->next;
433 lp = (struct SLink*) MyMalloc(sizeof(struct SLink));
443 void free_link(struct SLink* lp)
446 lp->next = slinkFreeList;
454 struct DLink *add_dlink(struct DLink **lpp, struct Client *cp)
456 struct DLink* lp = (struct DLink*) MyMalloc(sizeof(struct DLink));
460 if ((lp->next = *lpp))
466 void remove_dlink(struct DLink **lpp, struct DLink *lp)
472 if ((lp->prev->next = lp->next))
473 lp->next->prev = lp->prev;
475 else if ((*lpp = lp->next))
476 lp->next->prev = NULL;
481 void send_listinfo(struct Client *cptr, char *name)
483 int inuse = 0, mem = 0, tmp = 0;
485 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Clients: inuse: %d(%d)",
486 clients.inuse, tmp = clients.inuse * sizeof(struct Client));
488 inuse += clients.inuse;
489 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, "Connections: inuse: %d(%d)",
491 tmp = connections.inuse * sizeof(struct Connection));
493 inuse += connections.inuse;
494 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Users: inuse: %d(%d)",
495 users.inuse, tmp = users.inuse * sizeof(struct User));
497 inuse += users.inuse;
498 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Servs: inuse: %d(%d)",
499 servs.inuse, tmp = servs.inuse * sizeof(struct Server));
501 inuse += servs.inuse;
502 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Links: inuse: %d(%d)",
503 links.inuse, tmp = links.inuse * sizeof(struct SLink));
505 inuse += links.inuse;
506 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Confs: inuse: %d(%d)",
507 GlobalConfCount, tmp = GlobalConfCount * sizeof(struct ConfItem));
509 inuse += GlobalConfCount;
510 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Totals: inuse %d %d",