Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document missing build steps #409

Closed
4 tasks done
randomPoison opened this issue Oct 3, 2024 · 5 comments · Fixed by #481
Closed
4 tasks done

Document missing build steps #409

randomPoison opened this issue Oct 3, 2024 · 5 comments · Fixed by #481
Labels
documentation Improvements or additions to documentation

Comments

@randomPoison
Copy link
Contributor

randomPoison commented Oct 3, 2024

In integrating IA2 into zlib I uncovered a number of build steps that aren't currently covered in the docs. We'll need to update the docs to include the following:

  • How to run the rewriter, i.e. source changes, compiler args, and rewriter args.
  • partition-alloc needs to be included in the final containerized build, and the --wrap=malloc linker args need to be added.
  • Either LIBIA2_X86_64 or LIBIA2_ARM64 defines need to be set for the containerized build.
  • Run pad-tls on any shared objects that use TLS. We probably also want to document how to determine if a .so uses TLS.
@randomPoison randomPoison added the documentation Improvements or additions to documentation label Oct 3, 2024
@kkysen
Copy link
Contributor

kkysen commented Oct 4, 2024

Either LIBIA2_X86_64 or LIBIA2_ARM64 defines need to be set for the containerized build.

This is fixed as of #400.

@ayrtonm
Copy link
Contributor

ayrtonm commented Oct 7, 2024

We probably also want to document how to determine if a .so uses TLS.

We were thinking about adding runtime checks for this in #404, so we can also point users to the right readelf flags in that error message.

@ayrtonm
Copy link
Contributor

ayrtonm commented Oct 7, 2024

partition-alloc needs to be included in the final containerized build, and the --wrap=malloc linker args need to be added.

It might be a good idea to runtime checks for this as well.

@ayrtonm
Copy link
Contributor

ayrtonm commented Oct 22, 2024

The names of -DIA2_DEBUG and -DIA2_DEBUG_LOG are also too similar. After addressing #452 the former will probably be -DIA2_RELEASE with inverted semantics and we should consider renaming the former to something like -DIA2_VERBOSE or -DIA2_LOG since that seems more descriptive than "debug".

@kkysen
Copy link
Contributor

kkysen commented Oct 22, 2024

The names of -DIA2_DEBUG and -DIA2_DEBUG_LOG are also too similar. After addressing #452 the former will probably be -DIA2_RELEASE with inverted semantics and we should consider renaming the former to something like -DIA2_VERBOSE or -DIA2_LOG since that seems more descriptive than "debug".

-DIA2_VERBOSE sounds good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants