binutils-gdb/bfd/cache.c

312 lines
7.0 KiB
C
Raw Normal View History

/* BFD library -- caching of file descriptors.
Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
Hacked by Steve Chamberlain of Cygnus Support (steve@cygnus.com).
1991-03-21 22:11:25 +01:00
This file is part of BFD, the Binary File Descriptor library.
1991-03-21 22:11:25 +01:00
This program is free software; you can redistribute it and/or modify
1991-03-21 22:11:25 +01:00
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
1991-03-21 22:11:25 +01:00
This program is distributed in the hope that it will be useful,
1991-03-21 22:11:25 +01:00
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 this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
/*
SECTION
1993-11-05 20:51:52 +01:00
File caching
The file caching mechanism is embedded within BFD and allows
the application to open as many BFDs as it wants without
regard to the underlying operating system's file descriptor
limit (often as low as 20 open files). The module in
<<cache.c>> maintains a least recently used list of
<<BFD_CACHE_MAX_OPEN>> files, and exports the name
1993-11-05 20:51:52 +01:00
<<bfd_cache_lookup>>, which runs around and makes sure that
the required BFD is open. If not, then it chooses a file to
close, closes it and opens the one wanted, returning its file
handle.
*/
1991-03-21 22:11:25 +01:00
#include "bfd.h"
#include "sysdep.h"
1991-03-21 22:11:25 +01:00
#include "libbfd.h"
/*
INTERNAL_FUNCTION
BFD_CACHE_MAX_OPEN macro
DESCRIPTION
The maximum number of files which the cache will keep open at
one time.
.#define BFD_CACHE_MAX_OPEN 10
*/
1991-03-21 22:11:25 +01:00
1993-11-05 20:51:52 +01:00
static boolean
bfd_cache_delete PARAMS ((bfd *));
/* Number of bfds on the chain. All such bfds have their file open;
if it closed, they get snipd()d from the chain. */
1991-03-21 22:11:25 +01:00
static int open_files;
static bfd *cache_sentinel = 0; /* Chain of BFDs with active fds we've
1991-03-21 22:11:25 +01:00
opened */
/*
INTERNAL_FUNCTION
bfd_last_cache
SYNOPSIS
extern bfd *bfd_last_cache;
DESCRIPTION
Zero, or a pointer to the topmost BFD on the chain. This is
used by the <<bfd_cache_lookup>> macro in @file{libbfd.h} to
determine when it can avoid a function call.
*/
bfd *bfd_last_cache;
/*
1993-11-05 20:51:52 +01:00
INTERNAL_FUNCTION
bfd_cache_lookup
DESCRIPTION
Check to see if the required BFD is the same as the last one
looked up. If so, then it can use the stream in the BFD with
impunity, since it can't have changed since the last lookup;
otherwise, it has to perform the complicated lookup function.
.#define bfd_cache_lookup(x) \
. ((x)==bfd_last_cache? \
. (FILE*)(bfd_last_cache->iostream): \
. bfd_cache_lookup_worker(x))
*/
1991-03-21 22:11:25 +01:00
static void
1991-04-23 18:02:09 +02:00
DEFUN_VOID(close_one)
1991-03-21 22:11:25 +01:00
{
bfd *kill = cache_sentinel;
if (kill == 0) /* Nothing in the cache */
return ;
/* We can only close files that want to play this game. */
while (!kill->cacheable) {
kill = kill->lru_prev;
if (kill == cache_sentinel) /* Nobody wants to play */
return ;
}
kill->where = ftell((FILE *)(kill->iostream));
(void) bfd_cache_delete(kill);
1991-03-21 22:11:25 +01:00
}
/* Cuts the BFD abfd out of the chain in the cache */
1991-03-21 22:11:25 +01:00
static void
1991-04-23 18:02:09 +02:00
DEFUN(snip,(abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
abfd->lru_prev->lru_next = abfd->lru_next;
abfd->lru_next->lru_prev = abfd->lru_prev;
if (cache_sentinel == abfd) cache_sentinel = (bfd *)NULL;
}
static boolean
1991-04-23 18:02:09 +02:00
DEFUN(bfd_cache_delete,(abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
boolean ret;
if (fclose ((FILE *)(abfd->iostream)) == 0)
ret = true;
else
{
ret = false;
bfd_set_error (bfd_error_system_call);
}
1991-03-21 22:11:25 +01:00
snip (abfd);
abfd->iostream = NULL;
open_files--;
1991-04-23 18:02:09 +02:00
bfd_last_cache = 0;
return ret;
1991-03-21 22:11:25 +01:00
}
static bfd *
1991-04-23 18:02:09 +02:00
DEFUN(insert,(x,y),
bfd *x AND
bfd *y)
1991-03-21 22:11:25 +01:00
{
if (y) {
x->lru_next = y;
x->lru_prev = y->lru_prev;
y->lru_prev->lru_next = x;
y->lru_prev = x;
}
else {
x->lru_prev = x;
x->lru_next = x;
}
return x;
}
1993-11-05 20:51:52 +01:00
/* Initialize a BFD by putting it on the cache LRU. */
1991-03-21 22:11:25 +01:00
void
1991-04-23 18:02:09 +02:00
DEFUN(bfd_cache_init,(abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
1993-11-05 20:51:52 +01:00
if (open_files >= BFD_CACHE_MAX_OPEN)
close_one ();
1991-03-21 22:11:25 +01:00
cache_sentinel = insert(abfd, cache_sentinel);
1993-11-05 20:51:52 +01:00
++open_files;
1991-03-21 22:11:25 +01:00
}
/*
INTERNAL_FUNCTION
bfd_cache_close
1993-11-05 20:51:52 +01:00
SYNOPSIS
boolean bfd_cache_close (bfd *abfd);
DESCRIPTION
1993-11-05 20:51:52 +01:00
Remove the BFD @var{abfd} from the cache. If the attached file is open,
then close it too.
RETURNS
<<false>> is returned if closing the file fails, <<true>> is
returned if all is well.
*/
boolean
1991-04-23 18:02:09 +02:00
DEFUN(bfd_cache_close,(abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
/* If this file is open then remove from the chain */
if (abfd->iostream)
{
return bfd_cache_delete(abfd);
}
else
{
return true;
1991-03-21 22:11:25 +01:00
}
}
/*
INTERNAL_FUNCTION
bfd_open_file
1993-11-05 20:51:52 +01:00
SYNOPSIS
FILE* bfd_open_file(bfd *abfd);
DESCRIPTION
1993-11-05 20:51:52 +01:00
Call the OS to open a file for @var{abfd}. Return the <<FILE *>>
(possibly <<NULL>>) that results from this operation. Set up the
1993-11-05 20:51:52 +01:00
BFD so that future accesses know the file is open. If the <<FILE *>>
returned is <<NULL>>, then it won't have been put in the
cache, so it won't have to be removed from it.
*/
1991-03-21 22:11:25 +01:00
FILE *
1991-04-23 18:02:09 +02:00
DEFUN(bfd_open_file, (abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
abfd->cacheable = true; /* Allow it to be closed later. */
if(open_files >= BFD_CACHE_MAX_OPEN) {
close_one();
}
switch (abfd->direction) {
case read_direction:
case no_direction:
abfd->iostream = (char *) fopen(abfd->filename, FOPEN_RB);
break;
case both_direction:
case write_direction:
if (abfd->opened_once == true) {
abfd->iostream = (char *) fopen(abfd->filename, FOPEN_RUB);
if (!abfd->iostream) {
abfd->iostream = (char *) fopen(abfd->filename, FOPEN_WUB);
}
} else {
/*open for creat */
abfd->iostream = (char *) fopen(abfd->filename, FOPEN_WB);
abfd->opened_once = true;
1991-03-21 22:11:25 +01:00
}
break;
}
if (abfd->iostream) {
bfd_cache_init (abfd);
}
1991-03-21 22:11:25 +01:00
return (FILE *)(abfd->iostream);
1991-03-21 22:11:25 +01:00
}
/*
INTERNAL_FUNCTION
bfd_cache_lookup_worker
1993-11-05 20:51:52 +01:00
SYNOPSIS
FILE *bfd_cache_lookup_worker(bfd *abfd);
DESCRIPTION
Called when the macro <<bfd_cache_lookup>> fails to find a
1993-11-05 20:51:52 +01:00
quick answer. Find a file descriptor for @var{abfd}. If
necessary, it open it. If there are already more than
<<BFD_CACHE_MAX_OPEN>> files open, it tries to close one first, to
avoid running out of file descriptors.
*/
1991-03-21 22:11:25 +01:00
FILE *
1991-04-23 18:02:09 +02:00
DEFUN(bfd_cache_lookup_worker,(abfd),
bfd *abfd)
1991-03-21 22:11:25 +01:00
{
if (abfd->my_archive)
1991-04-23 18:02:09 +02:00
{
abfd = abfd->my_archive;
}
1991-03-21 22:11:25 +01:00
/* Is this file already open .. if so then quick exit */
if (abfd->iostream)
1991-04-23 18:02:09 +02:00
{
if (abfd != cache_sentinel) {
/* Place onto head of lru chain */
snip (abfd);
cache_sentinel = insert(abfd, cache_sentinel);
}
1991-03-21 22:11:25 +01:00
}
/* This is a BFD without a stream -
1991-03-21 22:11:25 +01:00
so it must have been closed or never opened.
find an empty cache entry and use it. */
else
1991-04-23 18:02:09 +02:00
{
1991-03-21 22:11:25 +01:00
1991-04-23 18:02:09 +02:00
if (open_files >= BFD_CACHE_MAX_OPEN)
{
close_one();
}
1991-03-21 22:11:25 +01:00
1991-04-23 18:02:09 +02:00
BFD_ASSERT(bfd_open_file (abfd) != (FILE *)NULL) ;
fseek((FILE *)(abfd->iostream), abfd->where, false);
}
bfd_last_cache = abfd;
1991-03-21 22:11:25 +01:00
return (FILE *)(abfd->iostream);
}