New timing infrastructure. There's a new function schedule_timer()
[u/mdw/putty] / misc.c
diff --git a/misc.c b/misc.c
index ee1abf7..474bf02 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -1,6 +1,11 @@
-#include <windows.h>
+/*
+ * Platform-independent routines shared between all PuTTY programs.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
+#include <stdarg.h>
+#include <ctype.h>
 #include <assert.h>
 #include "putty.h"
 
  * String handling routines.
  */
 
-char *dupstr(char *s)
+char *dupstr(const char *s)
 {
-    int len = strlen(s);
-    char *p = smalloc(len + 1);
-    strcpy(p, s);
+    char *p = NULL;
+    if (s) {
+        int len = strlen(s);
+        p = snewn(len + 1, char);
+        strcpy(p, s);
+    }
     return p;
 }
 
 /* Allocate the concatenation of N strings. Terminate arg list with NULL. */
-char *dupcat(char *s1, ...)
+char *dupcat(const char *s1, ...)
 {
     int len;
     char *p, *q, *sn;
@@ -33,7 +41,7 @@ char *dupcat(char *s1, ...)
     }
     va_end(ap);
 
-    p = smalloc(len + 1);
+    p = snewn(len + 1, char);
     strcpy(p, s1);
     q = p + strlen(p);
 
@@ -50,6 +58,141 @@ char *dupcat(char *s1, ...)
     return p;
 }
 
+/*
+ * Do an sprintf(), but into a custom-allocated buffer.
+ * 
+ * Currently I'm doing this via vsnprintf. This has worked so far,
+ * but it's not good, because:
+ * 
+ *  - vsnprintf is not available on all platforms. There's an ifdef
+ *    to use `_vsnprintf', which seems to be the local name for it
+ *    on Windows. Other platforms may lack it completely, in which
+ *    case it'll be time to rewrite this function in a totally
+ *    different way.
+ * 
+ *  - technically you can't reuse a va_list like this: it is left
+ *    unspecified whether advancing a va_list pointer modifies its
+ *    value or something it points to, so on some platforms calling
+ *    vsnprintf twice on the same va_list might fail hideously. It
+ *    would be better to use the `va_copy' macro mandated by C99,
+ *    but that too is not yet ubiquitous.
+ * 
+ * The only `properly' portable solution I can think of is to
+ * implement my own format string scanner, which figures out an
+ * upper bound for the length of each formatting directive,
+ * allocates the buffer as it goes along, and calls sprintf() to
+ * actually process each directive. If I ever need to actually do
+ * this, some caveats:
+ * 
+ *  - It's very hard to find a reliable upper bound for
+ *    floating-point values. %f, in particular, when supplied with
+ *    a number near to the upper or lower limit of representable
+ *    numbers, could easily take several hundred characters. It's
+ *    probably feasible to predict this statically using the
+ *    constants in <float.h>, or even to predict it dynamically by
+ *    looking at the exponent of the specific float provided, but
+ *    it won't be fun.
+ * 
+ *  - Don't forget to _check_, after calling sprintf, that it's
+ *    used at most the amount of space we had available.
+ * 
+ *  - Fault any formatting directive we don't fully understand. The
+ *    aim here is to _guarantee_ that we never overflow the buffer,
+ *    because this is a security-critical function. If we see a
+ *    directive we don't know about, we should panic and die rather
+ *    than run any risk.
+ */
+char *dupprintf(const char *fmt, ...)
+{
+    char *ret;
+    va_list ap;
+    va_start(ap, fmt);
+    ret = dupvprintf(fmt, ap);
+    va_end(ap);
+    return ret;
+}
+char *dupvprintf(const char *fmt, va_list ap)
+{
+    char *buf;
+    int len, size;
+
+    buf = snewn(512, char);
+    size = 512;
+
+    while (1) {
+#ifdef _WINDOWS
+#define vsnprintf _vsnprintf
+#endif
+       len = vsnprintf(buf, size, fmt, ap);
+       if (len >= 0 && len < size) {
+           /* This is the C99-specified criterion for snprintf to have
+            * been completely successful. */
+           return buf;
+       } else if (len > 0) {
+           /* This is the C99 error condition: the returned length is
+            * the required buffer size not counting the NUL. */
+           size = len + 1;
+       } else {
+           /* This is the pre-C99 glibc error condition: <0 means the
+            * buffer wasn't big enough, so we enlarge it a bit and hope. */
+           size += 512;
+       }
+       buf = sresize(buf, size, char);
+    }
+}
+
+/*
+ * Read an entire line of text from a file. Return a buffer
+ * malloced to be as big as necessary (caller must free).
+ */
+char *fgetline(FILE *fp)
+{
+    char *ret = snewn(512, char);
+    int size = 512, len = 0;
+    while (fgets(ret + len, size - len, fp)) {
+       len += strlen(ret + len);
+       if (ret[len-1] == '\n')
+           break;                     /* got a newline, we're done */
+       size = len + 512;
+       ret = sresize(ret, size, char);
+    }
+    if (len == 0) {                   /* first fgets returned NULL */
+       sfree(ret);
+       return NULL;
+    }
+    ret[len] = '\0';
+    return ret;
+}
+
+/* ----------------------------------------------------------------------
+ * Base64 encoding routine. This is required in public-key writing
+ * but also in HTTP proxy handling, so it's centralised here.
+ */
+
+void base64_encode_atom(unsigned char *data, int n, char *out)
+{
+    static const char base64_chars[] =
+       "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+    unsigned word;
+
+    word = data[0] << 16;
+    if (n > 1)
+       word |= data[1] << 8;
+    if (n > 2)
+       word |= data[2];
+    out[0] = base64_chars[(word >> 18) & 0x3F];
+    out[1] = base64_chars[(word >> 12) & 0x3F];
+    if (n > 1)
+       out[2] = base64_chars[(word >> 6) & 0x3F];
+    else
+       out[2] = '=';
+    if (n > 2)
+       out[3] = base64_chars[word & 0x3F];
+    else
+       out[3] = '=';
+}
+
 /* ----------------------------------------------------------------------
  * Generic routines to deal with send buffers: a linked list of
  * smallish blocks, with the operations
@@ -59,6 +202,7 @@ char *dupcat(char *s1, ...)
  *  - return a (pointer,length) pair giving some initial data in
  *    the list, suitable for passing to a send or write system
  *    call
+ *  - retrieve a larger amount of initial data from the list
  *  - return the current size of the buffer chain in bytes
  */
 
@@ -93,9 +237,11 @@ int bufchain_size(bufchain *ch)
     return ch->buffersize;
 }
 
-void bufchain_add(bufchain *ch, void *data, int len)
+void bufchain_add(bufchain *ch, const void *data, int len)
 {
-    char *buf = (char *)data;
+    const char *buf = (const char *)data;
+
+    if (len == 0) return;
 
     ch->buffersize += len;
 
@@ -109,7 +255,7 @@ void bufchain_add(bufchain *ch, void *data, int len)
     while (len > 0) {
        int grainlen = min(len, BUFFER_GRANULE);
        struct bufchain_granule *newbuf;
-       newbuf = smalloc(sizeof(struct bufchain_granule));
+       newbuf = snew(struct bufchain_granule);
        newbuf->bufpos = 0;
        newbuf->buflen = grainlen;
        memcpy(newbuf->buf, buf, grainlen);
@@ -126,16 +272,23 @@ void bufchain_add(bufchain *ch, void *data, int len)
 
 void bufchain_consume(bufchain *ch, int len)
 {
+    struct bufchain_granule *tmp;
+
     assert(ch->buffersize >= len);
-    assert(ch->head != NULL && ch->head->bufpos + len <= ch->head->buflen);
-    ch->head->bufpos += len;
-    ch->buffersize -= len;
-    if (ch->head->bufpos >= ch->head->buflen) {
-       struct bufchain_granule *tmp = ch->head;
-       ch->head = tmp->next;
-       sfree(tmp);
-       if (!ch->head)
-           ch->tail = NULL;
+    while (len > 0) {
+       int remlen = len;
+       assert(ch->head != NULL);
+       if (remlen >= ch->head->buflen - ch->head->bufpos) {
+           remlen = ch->head->buflen - ch->head->bufpos;
+           tmp = ch->head;
+           ch->head = tmp->next;
+           sfree(tmp);
+           if (!ch->head)
+               ch->tail = NULL;
+       } else
+           ch->head->bufpos += remlen;
+       ch->buffersize -= remlen;
+       len -= remlen;
     }
 }
 
@@ -145,6 +298,28 @@ void bufchain_prefix(bufchain *ch, void **data, int *len)
     *data = ch->head->buf + ch->head->bufpos;
 }
 
+void bufchain_fetch(bufchain *ch, void *data, int len)
+{
+    struct bufchain_granule *tmp;
+    char *data_c = (char *)data;
+
+    tmp = ch->head;
+
+    assert(ch->buffersize >= len);
+    while (len > 0) {
+       int remlen = len;
+
+       assert(tmp != NULL);
+       if (remlen >= tmp->buflen - tmp->bufpos)
+           remlen = tmp->buflen - tmp->bufpos;
+       memcpy(data_c, tmp->buf + tmp->bufpos, remlen);
+
+       tmp = tmp->next;
+       len -= remlen;
+       data_c += remlen;
+    }
+}
+
 /* ----------------------------------------------------------------------
  * My own versions of malloc, realloc and free. Because I want
  * malloc and realloc to bomb out and exit the program if they run
@@ -156,225 +331,10 @@ void bufchain_prefix(bufchain *ch, void **data, int *len)
  */
 
 #ifdef MINEFIELD
-/*
- * Minefield - a Windows equivalent for Electric Fence
- */
-
-#define PAGESIZE 4096
-
-/*
- * Design:
- * 
- * We start by reserving as much virtual address space as Windows
- * will sensibly (or not sensibly) let us have. We flag it all as
- * invalid memory.
- * 
- * Any allocation attempt is satisfied by committing one or more
- * pages, with an uncommitted page on either side. The returned
- * memory region is jammed up against the _end_ of the pages.
- * 
- * Freeing anything causes instantaneous decommitment of the pages
- * involved, so stale pointers are caught as soon as possible.
- */
-
-static int minefield_initialised = 0;
-static void *minefield_region = NULL;
-static long minefield_size = 0;
-static long minefield_npages = 0;
-static long minefield_curpos = 0;
-static unsigned short *minefield_admin = NULL;
-static void *minefield_pages = NULL;
-
-static void minefield_admin_hide(int hide)
-{
-    int access = hide ? PAGE_NOACCESS : PAGE_READWRITE;
-    VirtualProtect(minefield_admin, minefield_npages * 2, access, NULL);
-}
-
-static void minefield_init(void)
-{
-    int size;
-    int admin_size;
-    int i;
-
-    for (size = 0x40000000; size > 0; size = ((size >> 3) * 7) & ~0xFFF) {
-       minefield_region = VirtualAlloc(NULL, size,
-                                       MEM_RESERVE, PAGE_NOACCESS);
-       if (minefield_region)
-           break;
-    }
-    minefield_size = size;
-
-    /*
-     * Firstly, allocate a section of that to be the admin block.
-     * We'll need a two-byte field for each page.
-     */
-    minefield_admin = minefield_region;
-    minefield_npages = minefield_size / PAGESIZE;
-    admin_size = (minefield_npages * 2 + PAGESIZE - 1) & ~(PAGESIZE - 1);
-    minefield_npages = (minefield_size - admin_size) / PAGESIZE;
-    minefield_pages = (char *) minefield_region + admin_size;
-
-    /*
-     * Commit the admin region.
-     */
-    VirtualAlloc(minefield_admin, minefield_npages * 2,
-                MEM_COMMIT, PAGE_READWRITE);
-
-    /*
-     * Mark all pages as unused (0xFFFF).
-     */
-    for (i = 0; i < minefield_npages; i++)
-       minefield_admin[i] = 0xFFFF;
-
-    /*
-     * Hide the admin region.
-     */
-    minefield_admin_hide(1);
-
-    minefield_initialised = 1;
-}
-
-static void minefield_bomb(void)
-{
-    div(1, *(int *) minefield_pages);
-}
-
-static void *minefield_alloc(int size)
-{
-    int npages;
-    int pos, lim, region_end, region_start;
-    int start;
-    int i;
-
-    npages = (size + PAGESIZE - 1) / PAGESIZE;
-
-    minefield_admin_hide(0);
-
-    /*
-     * Search from current position until we find a contiguous
-     * bunch of npages+2 unused pages.
-     */
-    pos = minefield_curpos;
-    lim = minefield_npages;
-    while (1) {
-       /* Skip over used pages. */
-       while (pos < lim && minefield_admin[pos] != 0xFFFF)
-           pos++;
-       /* Count unused pages. */
-       start = pos;
-       while (pos < lim && pos - start < npages + 2 &&
-              minefield_admin[pos] == 0xFFFF)
-           pos++;
-       if (pos - start == npages + 2)
-           break;
-       /* If we've reached the limit, reset the limit or stop. */
-       if (pos >= lim) {
-           if (lim == minefield_npages) {
-               /* go round and start again at zero */
-               lim = minefield_curpos;
-               pos = 0;
-           } else {
-               minefield_admin_hide(1);
-               return NULL;
-           }
-       }
-    }
-
-    minefield_curpos = pos - 1;
-
-    /*
-     * We have npages+2 unused pages starting at start. We leave
-     * the first and last of these alone and use the rest.
-     */
-    region_end = (start + npages + 1) * PAGESIZE;
-    region_start = region_end - size;
-    /* FIXME: could align here if we wanted */
-
-    /*
-     * Update the admin region.
-     */
-    for (i = start + 2; i < start + npages - 1; i++)
-       minefield_admin[i] = 0xFFFE;   /* used but no region starts here */
-    minefield_admin[start + 1] = region_start % PAGESIZE;
-
-    minefield_admin_hide(1);
-
-    VirtualAlloc((char *) minefield_pages + region_start, size,
-                MEM_COMMIT, PAGE_READWRITE);
-    return (char *) minefield_pages + region_start;
-}
-
-static void minefield_free(void *ptr)
-{
-    int region_start, i, j;
-
-    minefield_admin_hide(0);
-
-    region_start = (char *) ptr - (char *) minefield_pages;
-    i = region_start / PAGESIZE;
-    if (i < 0 || i >= minefield_npages ||
-       minefield_admin[i] != region_start % PAGESIZE)
-       minefield_bomb();
-    for (j = i; j < minefield_npages && minefield_admin[j] != 0xFFFF; j++) {
-       minefield_admin[j] = 0xFFFF;
-    }
-
-    VirtualFree(ptr, j * PAGESIZE - region_start, MEM_DECOMMIT);
-
-    minefield_admin_hide(1);
-}
-
-static int minefield_get_size(void *ptr)
-{
-    int region_start, i, j;
-
-    minefield_admin_hide(0);
-
-    region_start = (char *) ptr - (char *) minefield_pages;
-    i = region_start / PAGESIZE;
-    if (i < 0 || i >= minefield_npages ||
-       minefield_admin[i] != region_start % PAGESIZE)
-       minefield_bomb();
-    for (j = i; j < minefield_npages && minefield_admin[j] != 0xFFFF; j++);
-
-    minefield_admin_hide(1);
-
-    return j * PAGESIZE - region_start;
-}
-
-static void *minefield_c_malloc(size_t size)
-{
-    if (!minefield_initialised)
-       minefield_init();
-    return minefield_alloc(size);
-}
-
-static void minefield_c_free(void *p)
-{
-    if (!minefield_initialised)
-       minefield_init();
-    minefield_free(p);
-}
-
-/*
- * realloc _always_ moves the chunk, for rapid detection of code
- * that assumes it won't.
- */
-static void *minefield_c_realloc(void *p, size_t size)
-{
-    size_t oldsize;
-    void *q;
-    if (!minefield_initialised)
-       minefield_init();
-    q = minefield_alloc(size);
-    oldsize = minefield_get_size(p);
-    memcpy(q, p, (oldsize < size ? oldsize : size));
-    minefield_free(p);
-    return q;
-}
-
-#endif                         /* MINEFIELD */
+void *minefield_c_malloc(size_t size);
+void minefield_c_free(void *p);
+void *minefield_c_realloc(void *p, size_t size);
+#endif
 
 #ifdef MALLOC_LOG
 static FILE *fp = NULL;
@@ -413,9 +373,7 @@ void *safemalloc(size_t size)
 #else
        strcpy(str, "Out of memory!");
 #endif
-       MessageBox(NULL, str, "PuTTY Fatal Error",
-                  MB_SYSTEMMODAL | MB_ICONERROR | MB_OK);
-       cleanup_exit(1);
+       modalfatalbox(str);
     }
 #ifdef MALLOC_LOG
     if (fp)
@@ -450,9 +408,7 @@ void *saferealloc(void *ptr, size_t size)
 #else
        strcpy(str, "Out of memory!");
 #endif
-       MessageBox(NULL, str, "PuTTY Fatal Error",
-                  MB_SYSTEMMODAL | MB_ICONERROR | MB_OK);
-       cleanup_exit(1);
+       modalfatalbox(str);
     }
 #ifdef MALLOC_LOG
     if (fp)
@@ -485,36 +441,17 @@ void safefree(void *ptr)
  */
 
 #ifdef DEBUG
-static FILE *debug_fp = NULL;
-static int debug_got_console = 0;
-
-static void dputs(char *buf)
-{
-    DWORD dw;
-
-    if (!debug_got_console) {
-       AllocConsole();
-       debug_got_console = 1;
-    }
-    if (!debug_fp) {
-       debug_fp = fopen("debug.log", "w");
-    }
-
-    WriteFile(GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw,
-             NULL);
-    fputs(buf, debug_fp);
-    fflush(debug_fp);
-}
-
+extern void dputs(char *);             /* defined in per-platform *misc.c */
 
-void dprintf(char *fmt, ...)
+void debug_printf(char *fmt, ...)
 {
-    char buf[2048];
+    char *buf;
     va_list ap;
 
     va_start(ap, fmt);
-    vsprintf(buf, fmt, ap);
+    buf = dupvprintf(fmt, ap);
     dputs(buf);
+    sfree(buf);
     va_end(ap);
 }
 
@@ -526,7 +463,7 @@ void debug_memdump(void *buf, int len, int L)
     char foo[17];
     if (L) {
        int delta;
-       dprintf("\t%d (0x%x) bytes:\n", len, len);
+       debug_printf("\t%d (0x%x) bytes:\n", len, len);
        delta = 15 & (int) p;
        p -= delta;
        len += delta;
@@ -534,14 +471,14 @@ void debug_memdump(void *buf, int len, int L)
     for (; 0 < len; p += 16, len -= 16) {
        dputs("  ");
        if (L)
-           dprintf("%p: ", p);
+           debug_printf("%p: ", p);
        strcpy(foo, "................");        /* sixteen dots */
        for (i = 0; i < 16 && i < len; ++i) {
            if (&p[i] < (unsigned char *) buf) {
                dputs("   ");          /* 3 spaces */
                foo[i] = ' ';
            } else {
-               dprintf("%c%02.2x",
+               debug_printf("%c%02.2x",
                        &p[i] != (unsigned char *) buf
                        && i % 4 ? '.' : ' ', p[i]
                    );
@@ -550,7 +487,7 @@ void debug_memdump(void *buf, int len, int L)
            }
        }
        foo[i] = '\0';
-       dprintf("%*s%s\n", (16 - i) * 3 + 2, "", foo);
+       debug_printf("%*s%s\n", (16 - i) * 3 + 2, "", foo);
     }
 }