simple-cache.c 65.6 KB
Newer Older
Linus Tolke Y's avatar
Linus Tolke Y committed
1
/*
2
 * $Id: simple-cache.c,v 0.100 2002/11/04 23:20:00 ceder Exp $
Per Cederqvist's avatar
Per Cederqvist committed
3
 * Copyright (C) 1991-2002  Lysator Academic Computer Association.
Linus Tolke Y's avatar
Linus Tolke Y committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * This file is part of the LysKOM server.
 * 
 * LysKOM is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; either version 1, or (at your option) 
 * any later version.
 * 
 * LysKOM is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LysKOM; see the file COPYING.  If not, write to
 * Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
 * or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
 * MA 02139, USA.
 *
 * Please mail bug reports to bug-lyskom@lysator.liu.se. 
 */
Per Cederqvist's avatar
Per Cederqvist committed
25 26 27 28 29 30 31 32 33
/*
 * This module contains some simple simulations of the routines in
 * cache.c.
 *
 * Extracted from ram-cache.c and rewritten by ceder.
 *
 * New database format with texts in their own file by Inge Wallin.
 *
 * New save algorithm by ceder.
David Byers's avatar
David Byers committed
34
 * Attempt at newer algorithm by byers (FASTSAVE)
Per Cederqvist's avatar
Per Cederqvist committed
35 36
 */

David Byers's avatar
David Byers committed
37 38 39 40 41

#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

Per Cederqvist's avatar
Per Cederqvist committed
42 43
#include <errno.h>
#include <stdio.h>
David Byers's avatar
Server:  
David Byers committed
44 45 46
#ifdef HAVE_STDLIB_H
#   include <stdlib.h>
#endif
Per Cederqvist's avatar
Per Cederqvist committed
47
#include <sys/types.h>
48 49 50
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif
51 52 53
#ifdef HAVE_STRING_H
#  include <string.h>
#endif
Per Cederqvist's avatar
Per Cederqvist committed
54 55 56 57
#ifndef SEEK_END
#  include <fcntl.h>
#endif
#ifndef SEEK_END
Per Cederqvist's avatar
Per Cederqvist committed
58 59 60
#  define SEEK_SET 0
#  define SEEK_END 2
#endif
Per Cederqvist's avatar
Per Cederqvist committed
61 62 63
#include <time.h>
#include <setjmp.h>

64
#include "ldifftime.h"
Per Cederqvist's avatar
Per Cederqvist committed
65 66
#include "exp.h"
#include "misc-types.h"
67
#include "s-string.h"
Per Cederqvist's avatar
Per Cederqvist committed
68 69 70 71 72 73 74 75 76 77 78 79 80
#include "kom-types.h"
#include "cache-node.h"
#include "cache.h"
#include "parser.h"
#include "ram-parse.h"
#include "ram-output.h"
#include "server/smalloc.h"
#include "kom-memory.h"
#include "lyskomd.h"
#include "debug.h"
#include "kom-errno.h"
#include "log.h"
#include "com.h"
81
#include "async.h"
Per Cederqvist's avatar
Per Cederqvist committed
82 83
#include "connections.h"
#include "send-async.h"
84
#include "param.h"
David Byers's avatar
David Byers committed
85
#include "kom-config.h"
David Byers's avatar
David Byers committed
86
#include "admin.h"
87
#include "unused.h"
88
#include "local-to-global.h"
89
#include "server-time.h"
90
#include "eintr.h"
Per Cederqvist's avatar
Per Cederqvist committed
91 92

/*
93
 * Possible improvements:
Per Cederqvist's avatar
Per Cederqvist committed
94
 *
95 96 97
 *  FIXME (bug 167): When there are consecutive items in file A that
 *  shall be copied to file B, copy them in one transfer (up to a
 *  certain limit).
Per Cederqvist's avatar
Per Cederqvist committed
98 99 100 101 102 103 104
 */

/*
 * All functions that can fail sets kom_errno to a suitable value
 * if they fail.
 */

David Byers's avatar
David Byers committed
105
static Small_conf      ** small_conf_arr;
106 107
static Cache_node_mcb	* pers_mcb;
static Cache_node_mcb 	* conf_mcb;
108
static Conf_no		  next_free_num = 1;
Per Cederqvist's avatar
Per Cederqvist committed
109

110
static Cache_node_mcb 	* text_mcb;
111
static Text_no		  next_text_num = 1;
Per Cederqvist's avatar
Per Cederqvist committed
112 113 114 115 116 117 118 119 120 121 122

/*
 * The elements in the following lists with same index refers to the same
 * conference.
 */
static int    no_of_match_info;
EXPORT Matching_info *match_table = NULL;

static FILE	*text_file= NULL;
static FILE	*file_a = NULL;	/* Current file. */
static FILE	*file_b = NULL;	/* File under construction. */
David Byers's avatar
David Byers committed
123 124 125
#ifdef FASTSAVE
static FILE     *file_b_r = NULL; /* Read from file under construction */
#endif
Per Cederqvist's avatar
Per Cederqvist committed
126 127 128 129 130

/*
 * Four state variables for the background save.
 */
static enum {
131
    sync_idle,
Per Cederqvist's avatar
Per Cederqvist committed
132 133 134 135 136 137 138 139
    sync_save_conf,
    sync_save_pers,
    sync_save_text,
    sync_error,
    sync_wait,
    sync_ready
} sync_state;

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
/* The state machine sync_state works like this:
 *
 *  Old state              action           new state
 *  none               sync_part called     sync_idle
 *                     for the first time
 *  sync_idle	       SYNC_INTERVAL        sync_save_conf
 *  sync_save_conf     all confs saved      sync_save_pers
 *  sync_save_pers     all persons saved    sync_save_text
 *  sync_save_text     all texts saved      sync_ready
 *  sync_ready         sync_part called     sync_idle
 *  any                error occurs         sync_error
 *  sync_error         sync_part called     sync_wait
 *  sync_wait          SYNC_RETRY_INTERVAL  sync_save_conf
 */

David Byers's avatar
David Byers committed
155
#ifndef FASTSAVE
156 157 158 159 160
/* sync_next should be split in next_text_to_sync and
   next_conf_to_sync to avoid warnings about the different sizes of
   Conf_no and Text_no.  Since that is indeed done if FASTSAVE is set,
   don't bother doing it in the old code that will anyhow soon be
   replaced. */
161
static unsigned long sync_next;
David Byers's avatar
David Byers committed
162
#endif
Per Cederqvist's avatar
Per Cederqvist committed
163

164 165
static Conf_no highest_conf_no = 0;
static Text_no highest_text_no = 0;
Per Cederqvist's avatar
Per Cederqvist committed
166 167 168

BUGDECL;

169 170 171 172
/* Define LOGACCESSES if you want to be able to log all accesses to
   the data base. */

#ifdef LOGACCESSES
173
enum log_type {
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
    lt_restart,
    lt_text_stat,
    lt_text_mass,
    lt_conf_stat,
    lt_pers_stat,
    
    lt_text_def,
    lt_conf_def,
    lt_pers_def,

    lt_create_text,
    lt_garb_text,
    lt_delete_text,
    lt_create_conf,
    lt_delete_conf,
    lt_create_pers,
    lt_delete_pers,

    lt_lock_conf,
    lt_unlock_conf,
    lt_lock_pers,
    lt_unlock_pers,

    lt_get_highest,		/* Get highest Local_text_no for a conf. */
    lt_get_conf_type
    /* Note: mark_*_as_changed is not logged. */
200
};
201 202 203 204 205

static FILE *logfile = NULL;
static int syncing_or_saving = 0;
static int garb_running = 0;

206
static void log_access(enum log_type t,
207 208
		       int id)
{
209 210
    extern int putw(int, FILE *);

211 212 213 214 215 216 217 218 219 220 221
    if (garb_running + syncing_or_saving == 0)
    {
	putc(t, logfile);
	putw(id, logfile);
    }
}
#define LOGACC(a,b) {if (logfile) log_access(a, b);}
#else
#define LOGACC(a,b)
#endif

David Byers's avatar
Server:  
David Byers committed
222 223 224 225 226 227 228 229 230

/* Local functions */

static Success build_matching_info(void);
static Success rebuild_matching_info_entry(Conf_no conf_no);
static Matching_info *find_matching_info(Conf_no conf_no);



Per Cederqvist's avatar
Per Cederqvist committed
231 232 233 234 235 236 237 238 239 240 241

/* Macros */

#define TRACE2(format, arg) if ( buglevel > 2 ) printf(format, arg)
#define TRACE1(format) if ( buglevel > 2 ) printf(format)
#define TRACESTR(str)  if ( buglevel > 2 ) s_puts(str)


static Person *
read_person(FILE *fp,
	    long pos,
242
	    long UNUSED(size))	/* FIXME (bug 168): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
243 244
{
    Person *p;
David Byers's avatar
David Byers committed
245
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
246 247

    p = alloc_person();
248
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'P' */
David Byers's avatar
David Byers committed
249
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263
    if ( fparse_person(fp, p) != OK )
    {
	free_person(p);
	return NULL;
    }
    else
	return p;
}



static Conference *
read_conference(FILE *fp,
		long pos,
264
		long UNUSED(size)) /* FIXME (bug 169): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
265 266
{
    Conference *c;
David Byers's avatar
David Byers committed
267
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
268 269

    c = alloc_conference();
270
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'C' */
David Byers's avatar
David Byers committed
271
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
272 273 274 275 276 277 278 279 280 281 282 283 284
    if ( fparse_conference(fp, c) != OK )
    {
	free_conference(c);
	return NULL;
    }
    else
	return c;
}
	

static Text_stat *
read_text_stat(FILE *fp,
	       long pos,
285
	       long UNUSED(size)) /* FIXME (bug 170): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
286 287
{
    Text_stat *t;
David Byers's avatar
David Byers committed
288
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
289 290

    t = alloc_text_stat();
291
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'T' */
David Byers's avatar
David Byers committed
292
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
293 294 295 296 297 298 299 300 301 302
    if ( fparse_text_stat(fp, t) != OK )
    {
	free_text_stat(t);
	return NULL;
    }
    else
	return t;
}

static void
303
pers_set_mru(Pers_no pers_no)
Per Cederqvist's avatar
Per Cederqvist committed
304
{
305
    set_mru(pers_mcb, pers_no);
Per Cederqvist's avatar
Per Cederqvist committed
306 307 308
}

static void
309
text_set_mru(Text_no text_no)
Per Cederqvist's avatar
Per Cederqvist committed
310
{
311
    set_mru(text_mcb, text_no);
Per Cederqvist's avatar
Per Cederqvist committed
312 313 314
}

static void
315
conf_set_mru(Conf_no conf_no)
Per Cederqvist's avatar
Per Cederqvist committed
316
{
317 318
    set_mru(conf_mcb, conf_no);
}
Per Cederqvist's avatar
Per Cederqvist committed
319

320 321 322
static Cache_node *
get_pers_node(Pers_no pers_no)
{
323
    if (pers_no >= next_free_num || pers_no < 1)
324 325
	return NULL;

326
    return get_cache_node(pers_mcb, pers_no);
Per Cederqvist's avatar
Per Cederqvist committed
327 328 329
}

static void
330
unlink_text_lru (Cache_node *node)
Per Cederqvist's avatar
Per Cederqvist committed
331
{
332
    unlink_lru (node, &text_mcb->lru, &text_mcb->mru);
Per Cederqvist's avatar
Per Cederqvist committed
333 334
}

335 336 337 338 339
static void
unlink_conf_lru (Cache_node *node)
{
    unlink_lru (node, &conf_mcb->lru, &conf_mcb->mru);
}
Per Cederqvist's avatar
Per Cederqvist committed
340 341

static void
342
unlink_pers_lru (Cache_node *node)
Per Cederqvist's avatar
Per Cederqvist committed
343
{
344 345
    unlink_lru (node, &pers_mcb->lru, &pers_mcb->mru);
}
Per Cederqvist's avatar
Per Cederqvist committed
346

347 348 349
static Cache_node *
get_conf_node(Conf_no conf_no)
{
350
    if (conf_no >= next_free_num || conf_no < 1)
351 352
	return NULL;

353 354
    return get_cache_node(conf_mcb, conf_no);
}
Per Cederqvist's avatar
Per Cederqvist committed
355

356 357 358
static Cache_node *
get_text_node(Text_no text_no)
{
359
    if (text_no >= next_text_num || text_no < 1)
360 361
	return NULL;

362
    return get_cache_node(text_mcb, text_no);
Per Cederqvist's avatar
Per Cederqvist committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
}

	
/*
 * Name caching routines
 */

/*
 * change_name changes the cached conference name. It is only called when
 * a conference name is changed or a conference is deleted.
 */
void
cached_change_name( Conf_no name_num,
		    String new_name )
{
    if ( name_num < 1 || name_num >= next_free_num )
379
	restart_kom("cached_change_name(%d, ----): next_free_num==%d\n",
Per Cederqvist's avatar
Per Cederqvist committed
380 381 382 383
		    name_num, next_free_num);

    s_clear( &small_conf_arr[name_num]->name );
    s_strcpy( &small_conf_arr[name_num]->name, new_name);
David Byers's avatar
Server:  
David Byers committed
384
    rebuild_matching_info_entry(name_num);
Per Cederqvist's avatar
Per Cederqvist committed
385 386 387 388 389 390 391 392 393
}


extern Conf_type
cached_get_conf_type (Conf_no conf_no)
{
    if ( conf_no < 1 || conf_no >= next_free_num )
	restart_kom("cached_get_conf_type(%d): next_free_num==%d",
		    conf_no, next_free_num);
394 395 396 397 398

    if ( small_conf_arr [ conf_no ] == NULL )
	restart_kom("cached_get_conf_type(%d): conference does not exist.\n",
		    conf_no);

399 400
    LOGACC(lt_get_conf_type, conf_no);

Per Cederqvist's avatar
Per Cederqvist committed
401 402 403
    return small_conf_arr [ conf_no ]->type;
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
extern Conf_no
cached_get_conf_supervisor(Conf_no conf_no)
{
    if (conf_no < 1 || conf_no >= next_free_num)
	restart_kom("cached_get_conf_supervisor(%d): next_free_num==%d\n",
		    conf_no, next_free_num);

    if (small_conf_arr[conf_no] == NULL)
	restart_kom("cached_get_conf_supervisor(%d):"
		    " conference does not exist.\n", conf_no);

    LOGACC(lt_get_conf_supervisor, conf_no);

    return small_conf_arr[conf_no]->supervisor;
}

420 421 422 423 424 425 426 427
/*
 * Return number of conferences present.  (Actually, return a number
 * at least as large as the number of conferences present).
 */
extern Conf_no
cached_no_of_existing_conferences(void)
{
    return next_free_num;	/* This is too large, but who cares? */
428 429 430 431
    /* Actually, this is used in lookup_regexp (and maybe other
       places) to allocate an array this large, and that is pretty
       stupid if many conferences have been deleted.  But it is no big
       deal.  Not yet, anyhow...  */
432
    /* FIXME (bug 164): We should return a better estimate. */
433
}
Per Cederqvist's avatar
Per Cederqvist committed
434 435 436 437 438 439 440 441

/*
 * Various function calls to tell the cache that something is changed.
 */

void
mark_person_as_changed(Pers_no	pers_no)
{
442 443 444 445
    Cache_node *node;

    node = get_pers_node(pers_no);
    
Per Cederqvist's avatar
Per Cederqvist committed
446
    TRACE2("Person %d is changed\n", pers_no);
447
    if ( node == NULL || node->s.exists == 0)
Per Cederqvist's avatar
Per Cederqvist committed
448 449
	restart_kom("mark_person_as_changed(%d): nonexistent.\n", pers_no);

450
    node->s.dirty = 1;
Per Cederqvist's avatar
Per Cederqvist committed
451 452 453
    pers_set_mru( pers_no );
}

454 455 456 457 458 459 460 461 462 463 464
/*
 * Mark the conference as dirty, so that it will be written to
 * the disk.
 *
 * Also update all fields in the Small_conf except then name, so that
 * they are always current.
 *
 * NOTE: You must call cached_change_name when the name changes.
 *       It is not necessary to call cached_change_name after
 *       cached_create_conf.
 */
Per Cederqvist's avatar
Per Cederqvist committed
465 466 467 468

void
mark_conference_as_changed(Conf_no	conf_no)
{
469
    Cache_node *node;
470
    Conference *conf_c;
471 472 473

    node = get_conf_node (conf_no);

Per Cederqvist's avatar
Per Cederqvist committed
474
    TRACE2("Conf.  %d is changed\n", conf_no);
475
    if ( node == NULL || node->s.exists == 0)
Per Cederqvist's avatar
Per Cederqvist committed
476 477
	restart_kom("mark_conference_as_changed(%d): nonexistent.\n", conf_no);

478
    node->s.dirty = 1;
Per Cederqvist's avatar
Per Cederqvist committed
479
    conf_set_mru( conf_no );
480 481 482

    conf_c = (Conference *) node->ptr;

483
    small_conf_arr[conf_no]->highest_local_no
484
	= l2g_first_appendable_key(&conf_c->texts) - 1;
485

486 487 488
    small_conf_arr[conf_no]->nice = conf_c->nice;
    small_conf_arr[conf_no]->type = conf_c->type;
    small_conf_arr[conf_no]->supervisor = conf_c->supervisor;
Per Cederqvist's avatar
Per Cederqvist committed
489 490 491 492 493
}

void
mark_text_as_changed( Text_no text_no )
{
494 495 496 497
    Cache_node *node;

    node = get_text_node (text_no);

498
    TRACE2("Text %lu is changed.\n", text_no);
Per Cederqvist's avatar
Per Cederqvist committed
499
    if ( text_no < 1 || text_no >= next_text_num
500
	|| node == NULL || node->s.exists == 0)
Per Cederqvist's avatar
Per Cederqvist committed
501
    {
502
	restart_kom("mark_text_as_changed(%lu): nonexistent.\n", text_no);
Per Cederqvist's avatar
Per Cederqvist committed
503 504
    }

505 506
    node->s.dirty = 1;
    text_set_mru (text_no);
Per Cederqvist's avatar
Per Cederqvist committed
507 508 509
}    


510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
/*
 * Store and retrieve the highest number used.
 */

static int
write_number_file(void)
{
    FILE *fp;

    if ((fp = i_fopen(param.numberfile_tmp_name, "w")) == NULL)
    {
	kom_log("opening %s: %s\n", param.numberfile_tmp_name,
		strerror(errno));
	return -1;
    }
    fprintf(fp, "Text_no: %lu Conf_no: %lu End.\n",
	    (unsigned long)next_text_num,
	    (unsigned long)next_free_num);
    if (fflush(fp) != 0)
    {
	kom_log("fflush to %s failed\n", param.numberfile_tmp_name);
	i_fclose(fp);
	return -1;
    }

    if (ferror(fp) != 0)
    {
	kom_log("fprintf to %s failed\n", param.numberfile_tmp_name);
	i_fclose(fp);
	return -1;
    }

    if (i_fclose(fp) != 0)
    {
	kom_log("fclose %s failed\n", param.numberfile_tmp_name);
	return -1;
    }

    if (i_rename(param.numberfile_tmp_name, param.numberfile_name) != 0)
    {
	kom_log("failed to rename %s to %s: %s\n",
		param.numberfile_tmp_name, param.numberfile_name,
		strerror(errno));
	return -1;
    }
    return 0;
}

static void
read_number_file(void)
{
    FILE *fp;
    unsigned long txt = 0;
    unsigned long cno = 0;
    Text_no text_no;
    Conf_no conf_no;

    if ((fp = i_fopen(param.numberfile_name, "r")) == NULL)
    {
	if (errno == ENOENT)
	    kom_log("WARN: %s: No such file\n", param.numberfile_name);
	else
	    restart_kom("opening %s: %s\n", param.numberfile_name,
			strerror(errno));
	return;
    }
    if (fscanf(fp, "Text_no: %lu Conf_no: %lu", &txt, &cno) != 2
	|| getc(fp) != ' ' || getc(fp) != 'E' || getc(fp) != 'n'
	|| getc(fp) != 'd' || getc(fp) != '.')
    {
	kom_log("WARN: %s: broken file (ignored)\n", param.numberfile_name);
	i_fclose(fp);
	return;
    }
    i_fclose(fp);

    text_no = txt;
    conf_no = cno;
    
    if (text_no > next_text_num)
    {
	kom_log("WARN: Texts %lu - %lu were lost.\n",
		(unsigned long)next_text_num,
		(unsigned long)text_no - 1);
	next_text_num = text_no;
    }
    if (conf_no > next_free_num)
    {
	kom_log("WARN: Confs %lu - %lu were lost.\n",
		(unsigned long)next_free_num,
		(unsigned long)conf_no - 1);
	next_free_num = conf_no;
    }
}
Per Cederqvist's avatar
Per Cederqvist committed
604 605 606 607 608 609 610 611 612

/*
 * Person-related calls
 */


extern Success
cached_create_person( Pers_no person )
{
613 614
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
615 616 617 618 619 620 621 622
    TRACE2("Person %d is being created.\n", person);

    if ( person < 1 || person >= next_free_num )
    {
	restart_kom("cached_create_person(%d): next_free_num == %d.\n",
		    person, next_free_num);
    }

623
    if ( get_pers_node(person) != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
624 625 626 627 628
    {
	restart_kom("cached_create_person(%d): Person existed.\n",
		    person);
    }

629 630 631 632 633
    create_cache_node (pers_mcb, person);
    node = get_pers_node (person);

    if ( node == NULL )
	restart_kom("cached_create_person(): couldn't get cache_node.\n");
634

635 636 637
    node->ptr = alloc_person();
    node->s.dirty = 1;
    node->s.exists = 1;
Per Cederqvist's avatar
Per Cederqvist committed
638
    pers_set_mru( person );
639 640 641

    LOGACC(lt_create_pers, person);

Per Cederqvist's avatar
Per Cederqvist committed
642 643 644 645 646 647 648
    return OK;
}


extern Person *
cached_get_person_stat( Pers_no	person )
{
649 650
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
651 652 653 654
    TRACE2("cached_get_person_stat %d\n", person);

    if ( person == 0 )
    {
655
        err_stat = 0;
Per Cederqvist's avatar
Per Cederqvist committed
656 657 658
	kom_errno = KOM_CONF_ZERO;
	return NULL;
    }
659

660 661
    if ( person >= next_free_num )
    {
662
        err_stat = person;
663 664 665 666
	kom_errno = KOM_UNDEF_PERS;
	return NULL;
    }

667 668
    node = get_pers_node (person);

669
    if ( node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
670
    {
671
        err_stat = person;
Per Cederqvist's avatar
Per Cederqvist committed
672 673 674 675
	kom_errno = KOM_UNDEF_PERS;
	return NULL;
    }

676 677
    LOGACC(lt_pers_stat, person);

678
    if ( node->ptr != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
679 680
    {
	pers_set_mru( person );
681
	++pers_mcb->hits;
682
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
683 684
    }

685
    if ( node->snap_shot != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
686
    {
687
	node->ptr = copy_person (node->snap_shot);
Per Cederqvist's avatar
Per Cederqvist committed
688
	pers_set_mru (person);
689
	++pers_mcb->hits;
690
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
691 692
    }

693
    node->ptr = read_person(file_a, node->pos, node->size);
Per Cederqvist's avatar
Per Cederqvist committed
694

695
    ++pers_mcb->misses;
Per Cederqvist's avatar
Per Cederqvist committed
696
    pers_set_mru (person);
697
    return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
698 699 700 701 702 703
}


/*
 * Conference-related calls
 */
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719


static int no_of_allocated_small_confs = 0;

static void
free_small_conf (Small_conf *sc)
{
    if ( sc != NULL )
    {
	--no_of_allocated_small_confs;
	s_clear ( &sc->name );
	sfree (sc);
    }
}


720 721 722 723 724
static void
init_small_conf(Small_conf *sc)
{
    sc->name = EMPTY_STRING;
    init_conf_type(&sc->type);
725
    sc->supervisor = 0;
726 727 728 729
    sc->highest_local_no = 0;
    sc->nice = param.default_nice;
}

730 731 732 733 734
static Small_conf *
alloc_small_conf(void)
{
    Small_conf *s;
    s = smalloc(sizeof(Small_conf));
735
    init_small_conf(s);
736 737 738 739 740 741
    ++no_of_allocated_small_confs;

    return s;
}


742 743 744 745 746 747
/*
 * Create a conference.
 *
 * Set up a Conference and cache the name in the small_conf_array.
 */
extern Conf_no
Per Cederqvist's avatar
Per Cederqvist committed
748 749 750 751
cached_create_conf (String  name)
{
    Conference * conf_c;
    Conf_no	 conf_no;
752
    Cache_node  *node;
Per Cederqvist's avatar
Per Cederqvist committed
753 754 755 756 757

    TRACE1("cached_create_conf( ");
    TRACESTR(name);
    TRACE1(" )\n");

David Byers's avatar
David Byers committed
758
    if ( next_free_num >= param.max_conf )
Per Cederqvist's avatar
Per Cederqvist committed
759
    {
760
        err_stat = next_free_num;
Per Cederqvist's avatar
Per Cederqvist committed
761 762 763 764 765 766
	kom_errno = KOM_INDEX_OUT_OF_RANGE;
	return 0;
    }
    
    conf_no = next_free_num++;

767 768 769 770 771 772 773 774
    if (write_number_file() < 0)
    {
	next_free_num--;
	err_stat = 0;
	kom_errno = KOM_TEMPFAIL;
	return 0;
    }

775 776 777 778 779 780 781 782 783
    create_cache_node (conf_mcb, conf_no);
    node = get_conf_node (conf_no);

    if ( node == NULL )
	restart_kom("cached_create_conf(): failed to allocate cache_node.\n");
    
    node->s.exists = 1;
    node->s.dirty = 1;
    node->ptr = conf_c = alloc_conference();
Per Cederqvist's avatar
Per Cederqvist committed
784 785
    conf_set_mru(conf_no);    

786
    zero_init_cache_node (pers_mcb, conf_no);
Per Cederqvist's avatar
Per Cederqvist committed
787 788 789 790 791 792
    small_conf_arr[ conf_no ] = alloc_small_conf();

    conf_c->name = EMPTY_STRING;
    s_strcpy(&conf_c->name, name);
    cached_change_name( conf_no, name);

793
    TRACE2("Created conference number %d\n", conf_no);
794 795 796

    LOGACC(lt_create_conf, conf_no);

Per Cederqvist's avatar
Per Cederqvist committed
797 798 799 800 801 802 803
    return conf_no;
}


extern Success
cached_delete_conf( Conf_no	conf )
{
804 805
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
806 807
    if ( conf == 0 )
    {
808
        err_stat = conf;
Per Cederqvist's avatar
Per Cederqvist committed
809 810 811
	kom_errno = KOM_CONF_ZERO;
	return FAILURE;
    }
812

813 814
    if ( conf >= next_free_num )
    {
815
        err_stat = conf;
816 817 818 819
	kom_errno = KOM_UNDEF_CONF;
	return FAILURE;
    }

820 821
    node = get_conf_node (conf);

822
    if ( node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
823
    {
824
        err_stat = conf;
Per Cederqvist's avatar
Per Cederqvist committed
825 826 827 828
	kom_errno = KOM_UNDEF_CONF;
	return FAILURE;
    }

829
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
830
	kom_log("WNG: cached_delete_conf(%d): lock_cnt === %d\n",
831
	    conf, node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
832

David Byers's avatar
David Byers committed
833 834 835
    free_small_conf(small_conf_arr[conf]);
    small_conf_arr[conf] = NULL;

836 837 838
    free_conference(node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
839

840 841
    LOGACC(lt_delete_conf, conf);

David Byers's avatar
Server:  
David Byers committed
842
    rebuild_matching_info_entry(conf);
Per Cederqvist's avatar
Per Cederqvist committed
843 844 845 846 847 848
    return OK;
}

Success
cached_delete_person(Pers_no pers)
{
849 850
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
851 852
    if ( pers == 0 )
    {
853
        err_stat = pers;
Per Cederqvist's avatar
Per Cederqvist committed
854 855 856
	kom_errno = KOM_CONF_ZERO;
	return FAILURE;
    }
857

858 859
    if ( pers >= next_free_num )
    {
David Byers's avatar
David Byers committed
860
	kom_log("cached_delete_person(%lu): next_free_num == %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
861
	    (unsigned long)pers, (unsigned long)next_free_num);
862
        err_stat = pers;
863 864 865 866
	kom_errno = KOM_UNDEF_PERS;
	return FAILURE;
    }

867 868 869
    node = get_pers_node (pers);

    if ( pers >= next_free_num || node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
870
    {
David Byers's avatar
David Byers committed
871
	kom_log("cached_delete_person(): attempt to delete void person.\n");
872
        err_stat = pers;
Per Cederqvist's avatar
Per Cederqvist committed
873 874 875 876
	kom_errno = KOM_UNDEF_PERS;
	return FAILURE;
    }

877
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
878
	kom_log("cached_delete_pers(%lu): lock_cnt === %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
879
	    (unsigned long)pers, (unsigned long)node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
880

881 882
    LOGACC(lt_delete_pers, pers);

883 884 885
    free_person (node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
886 887 888 889 890 891
    return OK;
}

Success
cached_delete_text(Text_no text)
{
892 893
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
894 895
    if ( text == 0 )
    {
896
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
897 898 899
	kom_errno = KOM_TEXT_ZERO;
	return FAILURE;
    }
900 901 902 903 904

    node = get_text_node (text);

    if ( text >= next_text_num || node == NULL
	|| node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
905
    {
David Byers's avatar
David Byers committed
906
	kom_log("cached_delete_text(): attempt to delete void text %lu.\n", text);
907
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
908 909 910 911
	kom_errno = KOM_NO_SUCH_TEXT;
	return FAILURE;
    }

912
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
913
	kom_log("cached_delete_text(%lu): lock_cnt === %d\n",
914
	    text, node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
915 916


917 918 919
    free_text_stat(node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
920

921 922 923
#ifdef LOGACCESSES
    if (garb_running)
    {
924
	LOGACC(lt_garb_text, text);
925 926
    }
    else
927
	LOGACC(lt_delete_text, text);
928
#endif
Per Cederqvist's avatar
Per Cederqvist committed
929 930 931 932 933
    return OK;
}


extern Conference *
934
cached_get_conf_stat (Conf_no   conf_no)
Per Cederqvist's avatar
Per Cederqvist committed
935
{
936 937
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
938 939 940 941
    TRACE2("cached_get_conf_stat %d\n", conf_no);

    if ( conf_no == 0 )
    {
942
        err_stat = conf_no;
Per Cederqvist's avatar
Per Cederqvist committed
943 944 945
	kom_errno = KOM_CONF_ZERO;
	return NULL;
    }
946 947 948 949

    node = get_conf_node (conf_no);

    if ( conf_no >= next_free_num || node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
950
    {
951
        err_stat = conf_no;
Per Cederqvist's avatar
Per Cederqvist committed
952 953 954 955
	kom_errno = KOM_UNDEF_CONF;
	return NULL;
    }

956 957
    LOGACC(lt_conf_stat, conf_no);

958
    if ( node->ptr != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
959
    {
960
	conf_set_mru (conf_no);
961
	++conf_mcb->hits;
962
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
963 964
    }

965
    if ( node->snap_shot != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
966
    {
967
	node->ptr = copy_conference (node->snap_shot);
Per Cederqvist's avatar
Per Cederqvist committed
968
	conf_set_mru (conf_no);
969
	++conf_mcb->hits;
970
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
971 972
    }

973
    node->ptr = read_conference(file_a, node->pos, node->size);
974
    ++conf_mcb->misses;
Per Cederqvist's avatar
Per Cederqvist committed
975 976

    conf_set_mru (conf_no);
977
    return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
978 979 980 981 982 983 984 985
}

/*
 * Return TRUE if conf_no exists.
 */
Bool
cached_conf_exists(Conf_no conf_no)
{
986 987 988
    if (conf_no == 0 || conf_no >= next_free_num )
	return FALSE;

David Byers's avatar
David Byers committed
989
    return small_conf_arr[conf_no] != NULL ? TRUE : FALSE;
Per Cederqvist's avatar
Per Cederqvist committed
990 991 992 993 994 995 996 997
}

    
/*
 * Calls to handle texts
 */

/*
998
 * FIXME (bug 171): cached_get_text() should return Success.
Per Cederqvist's avatar
Per Cederqvist committed
999 1000 1001 1002 1003 1004 1005
 */
extern String
cached_get_text( Text_no text )
{
    String  the_string;
    Text_stat *t_stat;

1006
    TRACE2("cached_get_text %lu\n", text);
Per Cederqvist's avatar
Per Cederqvist committed
1007 1008 1009 1010 1011

    if ( (t_stat = cached_get_text_stat (text)) == NULL )
	return EMPTY_STRING;
    else
    {
1012
	LOGACC(lt_text_mass, text);
Per Cederqvist's avatar
Per Cederqvist committed
1013 1014 1015 1016 1017
	the_string.string = tmp_alloc( t_stat->no_of_chars );
	the_string.len = t_stat->no_of_chars;
	fseek(text_file, t_stat->file_pos, SEEK_SET);

	if ( fread(the_string.string, sizeof(char), the_string.len, text_file)
David Byers's avatar
David Byers committed
1018
	    != (size_t)the_string.len )
Per Cederqvist's avatar
Per Cederqvist committed
1019
	{
David Byers's avatar
David Byers committed
1020
	    kom_log("WARNING: cached_get_text: premature end on text %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
		text);
	    return EMPTY_STRING;
	}
		    
	return the_string;
    }
}


extern Text_stat *	/* NULL on error */
cached_get_text_stat(	Text_no		text )
{
1033 1034
    Cache_node *node;

1035
    TRACE2("cached_get_text_stat(%lu);  next_text_num == ", text);
1036
    TRACE2("%lu\n", (unsigned long)next_text_num);
Per Cederqvist's avatar
Per Cederqvist committed
1037 1038 1039

    if ( text == 0 )
    {
1040
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
1041 1042 1043
	kom_errno = KOM_TEXT_ZERO;
	return NULL;
    }
1044 1045 1046 1047

    node = get_text_node (text);

    if ( text >= next_text_num || node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
1048 1049
    {
	TRACE1("cached_get_text_stat: no such text.\n");
1050
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
1051 1052 1053 1054
	kom_errno = KOM_NO_SUCH_TEXT;
	return NULL;
    }