memory.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_LIB_MEMORY_H__
#define __MOTR_LIB_MEMORY_H__

#include "lib/types.h"
#include "lib/assert.h"  /* M0_CASSERT */
#include "lib/finject.h" /* M0_FI_ENABLED */

void *m0_alloc(size_t size);

M0_INTERNAL void *m0_alloc_nz(size_t size);

void m0_free(void *data);

M0_INTERNAL void m0_memory_pagein(void *addr, size_t size);

#define m0_free0(pptr)                        \
        do {                                  \
                typeof(pptr) __pptr = (pptr); \
                m0_free(*__pptr);             \
                *__pptr = NULL;               \
        } while (0)

#define M0_ALLOC_ARR(arr, nr)  ((arr) = M0_FI_ENABLED(#arr "-fail") ? NULL : \
                                        m0_alloc((nr) * sizeof ((arr)[0])))
#define M0_ALLOC_PTR(ptr)      M0_ALLOC_ARR(ptr, 1)

#define M0_ALLOC_ARR_ALIGNED(arr, nr, shift)            \
        ((arr) = m0_alloc_aligned((nr) * sizeof ((arr)[0]), (shift)))

M0_INTERNAL void *m0_alloc_aligned(size_t size, unsigned shift);

M0_INTERNAL void m0_free_aligned(void *data, size_t size, unsigned shift);

static inline bool m0_addr_is_aligned(const void *addr, unsigned shift)
{
        M0_CASSERT(sizeof(unsigned long) >= sizeof(void *));
        return ((((unsigned long)addr >> shift) << shift) ==
                  (unsigned long)addr);
}

M0_INTERNAL void *m0_alloc_wired(size_t size, unsigned shift);

M0_INTERNAL void m0_free_wired(void *data, size_t size, unsigned shift);

M0_INTERNAL size_t m0_allocated(void);

M0_INTERNAL size_t m0_allocated_total(void);

M0_INTERNAL size_t m0_freed_total(void);

M0_INTERNAL int m0_pagesize_get(void);

M0_INTERNAL int m0_pageshift_get(void);

M0_INTERNAL bool m0_is_poisoned(const void *p);

M0_INTERNAL int m0_dont_dump(void *p, size_t size);


#endif /* __MOTR_LIB_MEMORY_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */