Giter Club home page Giter Club logo

incbin's Introduction

incbin

Goal: embed an external file inside a binary.

Method 1: Use Python script to dump file bytes as a C-string into .cpp file
Method 2: Use .incbin technique shown here

Caveat:

  • The external file should be embedded in lib.so
  • main should be able to access the external file from lib.so through a global variable

Results

Method 1 (GENERATE_RESOURCES) always works.

Method 2 works depending on:

  • The compiler/linker (I tested g++-10 and clang++-10)

  • Whether the global variable has __attribute__((weak)) (ATTRIBUTE_WEAK)

    • This seems to fix the issue for g++-10, but not for clang++-10
  • Whether the global variable is const (CONST)

    • If const is used, there will be a big unintialized "placeholder" for the external file in main, inflating the executable size
  • Whether the global variable is used in lib.cpp (LIB_PASSTHROUGH)

The ./build_all.py script tries all possibilities. My output on Ubuntu 20.04 is in output.log:

...
Successful cmds:
./build.py g++-10 GENERATE_RESOURCES
./build.py g++-10 ATTRIBUTE_WEAK
./build.py g++-10 GENERATE_RESOURCES LIB_PASSTHROUGH
./build.py g++-10 GENERATE_RESOURCES ATTRIBUTE_WEAK
./build.py g++-10 LIB_PASSTHROUGH ATTRIBUTE_WEAK
./build.py g++-10 ATTRIBUTE_WEAK CONST
./build.py g++-10 GENERATE_RESOURCES LIB_PASSTHROUGH ATTRIBUTE_WEAK
./build.py g++-10 GENERATE_RESOURCES ATTRIBUTE_WEAK CONST
./build.py g++-10 LIB_PASSTHROUGH ATTRIBUTE_WEAK CONST
./build.py g++-10 GENERATE_RESOURCES LIB_PASSTHROUGH ATTRIBUTE_WEAK CONST
./build.py clang++-10 GENERATE_RESOURCES
./build.py clang++-10 GENERATE_RESOURCES LIB_PASSTHROUGH
./build.py clang++-10 GENERATE_RESOURCES ATTRIBUTE_WEAK
./build.py clang++-10 GENERATE_RESOURCES LIB_PASSTHROUGH ATTRIBUTE_WEAK

incbin's People

Contributors

qxxxb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.