rdesktop/trunk/pstcache.c

/* -*- c-basic-offset: 8 -*-
   rdesktop: A Remote Desktop Protocol client.
   Persistent Bitmap Cache routines
   Copyright (C) Jeroen Meijer 2004-2008

   This program 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 2 of the License, or
   (at your option) any later version.

   This program 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 this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "rdesktop.h"

#define MAX_CELL_SIZE           0x1000  /* pixels */

#define IS_PERSISTENT(id) (id < 8 && g_pstcache_fd[id] > 0)

extern int g_server_depth;
extern RD_BOOL g_bitmap_cache;
extern RD_BOOL g_bitmap_cache_persist_enable;
extern RD_BOOL g_bitmap_cache_precache;

int g_pstcache_fd[8];
int g_pstcache_Bpp;
RD_BOOL g_pstcache_enumerated = False;
uint8 zero_key[] = { 0, 0, 0, 0, 0, 0, 0, 0 };


/* Update mru stamp/index for a bitmap */
void
pstcache_touch_bitmap(uint8 cache_id, uint16 cache_idx, uint32 stamp)
{
        int fd;

        if (!IS_PERSISTENT(cache_id) || cache_idx >= BMPCACHE2_NUM_PSTCELLS)
                return;

        fd = g_pstcache_fd[cache_id];
        rd_lseek_file(fd, 12 + cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
        rd_write_file(fd, &stamp, sizeof(stamp));
}

/* Load a bitmap from the persistent cache */
RD_BOOL
pstcache_load_bitmap(uint8 cache_id, uint16 cache_idx)
{
        uint8 *celldata;
        int fd;
        CELLHEADER cellhdr;
        RD_HBITMAP bitmap;

        if (!g_bitmap_cache_persist_enable)
                return False;

        if (!IS_PERSISTENT(cache_id) || cache_idx >= BMPCACHE2_NUM_PSTCELLS)
                return False;

        fd = g_pstcache_fd[cache_id];
        rd_lseek_file(fd, cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
        rd_read_file(fd, &cellhdr, sizeof(CELLHEADER));
        celldata = (uint8 *) xmalloc(cellhdr.length);
        rd_read_file(fd, celldata, cellhdr.length);

        bitmap = ui_create_bitmap(cellhdr.width, cellhdr.height, celldata);
        DEBUG(("Load bitmap from disk: id=%d, idx=%d, bmp=0x%x)\n", cache_id, cache_idx,
               (unsigned int) bitmap));
        cache_put_bitmap(cache_id, cache_idx, bitmap);

        xfree(celldata);
        return True;
}

/* Store a bitmap in the persistent cache */
RD_BOOL
pstcache_save_bitmap(uint8 cache_id, uint16 cache_idx, uint8 * key,
                     uint8 width, uint8 height, uint16 length, uint8 * data)
{
        int fd;
        CELLHEADER cellhdr;

        if (!IS_PERSISTENT(cache_id) || cache_idx >= BMPCACHE2_NUM_PSTCELLS)
                return False;

        memcpy(cellhdr.key, key, sizeof(HASH_KEY));
        cellhdr.width = width;
        cellhdr.height = height;
        cellhdr.length = length;
        cellhdr.stamp = 0;

        fd = g_pstcache_fd[cache_id];
        rd_lseek_file(fd, cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
        rd_write_file(fd, &cellhdr, sizeof(CELLHEADER));
        rd_write_file(fd, data, length);

        return True;
}

/* List the bitmap keys from the persistent cache file */
int
pstcache_enumerate(uint8 id, HASH_KEY * keylist)
{
        int fd, n;
        uint16 idx;
        sint16 mru_idx[0xa00];
        uint32 mru_stamp[0xa00];
        CELLHEADER cellhdr;

        if (!(g_bitmap_cache && g_bitmap_cache_persist_enable && IS_PERSISTENT(id)))
                return 0;

        /* The server disconnects if the bitmap cache content is sent more than once */
        if (g_pstcache_enumerated)
                return 0;

        DEBUG_RDP5(("Persistent bitmap cache enumeration... "));
        for (idx = 0; idx < BMPCACHE2_NUM_PSTCELLS; idx++)
        {
                fd = g_pstcache_fd[id];
                rd_lseek_file(fd, idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
                if (rd_read_file(fd, &cellhdr, sizeof(CELLHEADER)) <= 0)
                        break;

                if (memcmp(cellhdr.key, zero_key, sizeof(HASH_KEY)) != 0)
                {
                        memcpy(keylist[idx], cellhdr.key, sizeof(HASH_KEY));

                        /* Pre-cache (not possible for 8 bit colour depth cause it needs a colourmap) */
                        if (g_bitmap_cache_precache && cellhdr.stamp && g_server_depth > 8)
                                pstcache_load_bitmap(id, idx);

                        /* Sort by stamp */
                        for (n = idx; n > 0 && cellhdr.stamp < mru_stamp[n - 1]; n--)
                        {
                                mru_idx[n] = mru_idx[n - 1];
                                mru_stamp[n] = mru_stamp[n - 1];
                        }

                        mru_idx[n] = idx;
                        mru_stamp[n] = cellhdr.stamp;
                }
                else
                {
                        break;
                }
        }

        DEBUG_RDP5(("%d cached bitmaps.\n", idx));

        cache_rebuild_bmpcache_linked_list(id, mru_idx, idx);
        g_pstcache_enumerated = True;
        return idx;
}

/* initialise the persistent bitmap cache */
RD_BOOL
pstcache_init(uint8 cache_id)
{
        int fd;
        char filename[256];

        if (g_pstcache_enumerated)
                return True;

        g_pstcache_fd[cache_id] = 0;

        if (!(g_bitmap_cache && g_bitmap_cache_persist_enable))
                return False;

        if (!rd_pstcache_mkdir())
        {
                DEBUG(("failed to get/make cache directory!\n"));
                return False;
        }

        g_pstcache_Bpp = (g_server_depth + 7) / 8;
        sprintf(filename, "cache/pstcache_%d_%d", cache_id, g_pstcache_Bpp);
        DEBUG(("persistent bitmap cache file: %s\n", filename));

        fd = rd_open_file(filename);
        if (fd == -1)
                return False;

        if (!rd_lock_file(fd, 0, 0))
        {
                warning("Persistent bitmap caching is disabled. (The file is already in use)\n");
                rd_close_file(fd);
                return False;
        }

        g_pstcache_fd[cache_id] = fd;
        return True;
}
1	/* -- c-basic-offset: 8 --
2	rdesktop: A Remote Desktop Protocol client.
3	Persistent Bitmap Cache routines
4	Copyright (C) Jeroen Meijer 2004-2008
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
8	the Free Software Foundation; either version 2 of the License, or
9	(at your option) any later version.
10
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.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
19	*/
20
21	#include "rdesktop.h"
22
23	#define MAX_CELL_SIZE 0x1000 /* pixels */
24
25	#define IS_PERSISTENT(id) (id < 8 && g_pstcache_fd[id] > 0)
26
27	extern int g_server_depth;
28	extern RD_BOOL g_bitmap_cache;
29	extern RD_BOOL g_bitmap_cache_persist_enable;
30	extern RD_BOOL g_bitmap_cache_precache;
31
32	int g_pstcache_fd[8];
33	int g_pstcache_Bpp;
34	RD_BOOL g_pstcache_enumerated = False;
35	uint8 zero_key[] = { 0, 0, 0, 0, 0, 0, 0, 0 };
36
37
38	/* Update mru stamp/index for a bitmap */
39	void
40	pstcache_touch_bitmap(uint8 cache_id, uint16 cache_idx, uint32 stamp)
41	{
42	int fd;
43
44	if (!IS_PERSISTENT(cache_id) \|\| cache_idx >= BMPCACHE2_NUM_PSTCELLS)
45	return;
46
47	fd = g_pstcache_fd[cache_id];
48	rd_lseek_file(fd, 12 + cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
49	rd_write_file(fd, &stamp, sizeof(stamp));
50	}
51
52	/* Load a bitmap from the persistent cache */
53	RD_BOOL
54	pstcache_load_bitmap(uint8 cache_id, uint16 cache_idx)
55	{
56	uint8 *celldata;
57	int fd;
58	CELLHEADER cellhdr;
59	RD_HBITMAP bitmap;
60
61	if (!g_bitmap_cache_persist_enable)
62	return False;
63
64	if (!IS_PERSISTENT(cache_id) \|\| cache_idx >= BMPCACHE2_NUM_PSTCELLS)
65	return False;
66
67	fd = g_pstcache_fd[cache_id];
68	rd_lseek_file(fd, cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
69	rd_read_file(fd, &cellhdr, sizeof(CELLHEADER));
70	celldata = (uint8 *) xmalloc(cellhdr.length);
71	rd_read_file(fd, celldata, cellhdr.length);
72
73	bitmap = ui_create_bitmap(cellhdr.width, cellhdr.height, celldata);
74	DEBUG(("Load bitmap from disk: id=%d, idx=%d, bmp=0x%x)\n", cache_id, cache_idx,
75	(unsigned int) bitmap));
76	cache_put_bitmap(cache_id, cache_idx, bitmap);
77
78	xfree(celldata);
79	return True;
80	}
81
82	/* Store a bitmap in the persistent cache */
83	RD_BOOL
84	pstcache_save_bitmap(uint8 cache_id, uint16 cache_idx, uint8 * key,
85	uint8 width, uint8 height, uint16 length, uint8 * data)
86	{
87	int fd;
88	CELLHEADER cellhdr;
89
90	if (!IS_PERSISTENT(cache_id) \|\| cache_idx >= BMPCACHE2_NUM_PSTCELLS)
91	return False;
92
93	memcpy(cellhdr.key, key, sizeof(HASH_KEY));
94	cellhdr.width = width;
95	cellhdr.height = height;
96	cellhdr.length = length;
97	cellhdr.stamp = 0;
98
99	fd = g_pstcache_fd[cache_id];
100	rd_lseek_file(fd, cache_idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
101	rd_write_file(fd, &cellhdr, sizeof(CELLHEADER));
102	rd_write_file(fd, data, length);
103
104	return True;
105	}
106
107	/* List the bitmap keys from the persistent cache file */
108	int
109	pstcache_enumerate(uint8 id, HASH_KEY * keylist)
110	{
111	int fd, n;
112	uint16 idx;
113	sint16 mru_idx[0xa00];
114	uint32 mru_stamp[0xa00];
115	CELLHEADER cellhdr;
116
117	if (!(g_bitmap_cache && g_bitmap_cache_persist_enable && IS_PERSISTENT(id)))
118	return 0;
119
120	/* The server disconnects if the bitmap cache content is sent more than once */
121	if (g_pstcache_enumerated)
122	return 0;
123
124	DEBUG_RDP5(("Persistent bitmap cache enumeration... "));
125	for (idx = 0; idx < BMPCACHE2_NUM_PSTCELLS; idx++)
126	{
127	fd = g_pstcache_fd[id];
128	rd_lseek_file(fd, idx * (g_pstcache_Bpp * MAX_CELL_SIZE + sizeof(CELLHEADER)));
129	if (rd_read_file(fd, &cellhdr, sizeof(CELLHEADER)) <= 0)
130	break;
131
132	if (memcmp(cellhdr.key, zero_key, sizeof(HASH_KEY)) != 0)
133	{
134	memcpy(keylist[idx], cellhdr.key, sizeof(HASH_KEY));
135
136	/* Pre-cache (not possible for 8 bit colour depth cause it needs a colourmap) */
137	if (g_bitmap_cache_precache && cellhdr.stamp && g_server_depth > 8)
138	pstcache_load_bitmap(id, idx);
139
140	/* Sort by stamp */
141	for (n = idx; n > 0 && cellhdr.stamp < mru_stamp[n - 1]; n--)
142	{
143	mru_idx[n] = mru_idx[n - 1];
144	mru_stamp[n] = mru_stamp[n - 1];
145	}
146
147	mru_idx[n] = idx;
148	mru_stamp[n] = cellhdr.stamp;
149	}
150	else
151	{
152	break;
153	}
154	}
155
156	DEBUG_RDP5(("%d cached bitmaps.\n", idx));
157
158	cache_rebuild_bmpcache_linked_list(id, mru_idx, idx);
159	g_pstcache_enumerated = True;
160	return idx;
161	}
162
163	/* initialise the persistent bitmap cache */
164	RD_BOOL
165	pstcache_init(uint8 cache_id)
166	{
167	int fd;
168	char filename[256];
169
170	if (g_pstcache_enumerated)
171	return True;
172
173	g_pstcache_fd[cache_id] = 0;
174
175	if (!(g_bitmap_cache && g_bitmap_cache_persist_enable))
176	return False;
177
178	if (!rd_pstcache_mkdir())
179	{
180	DEBUG(("failed to get/make cache directory!\n"));
181	return False;
182	}
183
184	g_pstcache_Bpp = (g_server_depth + 7) / 8;
185	sprintf(filename, "cache/pstcache_%d_%d", cache_id, g_pstcache_Bpp);
186	DEBUG(("persistent bitmap cache file: %s\n", filename));
187
188	fd = rd_open_file(filename);
189	if (fd == -1)
190	return False;
191
192	if (!rd_lock_file(fd, 0, 0))
193	{
194	warning("Persistent bitmap caching is disabled. (The file is already in use)\n");
195	rd_close_file(fd);
196	return False;
197	}
198
199	g_pstcache_fd[cache_id] = fd;
200	return True;
201	}