mem_alloc

Go to the documentation of this file.

// -*- Mode: C++ -*-
// vim:ft=cpp
/*
 * Copyright (C) 2014-2016, 2019, 2021, 2024-2025 Kernkonzept GmbH.
 * Author(s): Alexander Warg <alexander.warg@kernkonzept.com>
 */
/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>,
 *               Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#pragma once
 
#include <l4/re/protocols.h>
#include <l4/sys/capability>
#include <l4/sys/cxx/ipc_iface>
#include <l4/sys/factory>
 
namespace L4Re {
class Dataspace;
 
// MISSING:
// * alignment constraints
// * shall we support superpages in noncont memory?

class L4_EXPORT Mem_alloc :
  public L4::Kobject_t<Mem_alloc, L4::Factory, L4RE_PROTO_MEM_ALLOC>
{
public:
  enum Mem_alloc_flags : unsigned long
  {
    Continuous   = 0x01,  
    Pinned       = 0x02,  
    Super_pages  = 0x04,  
    Fixed_paddr  = 0x08,  
 
    Dma_mask_bits   = 0x3f0, 
    Invert_dma_mask = 0x400, 
  };

  static L4_INLINE L4_CONSTEXPR unsigned Dma_mask(unsigned bits)
  {
    if (L4_UNLIKELY(bits > 64))
      return 0;
 
    if (L4_UNLIKELY(bits == 0))
      bits = 1; // prevent overflow below
 
    // Implemented as (64 - bits) << 4 for backwards compatibility.
    return (64 - bits) << 4;
  }

  struct Stats
  {
    l4_size_t quota;

    l4_size_t quota_used;

    l4_size_t mem_limit;

    l4_size_t mem_used;

    l4_size_t mem_free;
  };

  l4_ret_t alloc(long size, L4::Cap<Dataspace> mem, unsigned long flags = 0,
                 unsigned long align = 0, l4_addr_t paddr = 0,
                 char const *type = nullptr) const noexcept;

  L4_INLINE_RPC(long, info, (Stats &stats));
 
  typedef L4::Typeid::Rpcs<info_t> Rpcs;
};
 
};