a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* -*- c-basic-offset: 8 -*-
a180a41bba1d50822df23fff0099e90b86638b89vboxsync rdesktop: A Remote Desktop Protocol client.
a180a41bba1d50822df23fff0099e90b86638b89vboxsync Cache routines
a180a41bba1d50822df23fff0099e90b86638b89vboxsync Copyright (C) Matthew Chapman <matthewc.unsw.edu.au> 1999-2008
a180a41bba1d50822df23fff0099e90b86638b89vboxsync Copyright (C) Jeroen Meijer <jeroen@oldambt7.com> 2005
a180a41bba1d50822df23fff0099e90b86638b89vboxsync Copyright 2003-2011 Peter Astrand <astrand@cendio.se> for Cendio AB
a180a41bba1d50822df23fff0099e90b86638b89vboxsync This program is free software: you can redistribute it and/or modify
a180a41bba1d50822df23fff0099e90b86638b89vboxsync it under the terms of the GNU General Public License as published by
a180a41bba1d50822df23fff0099e90b86638b89vboxsync the Free Software Foundation, either version 3 of the License, or
a180a41bba1d50822df23fff0099e90b86638b89vboxsync (at your option) any later version.
a180a41bba1d50822df23fff0099e90b86638b89vboxsync This program is distributed in the hope that it will be useful,
a180a41bba1d50822df23fff0099e90b86638b89vboxsync but WITHOUT ANY WARRANTY; without even the implied warranty of
a180a41bba1d50822df23fff0099e90b86638b89vboxsync MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a180a41bba1d50822df23fff0099e90b86638b89vboxsync GNU General Public License for more details.
a180a41bba1d50822df23fff0099e90b86638b89vboxsync You should have received a copy of the GNU General Public License
a180a41bba1d50822df23fff0099e90b86638b89vboxsync along with this program. If not, see <http://www.gnu.org/licenses/>.
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * Oracle GPL Disclaimer: For the avoidance of doubt, except that if any license choice
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * other than GPL or LGPL is available it will apply instead, Oracle elects to use only
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * the General Public License version 2 (GPLv2) at this time for any software where
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * a choice of GPL license versions is made available with the language indicating
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * that GPLv2 or any later version may be used, or where a choice of which version
6e9aa255e3376b2da5824c09c4c62bc233463bfevboxsync * of the GPL is applied is otherwise unspecified.
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* BITMAP CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync#define NUM_ELEMENTS(array) (sizeof(array) / sizeof(array[0]))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync * TODO: Test for optimal value of BUMP_COUNT. TO_TOP gives lowest cpu utilisation but using
a180a41bba1d50822df23fff0099e90b86638b89vboxsync * a positive value will hopefully result in less frequently used bitmaps having a greater chance
a180a41bba1d50822df23fff0099e90b86638b89vboxsync * of being evicted from the cache, and therby reducing the need to load bitmaps from disk.
a180a41bba1d50822df23fff0099e90b86638b89vboxsyncstatic int g_bmpcache_lru[3] = { NOT_SET, NOT_SET, NOT_SET };
a180a41bba1d50822df23fff0099e90b86638b89vboxsyncstatic int g_bmpcache_mru[3] = { NOT_SET, NOT_SET, NOT_SET };
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Setup the bitmap cache lru/mru linked list */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_rebuild_bmpcache_linked_list(uint8 id, sint16 * idx, int count)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync int n = count, c = 0;
a180a41bba1d50822df23fff0099e90b86638b89vboxsync /* find top, skip evicted bitmaps */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync while (--n >= 0 && g_bmpcache[id][idx[n]].bitmap == NULL);
a180a41bba1d50822df23fff0099e90b86638b89vboxsync /* link list */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync while (n >= 0)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync /* skip evicted bitmaps */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync while (--n >= 0 && g_bmpcache[id][idx[n]].bitmap == NULL);
a180a41bba1d50822df23fff0099e90b86638b89vboxsync error("Oops. %d in bitmap cache linked list, %d in ui cache...\n", c,
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Move a bitmap to a new position in the linked list. */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync DEBUG_RDP5(("bump bitmap: id=%d, idx=%d, bump=%d\n", id, idx, bump));
a180a41bba1d50822df23fff0099e90b86638b89vboxsync /* remove */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync /* insert */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Evict the least-recently used bitmap from the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync DEBUG_RDP5(("evict bitmap: id=%d idx=%d n_idx=%d bmp=%p\n", id, idx, n_idx,
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve a bitmap from the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync if ((id < NUM_ELEMENTS(g_bmpcache)) && (idx < NUM_ELEMENTS(g_bmpcache[0])))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync if (g_bmpcache[id][idx].bitmap || pstcache_load_bitmap(id, idx))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync else if ((id < NUM_ELEMENTS(g_volatile_bc)) && (idx == 0x7fff))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store a bitmap in the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_put_bitmap(uint8 id, uint16 idx, RD_HBITMAP bitmap)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync if ((id < NUM_ELEMENTS(g_bmpcache)) && (idx < NUM_ELEMENTS(g_bmpcache[0])))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync g_bmpcache[id][idx].previous = g_bmpcache[id][idx].next = NOT_SET;
a180a41bba1d50822df23fff0099e90b86638b89vboxsync else if ((id < NUM_ELEMENTS(g_volatile_bc)) && (idx == 0x7fff))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Updates the persistent bitmap cache MRU information on exit */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync DEBUG_RDP5(("Saving cache state for bitmap cache %d...", id));
a180a41bba1d50822df23fff0099e90b86638b89vboxsync while (idx >= 0)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* FONT CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve a glyph from the font cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync if ((font < NUM_ELEMENTS(g_fontcache)) && (character < NUM_ELEMENTS(g_fontcache[0])))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store a glyph in the font cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_put_font(uint8 font, uint16 character, uint16 offset,
a180a41bba1d50822df23fff0099e90b86638b89vboxsync uint16 baseline, uint16 width, uint16 height, RD_HGLYPH pixmap)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync if ((font < NUM_ELEMENTS(g_fontcache)) && (character < NUM_ELEMENTS(g_fontcache[0])))
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* TEXT CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve a text item from the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store a text item in the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_put_text(uint8 cache_id, void *data, int length)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* DESKTOP CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve desktop data from the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_get_desktop(uint32 offset, int cx, int cy, int bytes_per_pixel)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store desktop data in the cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_put_desktop(uint32 offset, int cx, int cy, int scanline, int bytes_per_pixel, uint8 * data)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* CURSOR CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve cursor from cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store cursor in cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsynccache_put_cursor(uint16 cache_idx, RD_HCURSOR cursor)
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* BRUSH CACHE */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* index 0 is 2 colour brush, index 1 is muti colour brush */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Retrieve brush from cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* Store brush in cache */
a180a41bba1d50822df23fff0099e90b86638b89vboxsync/* this function takes over the data pointer in struct, eg, caller gives it up */