IvanR

IvanR

How to read the BEAM bytecode compiled into memory and that is not on the disk?

Hi,
I’m the author of the Domo library that validates struct’s data against its @type spec and would like to upgrade it to support in-memory modules.

In the library, I read struct’s types by Code.Typespec.fetch_types(module_atom) that works for the module that has the compiled BEAM file on the disk. At the same time, for an in-memory module that you can make in iex, it returns :error like the following:

iex(1)> defmodule Ms do
...(1)>   defstruct [:id]
...(1)>   @type t :: %__MODULE__{id: atom}
...(1)> end
{:module, Ms, ...}

iex(2)> Code.Typespec.fetch_types(Ms)
:error

The Code.Typespec.fetch_types/1 delegates to Erlang’s :code.get_object_code/1 that, from my understanding searches bytecode on the disk. That fails for modules that exist only in memory.

How can I get the bytecode for the module that is in memory only by its name in iex/Livebook?

Marked As Solved

garazdawi

garazdawi

Erlang Core Team

It is not possible to do because during loading the original module is destroyed and it is not possible to reverse-load the module from what is loaded. So to implement such functionality we would be to keep the original module which would double the memory usage of the code for each loaded module.

Also Liked

IvanR

IvanR

Types can be read from the module’s bytecode like the following at compile-time:

defmodule MyModule do
  @type one_type :: atom()
  @opaque another_type :: integer()

  @after_compile {MyModule, :_collect_types}

  def _collect_types(_env, bytecode) do
    {:ok, types} = Code.Typespec.fetch_types(bytecode)

    Enum.map(types, fn {kind, type} ->
      type_ast = Code.Typespec.type_to_quoted(type)

      type_ast
      |> Macro.to_string()
      |> IO.inspect(label: kind)
    end)
  end
end

it prints:

opaque: "another_type() :: integer()"
type: "one_type() :: atom()"
hauleth

hauleth

You cannot. I have asked for such thing on the Erlang Issue Tracker and IRC and there is no way to achieve what you want. The only solution is to manually store 3rd element of the tuple returned by defmodule and use that as a BEAM data.

IvanR

IvanR

Good to know. It seems OTP has no public interface to get in-memory modules yet.

IvanR

IvanR

So I’ve solved my problem by simply collecting types from the bytecode with @after_compile {module, fun} hook because the library should be used explicitly in the modules anyway.

The other way to get bytecodes is a {:on_module, bytecode, :none} compilation tracer introduced in Elixir v1.13.0. The tracer can be added to the elixir compiler configuration dynamically from a custom mix compile task that should go first in compilers list in project’s mix.exs file.

feifan

feifan

Hi @IvanR! Thanks for asking this — I’m also wondering about the same. Do you have any code examples you could share with details on how specifically you can get the types with an @after_compile hook? I understand the general idea but I’m not clear how to specifically do it in code.

Where Next?

Popular in Questions Top

dotdotdotPaul
Okay, I'm having a heck of a time trying to figure out how to best handle the validation of belongs_to associations in Ecto. I'm sure I'...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
lk-geimfari
What is most correct way to open, read and parse JSON file with poison? For example if we have example.json file in root of some projec...
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
vac
Hi, I'm quite new in Elixir and I'm trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and ...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New

Other popular topics Top

JDanielMartinez
Hi! May someone helps me, please! I have two apps into an umbrella project: the first one is Database, which manages queries, and the se...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 45766 226
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
_russellb
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
New
lk-geimfari
What is most correct way to open, read and parse JSON file with poison? For example if we have example.json file in root of some projec...
New
mgjohns61585
Could someone help me? I'm making my first elixir program, number guessing game. I can't figure out how to convert the user's guess from ...
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
chrisalley
ExUnit now has describe blocks which is a welcome addition coming from RSpec. In the docs, it states that nested hierarchies of describe ...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
AstonJ
by Lance Halvorsen Elixir and Phoenix are generating tremendous excitement as an unbeatable platform for building modern web application...
460 27162 124
New

We're in Beta

About us Mission Statement