simple-cache.c 68 KB
Newer Older
Linus Tolke Y's avatar
Linus Tolke Y committed
1
/*
2 3
 * $Id: simple-cache.c,v 0.117 2005/12/18 22:18:15 ceder Exp $
 * Copyright (C) 1991-2005  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
 *
 * 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.
 *
Per Cederqvist's avatar
Per Cederqvist committed
23
 * Please report bugs at http://bugzilla.lysator.liu.se/. 
Linus Tolke Y's avatar
Linus Tolke Y committed
24
 */
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
61
#include "timewrap.h"
Per Cederqvist's avatar
Per Cederqvist committed
62 63
#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 "conf-file.h"
85
#include "param.h"
David Byers's avatar
David Byers committed
86
#include "kom-config.h"
David Byers's avatar
David Byers committed
87
#include "admin.h"
88
#include "unused.h"
89
#include "local-to-global.h"
90
#include "server-time.h"
91
#include "eintr.h"
92
#include "timeval-util.h"
93
#include "stats.h"
94 95
#include "services.h"
#include "manipulate.h"
Per Cederqvist's avatar
Per Cederqvist committed
96 97

/*
98
 * Possible improvements:
Per Cederqvist's avatar
Per Cederqvist committed
99
 *
100 101 102
 *  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
103 104 105 106 107 108 109
 */

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

David Byers's avatar
David Byers committed
110
static Small_conf      ** small_conf_arr;
111 112
static Cache_node_mcb	* pers_mcb;
static Cache_node_mcb 	* conf_mcb;
113
static Conf_no		  next_free_num = 1;
114
static Conf_no            existing_confs = 0;
Per Cederqvist's avatar
Per Cederqvist committed
115

116
static Cache_node_mcb 	* text_mcb;
117
static Text_no		  next_text_num = 1;
Per Cederqvist's avatar
Per Cederqvist committed
118 119 120 121 122 123 124

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
125 126 127
#ifdef FASTSAVE
static FILE     *file_b_r = NULL; /* Read from file under construction */
#endif
Per Cederqvist's avatar
Per Cederqvist committed
128 129 130 131 132

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

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
/* 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
157
#ifndef FASTSAVE
158 159 160 161 162
/* 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. */
163
static unsigned long sync_next;
David Byers's avatar
David Byers committed
164
#endif
Per Cederqvist's avatar
Per Cederqvist committed
165

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

BUGDECL;

171 172 173 174 175 176 177
#ifdef DEBUG_CALLS

/* This is used by cache_sync_start() and cache_sync_finish().  */
static int block_after_pre_sync = 0;

#endif

178 179 180 181
/* Define LOGACCESSES if you want to be able to log all accesses to
   the data base. */

#ifdef LOGACCESSES
182
enum log_type {
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    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. */
209
};
210 211 212 213 214

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

215
static void log_access(enum log_type t,
216 217
		       int id)
{
218 219
    extern int putw(int, FILE *);

220 221 222 223 224 225 226 227 228 229 230
    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

231 232 233 234
static Static_server_info boottime_info = {
    0, 0, EMPTY_STRING_i, 0, 0, 0, 0, 0
};

David Byers's avatar
Server:  
David Byers committed
235 236 237 238 239 240 241 242 243

/* 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
244 245 246 247 248 249 250 251 252 253 254

/* 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,
255
	    long UNUSED(size))	/* FIXME (bug 168): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
256 257
{
    Person *p;
David Byers's avatar
David Byers committed
258
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
259 260

    p = alloc_person();
261
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'P' */
David Byers's avatar
David Byers committed
262
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276
    if ( fparse_person(fp, p) != OK )
    {
	free_person(p);
	return NULL;
    }
    else
	return p;
}



static Conference *
read_conference(FILE *fp,
		long pos,
277
		long UNUSED(size)) /* FIXME (bug 169): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
278 279
{
    Conference *c;
David Byers's avatar
David Byers committed
280
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
281 282

    c = alloc_conference();
283
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'C' */
David Byers's avatar
David Byers committed
284
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
285 286 287 288 289 290 291 292 293 294 295 296 297
    if ( fparse_conference(fp, c) != OK )
    {
	free_conference(c);
	return NULL;
    }
    else
	return c;
}
	

static Text_stat *
read_text_stat(FILE *fp,
	       long pos,
298
	       long UNUSED(size)) /* FIXME (bug 170): sanity-check the size */
Per Cederqvist's avatar
Per Cederqvist committed
299 300
{
    Text_stat *t;
David Byers's avatar
David Byers committed
301
    long dummy;
Per Cederqvist's avatar
Per Cederqvist committed
302 303

    t = alloc_text_stat();
304
    fseek(fp, pos+1, SEEK_SET);	/* Skip 'T' */
David Byers's avatar
David Byers committed
305
    dummy = fparse_long(fp);
Per Cederqvist's avatar
Per Cederqvist committed
306 307 308 309 310 311 312 313 314 315
    if ( fparse_text_stat(fp, t) != OK )
    {
	free_text_stat(t);
	return NULL;
    }
    else
	return t;
}

static void
316
pers_set_mru(Pers_no pers_no)
Per Cederqvist's avatar
Per Cederqvist committed
317
{
318
    set_mru(pers_mcb, pers_no);
Per Cederqvist's avatar
Per Cederqvist committed
319 320 321
}

static void
322
text_set_mru(Text_no text_no)
Per Cederqvist's avatar
Per Cederqvist committed
323
{
324
    set_mru(text_mcb, text_no);
Per Cederqvist's avatar
Per Cederqvist committed
325 326 327
}

static void
328
conf_set_mru(Conf_no conf_no)
Per Cederqvist's avatar
Per Cederqvist committed
329
{
330 331
    set_mru(conf_mcb, conf_no);
}
Per Cederqvist's avatar
Per Cederqvist committed
332

333 334 335
static Cache_node *
get_pers_node(Pers_no pers_no)
{
336
    if (pers_no >= next_free_num || pers_no < 1)
337 338
	return NULL;

339
    return get_cache_node(pers_mcb, pers_no);
Per Cederqvist's avatar
Per Cederqvist committed
340 341 342
}

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

348 349 350 351 352
static void
unlink_conf_lru (Cache_node *node)
{
    unlink_lru (node, &conf_mcb->lru, &conf_mcb->mru);
}
Per Cederqvist's avatar
Per Cederqvist committed
353 354

static void
355
unlink_pers_lru (Cache_node *node)
Per Cederqvist's avatar
Per Cederqvist committed
356
{
357 358
    unlink_lru (node, &pers_mcb->lru, &pers_mcb->mru);
}
Per Cederqvist's avatar
Per Cederqvist committed
359

360 361 362
static Cache_node *
get_conf_node(Conf_no conf_no)
{
363
    if (conf_no >= next_free_num || conf_no < 1)
364 365
	return NULL;

366 367
    return get_cache_node(conf_mcb, conf_no);
}
Per Cederqvist's avatar
Per Cederqvist committed
368

369 370 371
static Cache_node *
get_text_node(Text_no text_no)
{
372
    if (text_no >= next_text_num || text_no < 1)
373 374
	return NULL;

375
    return get_cache_node(text_mcb, text_no);
Per Cederqvist's avatar
Per Cederqvist committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
}

	
/*
 * 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 )
392
	restart_kom("cached_change_name(%d, ----): next_free_num==%d\n",
Per Cederqvist's avatar
Per Cederqvist committed
393 394 395 396
		    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
397
    rebuild_matching_info_entry(name_num);
Per Cederqvist's avatar
Per Cederqvist committed
398 399 400 401 402 403 404 405 406
}


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);
407 408 409 410 411

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

412 413
    LOGACC(lt_get_conf_type, conf_no);

Per Cederqvist's avatar
Per Cederqvist committed
414 415 416
    return small_conf_arr [ conf_no ]->type;
}

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
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;
}

433 434 435 436 437 438 439
/*
 * 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)
{
440
    return existing_confs;
441
}
Per Cederqvist's avatar
Per Cederqvist committed
442 443 444 445 446 447 448 449

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

void
mark_person_as_changed(Pers_no	pers_no)
{
450 451 452 453
    Cache_node *node;

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

458
    node->s.dirty = 1;
Per Cederqvist's avatar
Per Cederqvist committed
459 460 461
    pers_set_mru( pers_no );
}

462 463 464 465 466 467 468 469 470 471 472
/*
 * 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
473 474 475 476

void
mark_conference_as_changed(Conf_no	conf_no)
{
477
    Cache_node *node;
478
    Conference *conf_c;
479 480 481

    node = get_conf_node (conf_no);

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

486
    node->s.dirty = 1;
Per Cederqvist's avatar
Per Cederqvist committed
487
    conf_set_mru( conf_no );
488 489 490

    conf_c = (Conference *) node->ptr;

491
    small_conf_arr[conf_no]->highest_local_no
492
	= l2g_first_appendable_key(&conf_c->texts) - 1;
493

494
    small_conf_arr[conf_no]->nice = conf_c->nice;
495
    small_conf_arr[conf_no]->keep_commented = conf_c->keep_commented;
496 497
    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
498 499 500 501 502
}

void
mark_text_as_changed( Text_no text_no )
{
503 504 505 506
    Cache_node *node;

    node = get_text_node (text_no);

507
    TRACE2("Text %lu is changed.\n", text_no);
Per Cederqvist's avatar
Per Cederqvist committed
508
    if ( text_no < 1 || text_no >= next_text_num
509
	|| node == NULL || node->s.exists == 0)
Per Cederqvist's avatar
Per Cederqvist committed
510
    {
511
	restart_kom("mark_text_as_changed(%lu): nonexistent.\n", text_no);
Per Cederqvist's avatar
Per Cederqvist committed
512 513
    }

514 515
    node->s.dirty = 1;
    text_set_mru (text_no);
Per Cederqvist's avatar
Per Cederqvist committed
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 604 605 606 607 608 609 610 611 612
/*
 * 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
613 614 615 616 617 618 619 620 621

/*
 * Person-related calls
 */


extern Success
cached_create_person( Pers_no person )
{
622 623
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
624 625 626 627 628 629 630 631
    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);
    }

632
    if ( get_pers_node(person) != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
633 634 635 636 637
    {
	restart_kom("cached_create_person(%d): Person existed.\n",
		    person);
    }

638 639 640 641 642
    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");
643

644 645 646
    node->ptr = alloc_person();
    node->s.dirty = 1;
    node->s.exists = 1;
Per Cederqvist's avatar
Per Cederqvist committed
647
    pers_set_mru( person );
648 649 650

    LOGACC(lt_create_pers, person);

Per Cederqvist's avatar
Per Cederqvist committed
651 652 653 654 655 656 657
    return OK;
}


extern Person *
cached_get_person_stat( Pers_no	person )
{
658 659
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
660 661 662 663
    TRACE2("cached_get_person_stat %d\n", person);

    if ( person == 0 )
    {
664
        err_stat = 0;
Per Cederqvist's avatar
Per Cederqvist committed
665 666 667
	kom_errno = KOM_CONF_ZERO;
	return NULL;
    }
668

669 670
    if ( person >= next_free_num )
    {
671
        err_stat = person;
672 673 674 675
	kom_errno = KOM_UNDEF_PERS;
	return NULL;
    }

676 677
    node = get_pers_node (person);

678
    if ( node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
679
    {
680
        err_stat = person;
Per Cederqvist's avatar
Per Cederqvist committed
681 682 683 684
	kom_errno = KOM_UNDEF_PERS;
	return NULL;
    }

685 686
    LOGACC(lt_pers_stat, person);

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

694
    if ( node->snap_shot != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
695
    {
696
	node->ptr = copy_person (node->snap_shot);
Per Cederqvist's avatar
Per Cederqvist committed
697
	pers_set_mru (person);
698
	++pers_mcb->hits;
699
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
700 701
    }

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

704
    ++pers_mcb->misses;
Per Cederqvist's avatar
Per Cederqvist committed
705
    pers_set_mru (person);
706
    return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
707 708 709 710 711 712
}


/*
 * Conference-related calls
 */
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728


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);
    }
}


729 730 731 732 733
static void
init_small_conf(Small_conf *sc)
{
    sc->name = EMPTY_STRING;
    init_conf_type(&sc->type);
734
    sc->supervisor = 0;
735 736
    sc->highest_local_no = 0;
    sc->nice = param.default_nice;
737
    sc->keep_commented = param.default_keep_commented;
738 739
}

740 741 742 743 744
static Small_conf *
alloc_small_conf(void)
{
    Small_conf *s;
    s = smalloc(sizeof(Small_conf));
745
    init_small_conf(s);
746 747 748 749 750 751
    ++no_of_allocated_small_confs;

    return s;
}


752 753 754 755 756 757
/*
 * 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
758 759 760 761
cached_create_conf (String  name)
{
    Conference * conf_c;
    Conf_no	 conf_no;
762
    Cache_node  *node;
Per Cederqvist's avatar
Per Cederqvist committed
763 764 765 766 767

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

David Byers's avatar
David Byers committed
768
    if ( next_free_num >= param.max_conf )
Per Cederqvist's avatar
Per Cederqvist committed
769
    {
770
        err_stat = next_free_num;
Per Cederqvist's avatar
Per Cederqvist committed
771 772 773 774 775 776
	kom_errno = KOM_INDEX_OUT_OF_RANGE;
	return 0;
    }
    
    conf_no = next_free_num++;

777 778 779 780 781 782 783 784
    if (write_number_file() < 0)
    {
	next_free_num--;
	err_stat = 0;
	kom_errno = KOM_TEMPFAIL;
	return 0;
    }

785 786
    ++existing_confs;

787 788 789 790 791 792 793 794 795
    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
796 797
    conf_set_mru(conf_no);    

798
    zero_init_cache_node (pers_mcb, conf_no);
Per Cederqvist's avatar
Per Cederqvist committed
799 800 801 802 803 804
    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);

805
    TRACE2("Created conference number %d\n", conf_no);
806 807 808

    LOGACC(lt_create_conf, conf_no);

Per Cederqvist's avatar
Per Cederqvist committed
809 810 811 812 813 814 815
    return conf_no;
}


extern Success
cached_delete_conf( Conf_no	conf )
{
816 817
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
818 819
    if ( conf == 0 )
    {
820
        err_stat = conf;
Per Cederqvist's avatar
Per Cederqvist committed
821 822 823
	kom_errno = KOM_CONF_ZERO;
	return FAILURE;
    }
824

825 826
    if ( conf >= next_free_num )
    {
827
        err_stat = conf;
828 829 830 831
	kom_errno = KOM_UNDEF_CONF;
	return FAILURE;
    }

832 833
    node = get_conf_node (conf);

834
    if ( node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
835
    {
836
        err_stat = conf;
Per Cederqvist's avatar
Per Cederqvist committed
837 838 839 840
	kom_errno = KOM_UNDEF_CONF;
	return FAILURE;
    }

841
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
842
	kom_log("WNG: cached_delete_conf(%d): lock_cnt === %d\n",
843
	    conf, node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
844

David Byers's avatar
David Byers committed
845 846 847
    free_small_conf(small_conf_arr[conf]);
    small_conf_arr[conf] = NULL;

848 849 850
    free_conference(node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
851

852 853
    --existing_confs;

854 855
    LOGACC(lt_delete_conf, conf);

David Byers's avatar
Server:  
David Byers committed
856
    rebuild_matching_info_entry(conf);
Per Cederqvist's avatar
Per Cederqvist committed
857 858 859 860 861 862
    return OK;
}

Success
cached_delete_person(Pers_no pers)
{
863 864
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
865 866
    if ( pers == 0 )
    {
867
        err_stat = pers;
Per Cederqvist's avatar
Per Cederqvist committed
868 869 870
	kom_errno = KOM_CONF_ZERO;
	return FAILURE;
    }
871

872 873
    if ( pers >= next_free_num )
    {
David Byers's avatar
David Byers committed
874
	kom_log("cached_delete_person(%lu): next_free_num == %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
875
	    (unsigned long)pers, (unsigned long)next_free_num);
876
        err_stat = pers;
877 878 879 880
	kom_errno = KOM_UNDEF_PERS;
	return FAILURE;
    }

881 882 883
    node = get_pers_node (pers);

    if ( pers >= next_free_num || node == NULL || node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
884
    {
David Byers's avatar
David Byers committed
885
	kom_log("cached_delete_person(): attempt to delete void person.\n");
886
        err_stat = pers;
Per Cederqvist's avatar
Per Cederqvist committed
887 888 889 890
	kom_errno = KOM_UNDEF_PERS;
	return FAILURE;
    }

891
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
892
	kom_log("cached_delete_pers(%lu): lock_cnt === %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
893
	    (unsigned long)pers, (unsigned long)node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
894

895 896
    LOGACC(lt_delete_pers, pers);

897 898 899
    free_person (node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
900 901 902 903 904 905
    return OK;
}

Success
cached_delete_text(Text_no text)
{
906 907
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
908 909
    if ( text == 0 )
    {
910
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
911 912 913
	kom_errno = KOM_TEXT_ZERO;
	return FAILURE;
    }
914 915 916 917 918

    node = get_text_node (text);

    if ( text >= next_text_num || node == NULL
	|| node->s.exists == 0 )
Per Cederqvist's avatar
Per Cederqvist committed
919
    {
David Byers's avatar
David Byers committed
920
	kom_log("cached_delete_text(): attempt to delete void text %lu.\n", text);
921
        err_stat = text;
Per Cederqvist's avatar
Per Cederqvist committed
922 923 924 925
	kom_errno = KOM_NO_SUCH_TEXT;
	return FAILURE;
    }

926
    if ( node->lock_cnt > 0 )
David Byers's avatar
David Byers committed
927
	kom_log("cached_delete_text(%lu): lock_cnt === %d\n",
928
	    text, node->lock_cnt);
Per Cederqvist's avatar
Per Cederqvist committed
929 930


931 932 933
    free_text_stat(node->ptr);
    node->ptr = NULL;
    node->s.exists = 0;
Per Cederqvist's avatar
Per Cederqvist committed
934

935 936 937
#ifdef LOGACCESSES
    if (garb_running)
    {
938
	LOGACC(lt_garb_text, text);
939 940
    }
    else
941
	LOGACC(lt_delete_text, text);
942
#endif
Per Cederqvist's avatar
Per Cederqvist committed
943 944 945 946 947
    return OK;
}


extern Conference *
948
cached_get_conf_stat (Conf_no   conf_no)
Per Cederqvist's avatar
Per Cederqvist committed
949
{
950 951
    Cache_node *node;

Per Cederqvist's avatar
Per Cederqvist committed
952 953 954 955
    TRACE2("cached_get_conf_stat %d\n", conf_no);

    if ( conf_no == 0 )
    {
956
        err_stat = conf_no;
Per Cederqvist's avatar
Per Cederqvist committed
957 958 959
	kom_errno = KOM_CONF_ZERO;
	return NULL;
    }
960 961 962 963

    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
964
    {
965
        err_stat = conf_no;
Per Cederqvist's avatar
Per Cederqvist committed
966 967 968 969
	kom_errno = KOM_UNDEF_CONF;
	return NULL;
    }

970 971
    LOGACC(lt_conf_stat, conf_no);

972
    if ( node->ptr != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
973
    {
974
	conf_set_mru (conf_no);
975
	++conf_mcb->hits;
976
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
977 978
    }

979
    if ( node->snap_shot != NULL )
Per Cederqvist's avatar
Per Cederqvist committed
980
    {
981
	node->ptr = copy_conference (node->snap_shot);
Per Cederqvist's avatar
Per Cederqvist committed
982
	conf_set_mru (conf_no);
983
	++conf_mcb->hits;
984
	return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
985 986
    }

987
    node->ptr = read_conference(file_a, node->pos, node->size);
988
    ++conf_mcb->misses;
Per Cederqvist's avatar
Per Cederqvist committed
989 990

    conf_set_mru (conf_no);
991
    return node->ptr;
Per Cederqvist's avatar
Per Cederqvist committed
992 993 994 995 996 997 998 999
}

/*
 * Return TRUE if conf_no exists.
 */
Bool
cached_conf_exists(Conf_no conf_no)
{
1000 1001 1002
    if (conf_no == 0 || conf_no >= next_free_num )
	return FALSE;

David Byers's avatar
David Byers committed
1003
    return small_conf_arr[conf_no] != NULL ? TRUE : FALSE;
Per Cederqvist's avatar
Per Cederqvist committed
1004 1005 1006 1007 1008 1009 1010 1011
}

    
/*
 * Calls to handle texts
 */

/*
1012
 * FIXME (bug 171): cached_get_text() should return Success.
Per Cederqvist's avatar
Per Cederqvist committed
1013 1014 1015 1016 1017 1018 1019
 */
extern String
cached_get_text( Text_no text )
{
    String  the_string;
    Text_stat *t_stat;

1020
    TRACE2("cached_get_text %lu\n", text);
Per Cederqvist's avatar
Per Cederqvist committed
1021 1022 1023 1024 1025

    if ( (t_stat = cached_get_text_stat (text)) == NULL )
	return EMPTY_STRING;
    else
    {
1026
	LOGACC(lt_text_mass, text);
Per Cederqvist's avatar
Per Cederqvist committed
1027 1028 1029 1030 1031
	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
1032
	    != (size_t)the_string.len )
Per Cederqvist's avatar
Per Cederqvist committed
1033
	{
David Byers's avatar
David Byers committed
1034
	    kom_log("WARNING: cached_get_text: premature end on text %lu\n",
Per Cederqvist's avatar
Per Cederqvist committed
1035 1036 1037 1038 1039 1040