Skip to content

Commit

Permalink
PROTON-????: Support building python extension with unbundled proton
Browse files Browse the repository at this point in the history
There are 3 cases:
* Bundled proton library - this should be the default and is what you
  should use with pip etc.
* System proton library - this is what you should use in a distro
  package - esp. Fedora/RHEL pr Debian too?
* In dev tree - should build with the in dev tree proton lib for
  debugging.
  • Loading branch information
astitcher committed Jan 12, 2024
1 parent a175b5e commit 67a2c1f
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 44 deletions.
95 changes: 51 additions & 44 deletions python/ext_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,57 +32,64 @@
cdefs = open('cproton.h').read()
ffibuilder.cdef(cdefs)

proton_base = '.'
proton_c_src = os.path.join(proton_base, 'src')
proton_core_src = os.path.join(proton_c_src, 'core')
proton_c_include = os.path.join(proton_base, 'include')

pkgconfig = []
sources = []
extra = []
libraries = []
for root, dirs, files in os.walk(proton_core_src):
dirs.sort() # needed for os.walk to process directories in deterministic order
files.sort()
for file_ in files:
if file_.endswith(('.c', '.cpp')):
sources.append(os.path.join(root, file_))

if os.name == 'nt':
sources += [
os.path.join(proton_c_src, 'compiler', 'msvc', 'start.c')
]
elif os.name == 'posix':
sources += [
os.path.join(proton_c_src, 'compiler', 'gcc', 'start.c')
]
extra += ['-std=c99']

sources.append(os.path.join(proton_c_src, 'sasl', 'sasl.c'))
sources.append(os.path.join(proton_c_src, 'sasl', 'default_sasl.c'))
include_dirs = []
macros = []

pkgconfig = []
if os.name == 'nt':
libraries += ['crypt32', 'secur32']
sources.append(os.path.join(proton_c_src, 'ssl', 'schannel.cpp'))
else:
try:
ssl_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['openssl'])
sources.append(os.path.join(proton_c_src, 'ssl', 'openssl.c'))
pkgconfig.append('openssl')
except cffi.pkgconfig.PkgConfigError:
# Stub ssl
sources.append(os.path.join(proton_c_src, 'ssl', 'ssl_stub.c'))

# Stub sasl
try:
sasl_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['libsasl2'])
sources.append(os.path.join(proton_c_src, 'sasl', 'cyrus_sasl.c'))
pkgconfig.append('libsasl2')
proton_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['libqpid-proton-core'])
pkgconfig.append('libqpid-proton-core')
except cffi.pkgconfig.PkgConfigError:
sources.append(os.path.join(proton_c_src, 'sasl', 'cyrus_stub.c'))
proton_base = '.'
proton_c_src = os.path.join(proton_base, 'src')
proton_core_src = os.path.join(proton_c_src, 'core')
proton_c_include = os.path.join(proton_base, 'include')

for root, dirs, files in os.walk(proton_core_src):
dirs.sort() # needed for os.walk to process directories in deterministic order
files.sort()
for file_ in files:
if file_.endswith(('.c', '.cpp')):
sources.append(os.path.join(root, file_))

if os.name == 'nt':
sources += [
os.path.join(proton_c_src, 'compiler', 'msvc', 'start.c')
]
elif os.name == 'posix':
sources += [
os.path.join(proton_c_src, 'compiler', 'gcc', 'start.c')
]
extra += ['-std=c99']

sources.append(os.path.join(proton_c_src, 'sasl', 'sasl.c'))
sources.append(os.path.join(proton_c_src, 'sasl', 'default_sasl.c'))

if os.name == 'nt':
libraries += ['crypt32', 'secur32']
sources.append(os.path.join(proton_c_src, 'ssl', 'schannel.cpp'))
else:
try:
ssl_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['openssl'])
sources.append(os.path.join(proton_c_src, 'ssl', 'openssl.c'))
pkgconfig.append('openssl')
except cffi.pkgconfig.PkgConfigError:
# Stub ssl
sources.append(os.path.join(proton_c_src, 'ssl', 'ssl_stub.c'))

# Stub sasl
try:
sasl_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['libsasl2'])
sources.append(os.path.join(proton_c_src, 'sasl', 'cyrus_sasl.c'))
pkgconfig.append('libsasl2')
except cffi.pkgconfig.PkgConfigError:
sources.append(os.path.join(proton_c_src, 'sasl', 'cyrus_stub.c'))

include_dirs = [proton_c_include, proton_c_src]
macros = [('PROTON_DECLARE_STATIC', None)]
include_dirs = [proton_c_include, proton_c_src]
macros = [('PROTON_DECLARE_STATIC', None)]

c_code = r"""
#include "proton/version.h"
Expand Down
142 changes: 142 additions & 0 deletions python/ext_build_unbundled.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
#

import cffi.pkgconfig

from cffi import FFI


ffibuilder = FFI()

# cdef() expects a single string declaring the C types, functions and
# globals needed to use the shared object. It must be in valid C syntax
# with cffi extensions
cdefs = open('cproton.h').read()
ffibuilder.cdef(cdefs)

pkgconfig = []
sources = []
extra = []
libraries = []
include_dirs = []
macros = []

try:
proton_pkgcfg = cffi.pkgconfig.flags_from_pkgconfig(['libqpid-proton-core'])
pkgconfig.append('libqpid-proton-core')
except cffi.pkgconfig.PkgConfigError:
pass

c_code = r"""
#include "proton/version.h"
#include "proton/types.h"
#include "proton/object.h"
#include "proton/error.h"
#include "proton/condition.h"
#include "proton/connection.h"
#include "proton/session.h"
#include "proton/link.h"
#include "proton/terminus.h"
#include "proton/delivery.h"
#include "proton/disposition.h"
#include "proton/transport.h"
#include "proton/event.h"
#include "proton/message.h"
#include "proton/sasl.h"
#include "proton/ssl.h"
#include "proton/codec.h"
#include "proton/connection_driver.h"
#include "proton/cid.h"
static void pn_pyref_incref(void *object);
static void pn_pyref_decref(void *object);
static int pn_pyref_refcount(void *object) {
return 1;
}
pn_connection_t *pn_cast_pn_connection(void *x) { return (pn_connection_t *) x; }
pn_session_t *pn_cast_pn_session(void *x) { return (pn_session_t *) x; }
pn_link_t *pn_cast_pn_link(void *x) { return (pn_link_t *) x; }
pn_delivery_t *pn_cast_pn_delivery(void *x) { return (pn_delivery_t *) x; }
pn_transport_t *pn_cast_pn_transport(void *x) { return (pn_transport_t *) x; }
static pn_class_t* PN_PYREF;
PN_HANDLE(PN_PYCTX);
static pn_class_t* pn_create_pyref() {
return pn_class_create("pn_pyref", NULL, NULL, pn_pyref_incref, pn_pyref_decref, pn_pyref_refcount);
}
pn_event_t *pn_collector_put_py(pn_collector_t *collector, void *context, pn_event_type_t type) {
return pn_collector_put(collector, PN_PYREF, context, type);
}
void pn_record_def_py(pn_record_t *record) {
pn_record_def(record, PN_PYCTX, PN_PYREF);
}
void *pn_record_get_py(pn_record_t *record) {
return pn_record_get(record, PN_PYCTX);
}
void pn_record_set_py(pn_record_t *record, void *value) {
pn_record_set(record, PN_PYCTX, value);
}
ssize_t pn_message_encode_py(pn_message_t *msg, char *bytes, size_t size) {
int err = pn_message_encode(msg, bytes, &size);
if (err == 0) return size;
else return err;
}
ssize_t pn_data_format_py(pn_data_t *data, char *bytes, size_t size) {
int err = pn_data_format(data, bytes, &size);
if (err == 0) return size;
else return err;
}
int pn_ssl_get_peer_hostname_py(pn_ssl_t *ssl, char *hostname, size_t size) {
return pn_ssl_get_peer_hostname(ssl, hostname, &size);
}
const char *pn_event_class_name_py(pn_event_t *event) {
const pn_class_t *class = pn_event_class(event);
return class ? pn_class_name(class) : 0;
}
void init() {
PN_PYREF = pn_create_pyref();
}
"""

ffibuilder.set_source_pkgconfig(
"cproton_ffi",
pkgconfig,
c_code,
define_macros=macros,
extra_compile_args=extra,
sources=sources,
include_dirs=include_dirs
)

if __name__ == "__main__":
ffibuilder.compile(verbose=True)

0 comments on commit 67a2c1f

Please sign in to comment.