os-k/kaleid/include/extras/malloc.h

//----------------------------------------------------------------------------//
//                           GNU GPL OS/K                                     //
//                                                                            //
//  Desc:       Memory allocation functions                                   //
//                                                                            //
//                                                                            //
//  Copyright © 2018-2019 The OS/K Team                                       //
//                                                                            //
//  This file is part of OS/K.                                                //
//                                                                            //
//  OS/K 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 3 of the License, or         //
//  any later version.                                                        //
//                                                                            //
//  OS/K 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 OS/K.  If not, see <https://www.gnu.org/licenses/>.            //
//----------------------------------------------------------------------------//

#ifndef _KALBASE_H
#include <kalbase.h>
#endif

#ifndef _KALEXTRAS_MALLOC_H
#define _KALEXTRAS_MALLOC_H

#ifdef __cplusplus
extern "C" {
#endif

//------------------------------------------//

// Flags for KalAllocMemory
enum
{
    // Return zeroed-out memory
    M_ZEROED = 1,

    // Crash if allocation fails (ENABLED by default in the kernel)
    M_FAILCRASH = 2,

    // Do NOT crash if allocation failed (meaningless outside of the kernel)
    M_CANFAIL = 4,
};

enum
{
    // Default memory allocation alignment (in bytes)
    // Asking KalAllocMemory for an alignment of 0
    // will cause it to use this value
    M_DEFAULT_ALIGNMENT = alignof(QWORD),

    // Minimal memory allocation alignment (in bytes)
    // Asking KalAllocMemory for an nonzero alignment
    // lower than this value will cause a EALIGN error
    M_MINIMAL_ALIGNMENT = M_DEFAULT_ALIGNMENT
};

error_t KalAllocMemory(void **ptr, size_t req, int flags, size_t align);
error_t KalFreeMemory(void *ptr);

//------------------------------------------//

#ifdef __cplusplus
}
#endif

#endif