ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/src/whowas.c
(Generate patch)

Comparing:
ircd-hybrid-7.3/src/whowas.c (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC vs.
ircd-hybrid/trunk/src/whowas.c (file contents), Revision 7441 by michael, Thu Mar 10 20:21:20 2016 UTC

# Line 1 | Line 1
1   /*
2 < *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3 < *  whowas.c: WHOWAS user cache.
2 > *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3   *
4 < *  Copyright (C) 2005 by the past and present ircd coders, and others.
4 > *  Copyright (c) 1997-2016 ircd-hybrid development team
5   *
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
# Line 16 | Line 15
15   *
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307
18 > *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19   *  USA
20 < *
21 < *  $Id$
20 > */
21 >
22 > /*! \file whowas.c
23 > * \brief WHOWAS user cache.
24 > * \version $Id$
25   */
26  
27   #include "stdinc.h"
28 + #include "list.h"
29 + #include "mempool.h"
30   #include "whowas.h"
31   #include "client.h"
28 #include "common.h"
32   #include "hash.h"
33   #include "irc_string.h"
34   #include "ircd.h"
32 #include "ircd_defs.h"
33 #include "numeric.h"
34 #include "s_serv.h"
35 #include "s_user.h"
35   #include "send.h"
36 < #include "s_conf.h"
37 < #include "memory.h"
36 > #include "conf.h"
37 >
38  
39 < /* internally defined function */
41 < static void add_whowas_to_clist(struct Whowas **, struct Whowas *);
42 < static void del_whowas_from_clist(struct Whowas **, struct Whowas *);
43 < static void add_whowas_to_list(struct Whowas **, struct Whowas *);
44 < static void del_whowas_from_list(struct Whowas **, struct Whowas *);
39 > static mp_pool_t *whowas_pool;
40  
41 < struct Whowas WHOWAS[NICKNAMEHISTORYLENGTH];
42 < struct Whowas *WHOWASHASH[HASHSIZE];
41 > static dlink_list whowas_list;  /*! Chain of struct Whowas pointers */
42 > dlink_list WHOWASHASH[HASHSIZE];
43  
49 static unsigned int whowas_next = 0;
44  
45 + /*! \brief Initializes the whowas memory pool
46 + */
47   void
48 < add_history(struct Client *client_p, int online)
48 > whowas_init(void)
49   {
50 <  struct Whowas *who = &WHOWAS[whowas_next];
50 >  whowas_pool = mp_pool_new(sizeof(struct Membership), MP_CHUNK_SIZE_WHOWAS);
51 > }
52  
53 <  assert(client_p && client_p->servptr);
53 > /*! \brief Unlinks a Whowas struct from its associated lists.
54 > * \param whowas Pointer to Whowas struct to be unlinked
55 > */
56 > static struct Whowas *
57 > whowas_unlink(struct Whowas *whowas)
58 > {
59 >  if (!whowas)  /* Can be NULL. */
60 >    return NULL;
61  
62 <  if (who->hashv != -1)
63 <  {
60 <    if (who->online)
61 <      del_whowas_from_clist(&(who->online->whowas),who);
62 <    del_whowas_from_list(&WHOWASHASH[who->hashv], who);
63 <  }
62 >  if (whowas->online)
63 >    dlinkDelete(&whowas->cnode, &whowas->online->whowas);
64  
65 <  who->hashv = strhash(client_p->name);
66 <  who->logoff = CurrentTime;
65 >  dlinkDelete(&whowas->tnode, &WHOWASHASH[whowas->hashv]);
66 >  dlinkDelete(&whowas->lnode, &whowas_list);
67  
68 <  /* NOTE: strcpy ok here, the sizes in the client struct MUST
69 <   * match the sizes in the whowas struct
70 <   */
71 <  strlcpy(who->name, client_p->name, sizeof(who->name));
72 <  strcpy(who->username, client_p->username);
73 <  strcpy(who->hostname, client_p->host);
74 <  strcpy(who->realname, client_p->info);
68 >  return whowas;
69 > }
70  
71 <  strlcpy(who->servername, client_p->servptr->name, sizeof(who->servername));
71 > /*! \brief Unlinks a Whowas struct from its associated lists
72 > *         and returns memory back to the pooling allocator.
73 > * \param whowas Pointer to Whowas struct to be unlinked and freed
74 > */
75 > static void
76 > whowas_free(struct Whowas *whowas)
77 > {
78 >  whowas_unlink(whowas);
79 >  mp_pool_release(whowas);
80 > }
81  
82 <  if (online)
83 <  {
84 <    who->online = client_p;
85 <    add_whowas_to_clist(&(client_p->whowas), who);
86 <  }
87 <  else
88 <    who->online = NULL;
82 > /*! \brief Returns a Whowas struct for further use. Either allocates
83 > *         a new one, or returns the oldest entry from the whowas_list
84 > *         if it ran over ConfigGeneral.whowas_history_length
85 > */
86 > static struct Whowas *
87 > whowas_make(void)
88 > {
89 >  struct Whowas *whowas;
90  
91 <  add_whowas_to_list(&WHOWASHASH[who->hashv], who);
92 <  whowas_next++;
91 >  if (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
92 >    whowas = whowas_unlink(whowas_list.tail->data);  /* Re-use oldest item */
93 >  else
94 >    whowas = mp_pool_get(whowas_pool);
95  
96 <  if (whowas_next == NICKNAMEHISTORYLENGTH)
90 <    whowas_next = 0;
96 >  return whowas;
97   }
98  
99 + /*! \brief Trims the whowas_list if necessary until there are no
100 + *         more than ConfigGeneral.whowas_history_length Whowas
101 + *         struct items.
102 + */
103   void
104 < off_history(struct Client *client_p)
104 > whowas_trim(void)
105   {
106 <  struct Whowas *temp, *next;
97 <
98 <  for (temp = client_p->whowas; temp; temp=next)
106 >  while (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
107    {
108 <    next = temp->cnext;
109 <    temp->online = NULL;
110 <    del_whowas_from_clist(&(client_p->whowas), temp);
108 >    if (!whowas_list.tail->data)
109 >      return;  /* whowas_list is now empty. No more items can be freed. */
110 >
111 >    whowas_free(whowas_list.tail->data);
112    }
113   }
114  
115 < struct Client *
116 < get_history(const char *nick, time_t timelimit)
115 > /*! \brief Adds the currently defined name of the client to history.
116 > *         Usually called before changing to a new name (nick).
117 > *         Client must be a fully registered user.
118 > * \param client_p pointer to Client struct to add
119 > * \param online   either 1 if it's a nick change or 0 on client exit
120 > */
121 > void
122 > whowas_add_history(struct Client *client_p, const int online)
123   {
124 <  struct Whowas *temp;
124 >  struct Whowas *whowas = whowas_make();
125  
126 <  timelimit = CurrentTime - timelimit;
127 <  temp = WHOWASHASH[strhash(nick)];
126 >  if (!whowas)  /* Can be NULL. */
127 >    return;
128  
129 <  for (; temp; temp = temp->next)
115 <  {
116 <    if (irccmp(nick, temp->name))
117 <      continue;
118 <    if (temp->logoff < timelimit)
119 <      continue;
120 <    return(temp->online);
121 <  }
129 >  assert(IsClient(client_p));
130  
131 <  return(NULL);
132 < }
131 >  whowas->hashv = strhash(client_p->name);
132 >  whowas->shide = IsHidden(client_p->servptr) != 0;
133 >  whowas->logoff = CurrentTime;
134 >
135 >  strlcpy(whowas->account, client_p->account, sizeof(whowas->account));
136 >  strlcpy(whowas->name, client_p->name, sizeof(whowas->name));
137 >  strlcpy(whowas->username, client_p->username, sizeof(whowas->username));
138 >  strlcpy(whowas->hostname, client_p->host, sizeof(whowas->hostname));
139 >  strlcpy(whowas->sockhost, client_p->sockhost, sizeof(whowas->sockhost));
140 >  strlcpy(whowas->realname, client_p->info, sizeof(whowas->realname));
141 >  strlcpy(whowas->servername, client_p->servptr->name, sizeof(whowas->servername));
142  
143 < void
127 < count_whowas_memory(unsigned int *wwu, uint64_t *wwum)
128 < {
129 <  const struct Whowas *tmp;
130 <  int i;
131 <  unsigned int u = 0;
132 <  uint64_t um = 0;
133 <
134 <  /* count the number of used whowas structs in 'u'   */
135 <  /* count up the memory used of whowas structs in um */
136 <  for (i = 0, tmp = &WHOWAS[0]; i < NICKNAMEHISTORYLENGTH; ++i, ++tmp)
143 >  if (online)
144    {
145 <    if (tmp->hashv != -1)
146 <    {
140 <      ++u;
141 <      um += sizeof(struct Whowas);
142 <    }
145 >    whowas->online = client_p;
146 >    dlinkAdd(whowas, &whowas->cnode, &client_p->whowas);
147    }
148 +  else
149 +    whowas->online = NULL;
150  
151 <  *wwu = u;
152 <  *wwum = um;
151 >  dlinkAdd(whowas, &whowas->tnode, &WHOWASHASH[whowas->hashv]);
152 >  dlinkAdd(whowas, &whowas->lnode, &whowas_list);
153   }
154  
155 + /*! \brief This must be called when the client structure is about to
156 + *         be released. History mechanism keeps pointers to client
157 + *         structures and it must know when they cease to exist.
158 + * \param client_p pointer to Client struct
159 + */
160   void
161 < init_whowas(void)
161 > whowas_off_history(struct Client *client_p)
162   {
163 <  int i;
153 <
154 <  for (i = 0; i < NICKNAMEHISTORYLENGTH; i++)
163 >  while (client_p->whowas.head)
164    {
165 <    memset(&WHOWAS[i], 0, sizeof(struct Whowas));
157 <    WHOWAS[i].hashv = -1;
158 <  }
165 >    struct Whowas *whowas = client_p->whowas.head->data;
166  
167 <  for (i = 0; i < HASHSIZE; ++i)
168 <    WHOWASHASH[i] = NULL;        
167 >    whowas->online = NULL;
168 >    dlinkDelete(&whowas->cnode, &client_p->whowas);
169 >  }
170   }
171  
172 < static void
173 < add_whowas_to_clist(struct Whowas **bucket, struct Whowas *whowas)
172 > /*! \brief Returns the current client that was using the given
173 > *         nickname within the timelimit. Returns NULL, if no
174 > *         one found.
175 > * \param name      name of the nick
176 > * \param timelimit maximum age for a client since log-off
177 > */
178 > struct Client *
179 > whowas_get_history(const char *name, uintmax_t timelimit)
180   {
181 <  whowas->cprev = NULL;
181 >  dlink_node *node = NULL;
182  
183 <  if ((whowas->cnext = *bucket) != NULL)
170 <    whowas->cnext->cprev = whowas;
171 <  *bucket = whowas;
172 < }
173 <
174 < static void
175 < del_whowas_from_clist(struct Whowas **bucket, struct Whowas *whowas)
176 < {
177 <  if (whowas->cprev)
178 <    whowas->cprev->cnext = whowas->cnext;
179 <  else
180 <    *bucket = whowas->cnext;
181 <  if (whowas->cnext)
182 <    whowas->cnext->cprev = whowas->cprev;
183 < }
183 >  timelimit = CurrentTime - timelimit;
184  
185 < static void
186 < add_whowas_to_list(struct Whowas **bucket, struct Whowas *whowas)
187 < {
188 <  whowas->prev = NULL;
185 >  DLINK_FOREACH(node, WHOWASHASH[strhash(name)].head)
186 >  {
187 >    struct Whowas *whowas = node->data;
188  
189 <  if ((whowas->next = *bucket) != NULL)
190 <    whowas->next->prev = whowas;
191 <  *bucket = whowas;
189 >    if (whowas->logoff < timelimit)
190 >      continue;
191 >    if (irccmp(name, whowas->name))
192 >      continue;
193 >    return whowas->online;
194 >  }
195 >
196 >  return NULL;
197   }
198 <
199 < static void
200 < del_whowas_from_list(struct Whowas **bucket, struct Whowas *whowas)
198 >
199 > /*! \brief For debugging. Counts allocated structures stored in whowas_list
200 > */
201 > void
202 > whowas_count_memory(unsigned int *const count, size_t *const bytes)
203   {
204 <  if (whowas->prev)
205 <    whowas->prev->next = whowas->next;
200 <  else
201 <    *bucket = whowas->next;
202 <  if (whowas->next)
203 <    whowas->next->prev = whowas->prev;
204 >  (*count) = dlink_list_length(&whowas_list);
205 >  (*bytes) = dlink_list_length(&whowas_list) * sizeof(struct Whowas);
206   }

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)