Bartleby.h File Reference

Bartleby C API specification. More...

#include <sys/types.h>

Go to the source code of this file.

Macros
#define	SAQ_BARTLEBY_API

Functions
SAQ_BARTLEBY_API struct BartlebyHandle *	saq_bartleby_new (void)
	Allocates a new Bartleby handle.
SAQ_BARTLEBY_API void	saq_bartleby_free (struct BartlebyHandle *bh)
	Frees a Bartleby handle.
SAQ_BARTLEBY_API int	saq_bartleby_set_prefix (struct BartlebyHandle *bh, const char *prefix)
	Applies a prefix to all global and defined symbols.
SAQ_BARTLEBY_API int	saq_bartleby_add_binary (struct BartlebyHandle *bh, const void *s, const size_t n)
	Adds a new binary to Bartleby.
SAQ_BARTLEBY_API int	saq_bartleby_build_archive (struct BartlebyHandle *bh, void **s, size_t *n)
	Builds the final archive and writes its content to a buffer.

Detailed Description

Bartleby C API specification.

Author

thb-sb

Macro Definition Documentation

SAQ_BARTLEBY_API

#define SAQ_BARTLEBY_API

Copyright 2023 SandboxAQ

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.

Function Documentation

saq_bartleby_add_binary()

SAQ_BARTLEBY_API int saq_bartleby_add_binary	(	struct BartlebyHandle *	bh,
		const void *	s,
		const size_t	n
	)

Adds a new binary to Bartleby.

Parameters

bh	Bartleby handle.
s	Buffer containing the binary.
n	Size of bin_src.

Buffer s is going to be copied, thus it can be freed after.

Returns

0 on success, else an error code.

                  {
  if (bh == nullptr) {
    return EINVAL;
  }
 
  if (s == nullptr) {
    return EINVAL;
  }
 
  if (n == 0) {
    return EINVAL;
  }
  llvm::SmallVector<char, 2048> ObjContent(static_cast<const uint8_t*>(s), static_cast<const uint8_t*>(s) + n);
  auto OutBuffer = std::make_unique<llvm::SmallVectorMemoryBuffer>(
      std::move(ObjContent), false);
 
  if (auto ObjOrErr = llvm::object::ObjectFile::createObjectFile(*OutBuffer)) {
    if (auto Err = bh->B.addBinary({std::move(*ObjOrErr), std::move(OutBuffer)})) {
      return EINVAL;
    }
  } else {
    return EINVAL;
  }
 
  return 0;
}

saq_bartleby_build_archive()

SAQ_BARTLEBY_API int saq_bartleby_build_archive	(	struct BartlebyHandle *	bh,
		void **	s,
		size_t *	n
	)

Builds the final archive and writes its content to a buffer.

Warning

This function consumes the input Bartleby handle. Thus, users must not call saq_bartleby_free after calling saq_bartleby_build_archive.

Parameters

	bh	Bartleby handle.
[out]	s	Destination buffer.
[out]	n	Size of s.

Returns

0 on success, else an error code.

             {
  std::unique_ptr<struct BartlebyHandle> handle(bh);
 
  if (handle == nullptr) {
    return EINVAL;
  }
 
  if (s == nullptr) {
    return EINVAL;
  }
  *s = nullptr;
 
  if (n == nullptr) {
    return EINVAL;
  }
  *n = 0;
 
  if (auto ArOrErr = bartleby::Bartleby::buildFinalArchive(std::move(handle->B))) {
    const auto MemBuf = std::move(*ArOrErr);
    *n = MemBuf->getBufferSize();
    *s = ::malloc(*n);
    if (*s == nullptr) {
      return ENOMEM;
    }
    ::memcpy(*s, MemBuf->getBufferStart(), *n);
    return 0;
  }
  return EINVAL;
}

saq_bartleby_free()

SAQ_BARTLEBY_API void saq_bartleby_free

(

struct BartlebyHandle *

bh

)

Frees a Bartleby handle.

Parameters

bh	Bartleby handle to free. A NULL value here is allowed.

                                                  {
  delete bh;
}

saq_bartleby_new()

SAQ_BARTLEBY_API struct BartlebyHandle * saq_bartleby_new

(

void

)

Allocates a new Bartleby handle.

Returns

A new Bartleby handle, or NULL if an error occurred.

                                              {
  return new BartlebyHandle{};
}

saq_bartleby_set_prefix()

SAQ_BARTLEBY_API int saq_bartleby_set_prefix	(	struct BartlebyHandle *	bh,
		const char *	prefix
	)

Applies a prefix to all global and defined symbols.

Parameters

bh	Bartleby handle.
prefix	Prefix to apply.

Returns

0 on success, else an error code.

                                                                           {
  if (bh == nullptr) {
    return EINVAL;
  }
 
  if (prefix == nullptr) {
    return EINVAL;
  }
 
  bh->B.prefixGlobalAndDefinedSymbols(prefix);
 
  return 0;
}