[openssh.git] / monitor_mm.c

/*
 * Copyright 2002 Niels Provos <provos@citi.umich.edu>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "includes.h"
RCSID("$OpenBSD: monitor_mm.c,v 1.7 2002/06/28 01:49:31 millert Exp $");

#ifdef HAVE_SYS_MMAN_H
#include <sys/mman.h>
#endif

#include "openbsd-compat/xmmap.h"
#include "ssh.h"
#include "xmalloc.h"
#include "log.h"
#include "monitor_mm.h"

static int
mm_compare(struct mm_share *a, struct mm_share *b)
{
	long diff = (char *)a->address - (char *)b->address;

	if (diff == 0)
		return (0);
	else if (diff < 0)
		return (-1);
	else
		return (1);
}

RB_GENERATE(mmtree, mm_share, next, mm_compare)

static struct mm_share *
mm_make_entry(struct mm_master *mm, struct mmtree *head,
    void *address, size_t size)
{
	struct mm_share *tmp, *tmp2;

	if (mm->mmalloc == NULL)
		tmp = xmalloc(sizeof(struct mm_share));
	else
		tmp = mm_xmalloc(mm->mmalloc, sizeof(struct mm_share));
	tmp->address = address;
	tmp->size = size;

	tmp2 = RB_INSERT(mmtree, head, tmp);
	if (tmp2 != NULL)
		fatal("mm_make_entry(%p): double address %p->%p(%lu)",
		    mm, tmp2, address, (u_long)size);

	return (tmp);
}

/* Creates a shared memory area of a certain size */

struct mm_master *
mm_create(struct mm_master *mmalloc, size_t size)
{
	void *address;
	struct mm_master *mm;

	if (mmalloc == NULL)
		mm = xmalloc(sizeof(struct mm_master));
	else
		mm = mm_xmalloc(mmalloc, sizeof(struct mm_master));

	/*
	 * If the memory map has a mm_master it can be completely
	 * shared including authentication between the child
	 * and the client.
	 */
	mm->mmalloc = mmalloc;

	address = xmmap(size);
	if (address == MAP_FAILED)
		fatal("mmap(%lu): %s", (u_long)size, strerror(errno));

	mm->address = address;
	mm->size = size;

	RB_INIT(&mm->rb_free);
	RB_INIT(&mm->rb_allocated);

	mm_make_entry(mm, &mm->rb_free, address, size);

	return (mm);
}

/* Frees either the allocated or the free list */

static void
mm_freelist(struct mm_master *mmalloc, struct mmtree *head)
{
	struct mm_share *mms, *next;

	for (mms = RB_ROOT(head); mms; mms = next) {
		next = RB_NEXT(mmtree, head, mms);
		RB_REMOVE(mmtree, head, mms);
		if (mmalloc == NULL)
			xfree(mms);
		else
			mm_free(mmalloc, mms);
	}
}

/* Destroys a memory mapped area */

void
mm_destroy(struct mm_master *mm)
{
	mm_freelist(mm->mmalloc, &mm->rb_free);
	mm_freelist(mm->mmalloc, &mm->rb_allocated);

#ifdef HAVE_MMAP
	if (munmap(mm->address, mm->size) == -1)
		fatal("munmap(%p, %lu): %s", mm->address, (u_long)mm->size,
		    strerror(errno));
#else
	fatal("%s: UsePrivilegeSeparation=yes and Compression=yes not supported",
	    __func__);
#endif
	if (mm->mmalloc == NULL)
		xfree(mm);
	else
		mm_free(mm->mmalloc, mm);
}

void *
mm_xmalloc(struct mm_master *mm, size_t size)
{
	void *address;

	address = mm_malloc(mm, size);
	if (address == NULL)
		fatal("%s: mm_malloc(%lu)", __func__, (u_long)size);
	return (address);
}


/* Allocates data from a memory mapped area */

void *
mm_malloc(struct mm_master *mm, size_t size)
{
	struct mm_share *mms, *tmp;

	if (size == 0)
		fatal("mm_malloc: try to allocate 0 space");

	size = ((size + MM_MINSIZE - 1) / MM_MINSIZE) * MM_MINSIZE;

	RB_FOREACH(mms, mmtree, &mm->rb_free) {
		if (mms->size >= size)
			break;
	}

	if (mms == NULL)
		return (NULL);

	/* Debug */
	memset(mms->address, 0xd0, size);

	tmp = mm_make_entry(mm, &mm->rb_allocated, mms->address, size);

	/* Does not change order in RB tree */
	mms->size -= size;
	mms->address = (u_char *)mms->address + size;

	if (mms->size == 0) {
		RB_REMOVE(mmtree, &mm->rb_free, mms);
		if (mm->mmalloc == NULL)
			xfree(mms);
		else
			mm_free(mm->mmalloc, mms);
	}

	return (tmp->address);
}

/* Frees memory in a memory mapped area */

void
mm_free(struct mm_master *mm, void *address)
{
	struct mm_share *mms, *prev, tmp;

	tmp.address = address;
	mms = RB_FIND(mmtree, &mm->rb_allocated, &tmp);
	if (mms == NULL)
		fatal("mm_free(%p): can not find %p", mm, address);

	/* Debug */
	memset(mms->address, 0xd0, mms->size);

	/* Remove from allocated list and insert in free list */
	RB_REMOVE(mmtree, &mm->rb_allocated, mms);
	if (RB_INSERT(mmtree, &mm->rb_free, mms) != NULL)
		fatal("mm_free(%p): double address %p", mm, address);

	/* Find previous entry */
	prev = mms;
	if (RB_LEFT(prev, next)) {
		prev = RB_LEFT(prev, next);
		while (RB_RIGHT(prev, next))
			prev = RB_RIGHT(prev, next);
	} else {
		if (RB_PARENT(prev, next) &&
		    (prev == RB_RIGHT(RB_PARENT(prev, next), next)))
			prev = RB_PARENT(prev, next);
		else {
			while (RB_PARENT(prev, next) &&
			    (prev == RB_LEFT(RB_PARENT(prev, next), next)))
				prev = RB_PARENT(prev, next);
			prev = RB_PARENT(prev, next);
		}
	}

	/* Check if range does not overlap */
	if (prev != NULL && MM_ADDRESS_END(prev) > address)
		fatal("mm_free: memory corruption: %p(%lu) > %p",
		    prev->address, (u_long)prev->size, address);

	/* See if we can merge backwards */
	if (prev != NULL && MM_ADDRESS_END(prev) == address) {
		prev->size += mms->size;
		RB_REMOVE(mmtree, &mm->rb_free, mms);
		if (mm->mmalloc == NULL)
			xfree(mms);
		else
			mm_free(mm->mmalloc, mms);
	} else
		prev = mms;

	if (prev == NULL)
		return;

	/* Check if we can merge forwards */
	mms = RB_NEXT(mmtree, &mm->rb_free, prev);
	if (mms == NULL)
		return;

	if (MM_ADDRESS_END(prev) > mms->address)
		fatal("mm_free: memory corruption: %p < %p(%lu)",
		    mms->address, prev->address, (u_long)prev->size);
	if (MM_ADDRESS_END(prev) != mms->address)
		return;

	prev->size += mms->size;
	RB_REMOVE(mmtree, &mm->rb_free, mms);

	if (mm->mmalloc == NULL)
		xfree(mms);
	else
		mm_free(mm->mmalloc, mms);
}

static void
mm_sync_list(struct mmtree *oldtree, struct mmtree *newtree,
    struct mm_master *mm, struct mm_master *mmold)
{
	struct mm_master *mmalloc = mm->mmalloc;
	struct mm_share *mms, *new;

	/* Sync free list */
	RB_FOREACH(mms, mmtree, oldtree) {
		/* Check the values */
		mm_memvalid(mmold, mms, sizeof(struct mm_share));
		mm_memvalid(mm, mms->address, mms->size);

		new = mm_xmalloc(mmalloc, sizeof(struct mm_share));
		memcpy(new, mms, sizeof(struct mm_share));
		RB_INSERT(mmtree, newtree, new);
	}
}

void
mm_share_sync(struct mm_master **pmm, struct mm_master **pmmalloc)
{
	struct mm_master *mm;
	struct mm_master *mmalloc;
	struct mm_master *mmold;
	struct mmtree rb_free, rb_allocated;

	debug3("%s: Share sync", __func__);

	mm = *pmm;
	mmold = mm->mmalloc;
	mm_memvalid(mmold, mm, sizeof(*mm));

	mmalloc = mm_create(NULL, mm->size);
	mm = mm_xmalloc(mmalloc, sizeof(struct mm_master));
	memcpy(mm, *pmm, sizeof(struct mm_master));
	mm->mmalloc = mmalloc;

	rb_free = mm->rb_free;
	rb_allocated = mm->rb_allocated;

	RB_INIT(&mm->rb_free);
	RB_INIT(&mm->rb_allocated);

	mm_sync_list(&rb_free, &mm->rb_free, mm, mmold);
	mm_sync_list(&rb_allocated, &mm->rb_allocated, mm, mmold);

	mm_destroy(mmold);

	*pmm = mm;
	*pmmalloc = mmalloc;

	debug3("%s: Share sync end", __func__);
}

void
mm_memvalid(struct mm_master *mm, void *address, size_t size)
{
	void *end = (u_char *)address + size;

	if (address < mm->address)
		fatal("mm_memvalid: address too small: %p", address);
	if (end < address)
		fatal("mm_memvalid: end < address: %p < %p", end, address);
	if (end > (void *)((u_char *)mm->address + mm->size))
		fatal("mm_memvalid: address too large: %p", address);
}
Commit	Line	Data
1853d1ef	1	/*
	2	* Copyright 2002 Niels Provos <provos@citi.umich.edu>
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	*
	14	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	15	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	16	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	17	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	18	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	19	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	20	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	21	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	22	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	23	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	24	*/
	25
	26	#include "includes.h"
a64d3560	27	RCSID("$OpenBSD: monitor_mm.c,v 1.7 2002/06/28 01:49:31 millert Exp $");
1853d1ef	28
1e8f8c5b	29	#ifdef HAVE_SYS_MMAN_H
1853d1ef	30	#include <sys/mman.h>
1e8f8c5b	31	#endif
1853d1ef	32
30eab01d	33	#include "openbsd-compat/xmmap.h"
1853d1ef	34	#include "ssh.h"
	35	#include "xmalloc.h"
	36	#include "log.h"
	37	#include "monitor_mm.h"
	38
	39	static int
	40	mm_compare(struct mm_share a, struct mm_share b)
	41	{
a64d3560	42	long diff = (char )a->address - (char )b->address;
	43
	44	if (diff == 0)
	45	return (0);
	46	else if (diff < 0)
	47	return (-1);
	48	else
	49	return (1);
1853d1ef	50	}
	51
	52	RB_GENERATE(mmtree, mm_share, next, mm_compare)
	53
	54	static struct mm_share *
	55	mm_make_entry(struct mm_master mm, struct mmtree head,
	56	void *address, size_t size)
	57	{
	58	struct mm_share tmp, tmp2;
	59
	60	if (mm->mmalloc == NULL)
	61	tmp = xmalloc(sizeof(struct mm_share));
	62	else
	63	tmp = mm_xmalloc(mm->mmalloc, sizeof(struct mm_share));
	64	tmp->address = address;
	65	tmp->size = size;
	66
	67	tmp2 = RB_INSERT(mmtree, head, tmp);
	68	if (tmp2 != NULL)
3074b20c	69	fatal("mm_make_entry(%p): double address %p->%p(%lu)",
3074b20c	70	mm, tmp2, address, (u_long)size);
1853d1ef	71
	72	return (tmp);
	73	}
	74
	75	/* Creates a shared memory area of a certain size */
	76
	77	struct mm_master *
	78	mm_create(struct mm_master *mmalloc, size_t size)
	79	{
	80	void *address;
	81	struct mm_master *mm;
	82
	83	if (mmalloc == NULL)
	84	mm = xmalloc(sizeof(struct mm_master));
	85	else
	86	mm = mm_xmalloc(mmalloc, sizeof(struct mm_master));
	87
	88	/*
	89	* If the memory map has a mm_master it can be completely
	90	* shared including authentication between the child
	91	* and the client.
	92	*/
	93	mm->mmalloc = mmalloc;
	94
4165b82e	95	address = xmmap(size);
78beb77d	96	if (address == MAP_FAILED)
78beb77d	97	fatal("mmap(%lu): %s", (u_long)size, strerror(errno));
1853d1ef	98
	99	mm->address = address;
	100	mm->size = size;
	101
	102	RB_INIT(&mm->rb_free);
	103	RB_INIT(&mm->rb_allocated);
	104
	105	mm_make_entry(mm, &mm->rb_free, address, size);
	106
	107	return (mm);
	108	}
	109
	110	/* Frees either the allocated or the free list */
	111
	112	static void
	113	mm_freelist(struct mm_master mmalloc, struct mmtree head)
	114	{
	115	struct mm_share mms, next;
	116
	117	for (mms = RB_ROOT(head); mms; mms = next) {
	118	next = RB_NEXT(mmtree, head, mms);
	119	RB_REMOVE(mmtree, head, mms);
	120	if (mmalloc == NULL)
	121	xfree(mms);
	122	else
	123	mm_free(mmalloc, mms);
	124	}
	125	}
	126
	127	/* Destroys a memory mapped area */
	128
	129	void
	130	mm_destroy(struct mm_master *mm)
	131	{
	132	mm_freelist(mm->mmalloc, &mm->rb_free);
	133	mm_freelist(mm->mmalloc, &mm->rb_allocated);
	134
4165b82e	135	#ifdef HAVE_MMAP
1853d1ef	136	if (munmap(mm->address, mm->size) == -1)
441b3f63	137	fatal("munmap(%p, %lu): %s", mm->address, (u_long)mm->size,
c22d8cc0	138	strerror(errno));
1bf74eac	139	#else
88cb875c	140	fatal("%s: UsePrivilegeSeparation=yes and Compression=yes not supported",
1588c277	141	__func__);
1bf74eac	142	#endif
1853d1ef	143	if (mm->mmalloc == NULL)
	144	xfree(mm);
	145	else
	146	mm_free(mm->mmalloc, mm);
	147	}
	148
	149	void *
	150	mm_xmalloc(struct mm_master *mm, size_t size)
	151	{
	152	void *address;
	153
	154	address = mm_malloc(mm, size);
	155	if (address == NULL)
1588c277	156	fatal("%s: mm_malloc(%lu)", __func__, (u_long)size);
1853d1ef	157	return (address);
	158	}
	159
	160
	161	/* Allocates data from a memory mapped area */
	162
	163	void *
	164	mm_malloc(struct mm_master *mm, size_t size)
	165	{
	166	struct mm_share mms, tmp;
	167
	168	if (size == 0)
	169	fatal("mm_malloc: try to allocate 0 space");
	170
	171	size = ((size + MM_MINSIZE - 1) / MM_MINSIZE) * MM_MINSIZE;
	172
	173	RB_FOREACH(mms, mmtree, &mm->rb_free) {
	174	if (mms->size >= size)
	175	break;
	176	}
	177
	178	if (mms == NULL)
	179	return (NULL);
	180
	181	/* Debug */
	182	memset(mms->address, 0xd0, size);
	183
	184	tmp = mm_make_entry(mm, &mm->rb_allocated, mms->address, size);
	185
	186	/* Does not change order in RB tree */
	187	mms->size -= size;
	188	mms->address = (u_char *)mms->address + size;
	189
	190	if (mms->size == 0) {
	191	RB_REMOVE(mmtree, &mm->rb_free, mms);
	192	if (mm->mmalloc == NULL)
	193	xfree(mms);
	194	else
	195	mm_free(mm->mmalloc, mms);
	196	}
	197
	198	return (tmp->address);
	199	}
	200
	201	/* Frees memory in a memory mapped area */
	202
	203	void
	204	mm_free(struct mm_master mm, void address)
	205	{
	206	struct mm_share mms, prev, tmp;
	207
	208	tmp.address = address;
	209	mms = RB_FIND(mmtree, &mm->rb_allocated, &tmp);
	210	if (mms == NULL)
	211	fatal("mm_free(%p): can not find %p", mm, address);
	212
	213	/* Debug */
	214	memset(mms->address, 0xd0, mms->size);
	215
	216	/* Remove from allocated list and insert in free list */
	217	RB_REMOVE(mmtree, &mm->rb_allocated, mms);
	218	if (RB_INSERT(mmtree, &mm->rb_free, mms) != NULL)
	219	fatal("mm_free(%p): double address %p", mm, address);
	220
221	/* Find previous entry */
222	prev = mms;
223	if (RB_LEFT(prev, next)) {
224	prev = RB_LEFT(prev, next);
225	while (RB_RIGHT(prev, next))
226	prev = RB_RIGHT(prev, next);
227	} else {
228	if (RB_PARENT(prev, next) &&
229	(prev == RB_RIGHT(RB_PARENT(prev, next), next)))
230	prev = RB_PARENT(prev, next);
231	else {
232	while (RB_PARENT(prev, next) &&
233	(prev == RB_LEFT(RB_PARENT(prev, next), next)))
234	prev = RB_PARENT(prev, next);
235	prev = RB_PARENT(prev, next);
236	}
237	}
238
239	/* Check if range does not overlap */
240	if (prev != NULL && MM_ADDRESS_END(prev) > address)
3074b20c	241	fatal("mm_free: memory corruption: %p(%lu) > %p",
3074b20c	242	prev->address, (u_long)prev->size, address);
1853d1ef	243
	244	/* See if we can merge backwards */
	245	if (prev != NULL && MM_ADDRESS_END(prev) == address) {
	246	prev->size += mms->size;
	247	RB_REMOVE(mmtree, &mm->rb_free, mms);
	248	if (mm->mmalloc == NULL)
	249	xfree(mms);
	250	else
	251	mm_free(mm->mmalloc, mms);
	252	} else
	253	prev = mms;
	254
	255	if (prev == NULL)
	256	return;
	257
	258	/* Check if we can merge forwards */
	259	mms = RB_NEXT(mmtree, &mm->rb_free, prev);
	260	if (mms == NULL)
	261	return;
	262
	263	if (MM_ADDRESS_END(prev) > mms->address)
3074b20c	264	fatal("mm_free: memory corruption: %p < %p(%lu)",
3074b20c	265	mms->address, prev->address, (u_long)prev->size);
1853d1ef	266	if (MM_ADDRESS_END(prev) != mms->address)
	267	return;
	268
	269	prev->size += mms->size;
	270	RB_REMOVE(mmtree, &mm->rb_free, mms);
	271
	272	if (mm->mmalloc == NULL)
	273	xfree(mms);
	274	else
	275	mm_free(mm->mmalloc, mms);
	276	}
	277
	278	static void
	279	mm_sync_list(struct mmtree oldtree, struct mmtree newtree,
	280	struct mm_master mm, struct mm_master mmold)
	281	{
	282	struct mm_master *mmalloc = mm->mmalloc;
	283	struct mm_share mms, new;
	284
	285	/* Sync free list */
	286	RB_FOREACH(mms, mmtree, oldtree) {
	287	/* Check the values */
	288	mm_memvalid(mmold, mms, sizeof(struct mm_share));
	289	mm_memvalid(mm, mms->address, mms->size);
	290
	291	new = mm_xmalloc(mmalloc, sizeof(struct mm_share));
	292	memcpy(new, mms, sizeof(struct mm_share));
	293	RB_INSERT(mmtree, newtree, new);
	294	}
	295	}
	296
	297	void
	298	mm_share_sync(struct mm_master pmm, struct mm_master pmmalloc)
	299	{
	300	struct mm_master *mm;
	301	struct mm_master *mmalloc;
	302	struct mm_master *mmold;
	303	struct mmtree rb_free, rb_allocated;
	304
1588c277	305	debug3("%s: Share sync", __func__);
1853d1ef	306
	307	mm = *pmm;
	308	mmold = mm->mmalloc;
	309	mm_memvalid(mmold, mm, sizeof(*mm));
	310
	311	mmalloc = mm_create(NULL, mm->size);
	312	mm = mm_xmalloc(mmalloc, sizeof(struct mm_master));
	313	memcpy(mm, *pmm, sizeof(struct mm_master));
	314	mm->mmalloc = mmalloc;
	315
	316	rb_free = mm->rb_free;
	317	rb_allocated = mm->rb_allocated;
	318
	319	RB_INIT(&mm->rb_free);
	320	RB_INIT(&mm->rb_allocated);
	321
	322	mm_sync_list(&rb_free, &mm->rb_free, mm, mmold);
	323	mm_sync_list(&rb_allocated, &mm->rb_allocated, mm, mmold);
	324
	325	mm_destroy(mmold);
	326
	327	*pmm = mm;
	328	*pmmalloc = mmalloc;
	329
1588c277	330	debug3("%s: Share sync end", __func__);
1853d1ef	331	}
	332
	333	void
	334	mm_memvalid(struct mm_master mm, void address, size_t size)
	335	{
	336	void end = (u_char )address + size;
	337
	338	if (address < mm->address)
	339	fatal("mm_memvalid: address too small: %p", address);
	340	if (end < address)
	341	fatal("mm_memvalid: end < address: %p < %p", end, address);
	342	if (end > (void )((u_char )mm->address + mm->size))
	343	fatal("mm_memvalid: address too large: %p", address);
	344	}