/*
Legal:
Version: MPL 1.1
The contents of this file are subject to the Mozilla Public License Version
1.1 the "License"; you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.
The Original Code is the YSI framework.
The Initial Developer of the Original Code is Alex "Y_Less" Cole.
Portions created by the Initial Developer are Copyright C 2011
the Initial Developer. All Rights Reserved.
Contributors:
Y_Less
koolk
JoeBullet/Google63
g_aSlice/Slice
Misiur
samphunter
tianmeta
maddinat0r
spacemud
Crayder
Dayvison
Ahmad45123
Zeex
irinel1996
Yiin-
Chaprnks
Konstantinos
Masterchen09
Southclaws
PatchwerkQWER
m0k1
paulommu
udan111
Thanks:
JoeBullet/Google63 - Handy arbitrary ASM jump code using SCTRL.
ZeeX - Very productive conversations.
koolk - IsPlayerinAreaEx code.
TheAlpha - Danish translation.
breadfish - German translation.
Fireburn - Dutch translation.
yom - French translation.
50p - Polish translation.
Zamaroht - Spanish translation.
Los - Portuguese translation.
Dracoblue, sintax, mabako, Xtreme, other coders - Producing other modes for
me to strive to better.
Pixels^ - Running XScripters where the idea was born.
Matite - Pestering me to release it and using it.
Very special thanks to:
Thiadmer - PAWN, whose limits continue to amaze me!
Kye/Kalcor - SA:MP.
SA:MP Team past, present and future - SA:MP.
Optional plugins:
Gamer_Z - GPS.
Incognito - Streamer.
Me - sscanf2, fixes2, Whirlpool.
*/
/*-------------------------------------------------------------------------*//**
* Allocation unit to get the size of.
*
* The size.
*
*//*------------------------------------------------------------------------**/
P:D(Malloc_GetSlotSize(Alloc:slot));
#define Malloc_GetSlotSize(%1) \
(YSI_gMallocMemory[_:(%1) - 1])
/*-------------------------------------------------------------------------*//**
* Allocation unit to get the size of.
*
* The size.
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
stock Malloc_SlotSize(Alloc:slot)
{
return Malloc_GetSlotSize(slot);
}
#else
P:D(Malloc_SlotSize(Alloc:slot));
#define Malloc_SlotSize(%1) \
Malloc_GetSlotSize(%1)
#endif
/*-------------------------------------------------------------------------*//**
* The string to store.
* Whether or not the string will be packed.
*
* 0 on fail or a data handle on sucess.
*
*
* Allocates a new piece of memory with enough space to store the given string.
*
*//*------------------------------------------------------------------------**/
stock Alloc:Malloc_NewS(const string[], bool:pack = false) {
new
size = pack ? ((strlen(string) + 1) char) : (strlen(string) + 1),
Alloc:alloc = Malloc_Allocate(size, false);
if (alloc)
{
if (pack)
strpack(YSI_gMallocMemory[_:alloc], string, size);
else
strunpack(YSI_gMallocMemory[_:alloc], string, size);
}
return alloc;
}
/*-------------------------------------------------------------------------*//**
* The allocation unit to set the size of.
* The size to set it to.
*//*------------------------------------------------------------------------**/
P:D(Malloc_SetSlotSize(slot,size));
#define Malloc_SetSlotSize(%1,%2) \
YSI_gMallocMemory[_:(%1) - 1] = (%2)
/*-------------------------------------------------------------------------*//**
* The allocation unit to get data from.
* The location in the unit to get.
*
* The data
*
*
* Basically like but used internally.
*
*//*------------------------------------------------------------------------**/
P:D(Malloc_GetData(Alloc:slot,index));
#define Malloc_GetData(%1,%2) \
(YSI_gMallocMemory[_:((%1)+Alloc:(%2))])
/*-------------------------------------------------------------------------*//**
* The allocation unit to set in.
* Where in the unit to set.
* The value to save.
*//*------------------------------------------------------------------------**/
P:D(Malloc_SetData(Alloc:slot,index,value));
#define Malloc_SetData(%1,%2,%3) \
YSI_gMallocMemory[_:((%1)+Alloc:(%2))]=(%3)
/*-------------------------------------------------------------------------*//**
* The allocation unit to get data from.
* The location in the unit to get.
*
* The data
*
*
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(mget(Alloc:slot, index));
#if !defined YSI_MALLOC_NO_SHORT
#define mget(%1) \
Malloc_Get(%1)
#endif
/*-------------------------------------------------------------------------*//**
* The allocation unit to set in.
* Where in the unit to set.
* The value to save.
*
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(mset(Alloc:slot, index, value));
#if !defined YSI_MALLOC_NO_SHORT
#define mset(%1) \
Malloc_Set(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Target for the string.
* Length of the target.
* Data unit to put information in.
* Index in the unit.
* Return the string packed?
*
* The data
*
*
* Displays errors in secure mode. Gets a string.
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(mgets(target[], length, Alloc:array, const index, const bool:pack = false));
#if !defined YSI_MALLOC_NO_SHORT
#define mgets(%1) \
Malloc_GetS(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Target for the string.
* Length of the target.
* Data unit to put information in.
* Index in the unit.
*
* The data
*
*
* Displays errors in secure mode. Gets an array.
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(mgeta(target[], length, Alloc:array, index));
#if !defined YSI_MALLOC_NO_SHORT
#define mgeta(%1) \
Malloc_GetA(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* String to insert
* Should the string be packed in?
*
* Displays errors in secure mode. Inserts a string.
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(msets(Alloc:array, const index, const str[], const bool:pack = false));
#if !defined YSI_MALLOC_NO_SHORT
#define msets(%1) \
Malloc_SetS(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* Array to insert.
* Length of the array.
*
* Displays errors in secure mode. Inserts an array.
* Shorthand for .
*
*//*------------------------------------------------------------------------**/
P:D(mseta(Alloc:array, index, const str[], len));
#if !defined YSI_MALLOC_NO_SHORT
#define mseta(%1) \
Malloc_SetA(%1)
#endif
/*-------------------------------------------------------------------------*//**
* The unit to get the one after of.
*
* Gets the next free block of memory after the current one.
*
*//*------------------------------------------------------------------------**/
P:D(Malloc_NextSlot(slot));
#define Malloc_NextSlot(%1) \
(YSI_gMallocMemory[(%1)])
/*-------------------------------------------------------------------------*//**
* Data unit to get information from.
* Index in the unit.
*
* Data.
*
*
* Displays errors in secure mode.
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
stock Malloc_Get(Alloc:array, index)
{
if (index >= 0 && index < Malloc_GetSlotSize(_:array))
{
return Malloc_GetData(_:array, index);
}
P:C(else P:E("Array read index out of bounds: %d[%d]", _:array, index););
return 0;
}
#else
P:D(Malloc_Get(Alloc:array, index));
#define Malloc_Get(%1,%2) \
Malloc_GetData(%1, %2)
#endif
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* Value to insert
*
* Displays errors in secure mode.
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
stock Malloc_Set(Alloc:array, index, value)
{
if (index >= 0 && index < Malloc_GetSlotSize(_:array))
{
return Malloc_SetData(_:array, index, value);
}
P:C(else P:E("Array write index out of bounds: %d[%d]", _:array, index););
return 0;
}
#else
P:D(Malloc_Set(Alloc:array,index,value));
#define Malloc_Set(%1,%2,%3) \
Malloc_SetData(%1, %2, %3)
#endif
/*-------------------------------------------------------------------------*//**
* Target for the string.
* Length of the target.
* Data unit to put information in.
* Index in the unit.
* Return the string packed?
*
* Displays errors in secure mode. Gets a string.
*
*//*------------------------------------------------------------------------**/
stock Malloc_GetS(target[], length, Alloc:array, const index, const bool:pack = false)
{
P:3("Malloc_GetS: array = %d, index = %d.", _:array, index);
if (0 <= index < Malloc_GetSlotSize(_:array))
{
if (pack)
{
strpack(target, Malloc_GetData(array, index), length);
}
else
{
strunpack(target, Malloc_GetData(array, index), length);
}
}
return 0;
}
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* String to insert
* Should the string be packed in?
*
* Displays errors in secure mode. Inserts a string.
*
*//*------------------------------------------------------------------------**/
stock Malloc_SetS(Alloc:array, const index, const str[], const bool:pack = false)
{
P:3("Malloc_SetS called: %d, %d, %s", _:array, index, str);
new
len = strlen(str) + 1;
if (0 <= index && index + len <= Malloc_GetSlotSize(_:array))
{
P:5("Malloc_SetS: In check.");
if (pack)
{
strpack(Malloc_GetData(array, index), str, cellmax);
return (len char);
}
else
{
strunpack(Malloc_GetData(array, index), str, cellmax);
return (len);
}
}
else
{
#if defined YSI_MALLOC_SECURE
P:E("String copy failed (%s)", str);
#endif
return 0;
}
}
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* Offset in the stack of the string to store.
*
* Inserts a string by stack offset for use in vararg functions.
*
*//*------------------------------------------------------------------------**/
stock Malloc_SetVAS(Alloc:array, index, arg)
{
P:3("Malloc_SetVAS called: %d, %d, %d", _:array, index, arg);
new
len;
#emit LOAD.S.pri arg
#emit SMUL.C 4
#emit LOAD.S.alt 0
#emit ADD
#emit ADD.C 12
#emit LOAD.I
// For later reuse.
#emit STOR.S.pri arg
#emit PUSH.pri
#emit PUSH.C 4
#emit SYSREQ.C strlen
#emit STACK 8
#emit STOR.S.pri len
if (index >= 0 && index + (++len) <= Malloc_GetSlotSize(_:array))
{
P:5("Malloc_SetVAS: In check.");
index += _:array;
YSI_gMallocMemory[index] = 0;
// Blank and copy the string.
//#emit LOAD.S.pri arg
//#emit SMUL.C 4
//#emit LOAD.S.alt 0
//#emit ADD
//#emit ADD.C 12
//#emit LOAD.I
// Skip the code above the second time now (store the true source
// address in "arg" the first time).
#emit PUSH.S len
#emit PUSH.S arg
#emit CONST.alt YSI_gMallocMemory
#emit LOAD.S.pri index
#emit IDXADDR
#emit MOVE.alt
#emit CONST.pri 0
#emit STOR.I
#emit PUSH.alt
#emit PUSH.C 12
#emit SYSREQ.C strcat
#emit STACK 16
//strcat(YSI_gMallocMemory[index], str, cellmax);
}
#if defined YSI_MALLOC_SECURE
P:C(else P:E("String copy failed (%s)", str););
#endif
}
/*-------------------------------------------------------------------------*//**
* Target for the array.
* Length of the target.
* Data unit to put information in.
* Index in the unit.
*
* Displays errors in secure mode. Gets an array.
*
*//*------------------------------------------------------------------------**/
stock Malloc_GetA(target[], length, Alloc:array, index)
{
P:3("Malloc_GetA called: array = %d, index = %d.", _:array, index);
if (index >= 0)
{
new
size = Malloc_GetSlotSize(_:array);
P:5("Malloc_GetA: size = %d.", size);
memcpy(target, YSI_gMallocMemory, index + _:array, size * 4, length);
#if defined YSI_MALLOC_SECURE
P:C(if(length > size)P:E("Out of buffer space."););
#endif
return 1;
}
return 0;
}
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* Array to insert.
* Length of the array.
*
* Displays errors in secure mode. Inserts an array.
*
*//*------------------------------------------------------------------------**/
stock Malloc_SetA(Alloc:array, index, const str[], len)
{
P:3("Malloc_SetA: array = %d, index = %d.", _:array, index);
if (index >= 0)
{
new
size = Malloc_GetSlotSize(_:array);
P:5("Malloc_SetA: size = %d.", size);
memcpy(YSI_gMallocMemory[index + _:array], str, 0, len * 4, size - index);
#if defined YSI_MALLOC_SECURE
P:C(if(len > size - index)P:E("Out of buffer space."););
#endif
}
}
/*-------------------------------------------------------------------------*//**
* Data unit to put information in.
* Index in the unit.
* Offset in the stack of the array to store.
*
* Inserts an array by stack offset for use in vararg functions.
*
*//*------------------------------------------------------------------------**/
stock Malloc_SetVAA(Alloc:array, index, arg)
{
P:3("Malloc_SetVAA called: %d, %d, %d", _:array, index, arg);
new
len;
#emit LOAD.S.pri arg
#emit ADD.C 1
#emit SMUL.C 4
#emit LOAD.S.alt 0
#emit ADD
#emit ADD.C 12
#emit LOAD.I
#emit LOAD.I
// For later reuse.
#emit STOR.S.pri len
if (index >= 0 && index + len <= Malloc_GetSlotSize(_:array))
{
P:5("Malloc_SetVAA In check.");
index += _:array;
// Skip the code above the second time now (store the true source
// address in "arg" the first time).
#emit LOAD.S.pri len
#emit PUSH.pri
#emit SMUL.C 4
#emit PUSH.pri
#emit PUSH.C 0
// Source.
#emit LOAD.S.pri arg
#emit SMUL.C 4
#emit LOAD.S.alt 0
#emit ADD
#emit ADD.C 12
#emit LOAD.I
#emit PUSH.pri
// Destination.
#emit CONST.alt YSI_gMallocMemory
#emit LOAD.S.pri index
#emit IDXADDR
#emit MOVE.alt
#emit CONST.pri 0
#emit STOR.I
#emit PUSH.alt
// GO!
#emit PUSH.C 20
#emit SYSREQ.C memcpy
#emit STACK 24
}
#if defined YSI_MALLOC_SECURE
P:C(else P:E("Array copy out of memory."););
#endif
}
/*-------------------------------------------------------------------------*//**
* Size of memory to allocate.
*
* 0 on fail or a data handle on sucess.
*
*
* Displays errors in secure mode.
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
stock Alloc:malloc(size)
{
new
Alloc:slot = Malloc_Allocate(size);
P:C(if(!slot)P:E("Allocation failed (%d)", size););
return slot;
}
#else
P:D(Alloc:malloc(size));
#define malloc(%1) \
Malloc_Allocate(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Size of memory to allocate.
*
* 0 on fail or a data handle on sucess.
*
*
* Displays errors in secure mode. Blanks allocated mmeory.
*
*//*------------------------------------------------------------------------**/
stock Alloc:calloc(size)
{
new
Alloc:slot = Malloc_Allocate(size);
if (slot)
{
new
temp = _:slot;
while (size--)
{
YSI_gMallocMemory[temp++] = 0;
}
}
#if defined YSI_MALLOC_SECURE
P:C(if(!slot)P:E("Allocation failed (%d)", size););
#endif
return slot;
}
/*-------------------------------------------------------------------------*//**
* Slot of memory to free up.
*
* Displays errors in secure mode.
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
stock free(Alloc:slot)
{
if (!slot || !Malloc_GetSlotSize(_:slot))
{
P:1("Free failed (%d)", _:slot);
return 0;
}
return Malloc_Free(slot);
}
#else
P:D(free(Alloc:slot));
#define free(%1) \
Malloc_Free(%1)
#endif
/*-------------------------------------------------------------------------*//**
* Ammount of memory to allocate IN CELLS.
* Blank the memory?
*
* Memory identifier.
*
*
* The size check should never fail, if there's only 1 cell
* extra somewhere just sneak it onto the end of an array,
* if the user does proper bounds checking it shouldn't
* matter.
*
* Implementation code for .
*
* This code will find an area in memory with sufficient
* space to store the given data and
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
static
#endif
stock Alloc:Malloc_Allocate(size, const bool:clear = true)
{
P:2("Malloc_Allocate called: %d, %d, %d, %d", size, YSI_g_sUnusedStart, YSI_g_sHeapStart, Malloc_GetSlotSize(YSI_g_sUnusedStart));
//P:0("Malloc_Allocate called: %d, %d, %d, %d", size, YSI_g_sUnusedStart, YSI_g_sHeapStart, Malloc_GetSlotSize(YSI_g_sUnusedStart));
new
slot = YSI_g_sUnusedStart,
p = YSI_g_sHeapStart, // Was "0", now an offset to the heap.
cs,
nextSlot = 0;
#if _DEBUG > 3
#emit LCTRL 2
#emit STOR.S.alt cs
printf("Malloc_Allocate: heap = %d", cs);
#endif
while (slot)
{
cs = Malloc_GetSlotSize(slot);
if (!cs)
{
return NO_ALLOC;
}
if (cs >= size)
{
break;
}
p = slot;
slot = Malloc_NextSlot(slot);
}
if (slot)
{
nextSlot = Malloc_NextSlot(slot);
if (cs == size + 1)
{
size++;
}
if (clear)
{
memset(Malloc_GetData(Alloc:slot, 0), 0, size);
}
if (cs == size)
{
if (p == YSI_g_sHeapStart)
{
YSI_g_sUnusedStart = nextSlot;
}
else
{
Malloc_SetData(Alloc:p, 0, nextSlot);
}
}
else
{
Malloc_SetSlotSize(slot, size);
size++;
cs -= size;
size += slot;
if (p == YSI_g_sHeapStart)
{
YSI_g_sUnusedStart = size;
}
else
{
Malloc_SetData(Alloc:p, 0, size);
}
Malloc_SetData(Alloc:size, 0, nextSlot);
Malloc_SetSlotSize(size, cs);
}
return Alloc:slot;
}
return NO_ALLOC;
}
/*-------------------------------------------------------------------------*//**
* Memory allocation unit to release
*
* Implementation code for .
*
*//*------------------------------------------------------------------------**/
#if defined YSI_MALLOC_SECURE
static
#endif
stock Malloc_Free(Alloc:slot)
{
if (slot == NO_ALLOC) return 0;
P:4("Malloc_Free called: %d", _:slot);
new
size = Malloc_GetSlotSize(_:slot),
p = YSI_g_sUnusedStart,
l = YSI_g_sHeapStart; // Was "0", now an offset to the heap.
P:5("Malloc_Free: size = %d", size);
if (p)
{
while (p && p < _:slot)
{
l = p;
p = Malloc_NextSlot(p);
}
if (p)
{
if (l == YSI_g_sHeapStart)
{
YSI_g_sUnusedStart = _:slot;
}
else
{
new
tmp = Malloc_GetSlotSize(l);
if (l + tmp + 1 == _:slot)
{
size += tmp + 1;
Malloc_SetSlotSize(l, size);
slot = Alloc:l;
}
else
{
Malloc_SetData(slot, 0, p);
Malloc_SetData(Alloc:l, 0, _:slot);
}
}
if (_:slot + size + 1 == p)
{
Malloc_SetSlotSize(_:slot, Malloc_GetSlotSize(p) + size + 1);
Malloc_SetData(slot, 0, Malloc_NextSlot(p));
}
else
{
Malloc_SetData(slot, 0, p);
}
}
else
{
p = Malloc_GetSlotSize(l) + 1;
if (l + p == _:slot)
{
Malloc_SetSlotSize(l, size + p);
}
else
{
Malloc_SetData(slot, 0, 0);
Malloc_SetData(Alloc:l, 0, _:slot);
}
}
}
else
{
YSI_g_sUnusedStart = _:slot;
Malloc_SetData(slot, 0, 0);
}
return 1;
}
/*-------------------------------------------------------------------------*//**
* Memory allocation unit to find
*
* Transforms a memory slot in to a memory address.
*
*//*------------------------------------------------------------------------**/
stock ResolvedAlloc:Malloc_Resolve(Alloc:slot)
{
#emit CONST.alt YSI_gMallocMemory
#emit LOAD.S.pri slot
#emit IDXADDR
#emit RETN
return ResolvedAlloc:0;
}
/*-------------------------------------------------------------------------*//**
* Memory address to find
*
* Transforms a memory address in to a memory slot.
*
*//*------------------------------------------------------------------------**/
stock Alloc:Malloc_Reconcile(ResolvedAlloc:addr)
{
#emit CONST.alt YSI_gMallocMemory
#emit LOAD.S.pri addr
#emit SUB
#emit SHR.C.pri 2
#emit RETN
return Alloc:0;
}