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.

Sign up for GitHub

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

[API] Deliver ABI breaking changes #2222

Merged
merged 15 commits into from
Sep 14, 2023
Merged

[API] Deliver ABI breaking changes #2222

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1ef7760
Proof of concept.
marcalff Jul 7, 2023
3d33126
Continued.
marcalff Jul 7, 2023
1903e7e
Added details.
marcalff Jul 7, 2023
59947f2
Merge branch 'main' into fix_breaking_change_1983
marcalff Jul 10, 2023
31f4288
Continue doc.
marcalff Jul 10, 2023
f17d932
Build cleanup
marcalff Jul 10, 2023
f7aedb3
Merge branch 'main' into fix_breaking_change_1983
marcalff Jul 21, 2023
ba433b8
Merge branch 'main' into fix_breaking_change_1983
marcalff Sep 5, 2023
bd75d86
Adjust version after merge
marcalff Sep 5, 2023
18efa93
Implement review comments.
marcalff Sep 6, 2023
353a3d5
format
marcalff Sep 6, 2023
58e8c88
Merge branch 'main' into fix_breaking_change_1983
marcalff Sep 13, 2023
264e51e
Rewording, misc cleanup
marcalff Sep 13, 2023
7f2ceee
format
marcalff Sep 13, 2023
032033e
Fixed typo.
marcalff Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,41 @@ if(VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
include("${VCPKG_CHAINLOAD_TOOLCHAIN_FILE}")
endif()

option(WITH_ABI_VERSION_1 "ABI version 1" ON)
option(WITH_ABI_VERSION_2 "EXPERIMENTAL: ABI version 2 preview" OFF)

file(READ "${CMAKE_CURRENT_LIST_DIR}/api/include/opentelemetry/version.h"
OPENTELEMETRY_CPP_HEADER_VERSION_H)
if(OPENTELEMETRY_CPP_HEADER_VERSION_H MATCHES
"OPENTELEMETRY_ABI_VERSION_NO[ \t\r\n]+\"?([0-9]+)\"?")
math(EXPR OPENTELEMETRY_ABI_VERSION_NO ${CMAKE_MATCH_1})
else()

if(WITH_ABI_VERSION_1 AND WITH_ABI_VERSION_2)
# While not supported yet, having distinct WITH_ABI_VERSION_1 and
# WITH_ABI_VERSION_2 flags opens the possibility to support multiple ABI
# concurrently, which is why separate flags are used here.
#
# For now, only one ABI is supported in a build.
#
message(
FATAL_ERROR
"OPENTELEMETRY_ABI_VERSION_NO not found on ${CMAKE_CURRENT_LIST_DIR}/api/include/opentelemetry/version.h"
)
FATAL_ERROR "Set either WITH_ABI_VERSION_1 or WITH_ABI_VERSION_2, not both")
endif()

if(WITH_ABI_VERSION_2)
marcalff marked this conversation as resolved.
Show resolved Hide resolved
set(OPENTELEMETRY_ABI_VERSION_NO "2")
elseif(WITH_ABI_VERSION_1)
set(OPENTELEMETRY_ABI_VERSION_NO "1")
else()
if(OPENTELEMETRY_CPP_HEADER_VERSION_H MATCHES
"OPENTELEMETRY_ABI_VERSION_NO[ \t\r\n]+\"?([0-9]+)\"?")
math(EXPR OPENTELEMETRY_ABI_VERSION_NO ${CMAKE_MATCH_1})
else()
message(
FATAL_ERROR
"OPENTELEMETRY_ABI_VERSION_NO not found on ${CMAKE_CURRENT_LIST_DIR}/api/include/opentelemetry/version.h"
)
endif()
endif()

message(STATUS "OPENTELEMETRY_ABI_VERSION_NO=${OPENTELEMETRY_ABI_VERSION_NO}")

if(OPENTELEMETRY_CPP_HEADER_VERSION_H MATCHES
"OPENTELEMETRY_VERSION[ \t\r\n]+\"?([^\"]+)\"?")
set(OPENTELEMETRY_VERSION ${CMAKE_MATCH_1})
Expand All @@ -113,6 +137,8 @@ else()
)
endif()

message(STATUS "OPENTELEMETRY_VERSION=${OPENTELEMETRY_VERSION}")

option(WITH_NO_DEPRECATED_CODE "Do not include deprecated code" OFF)

option(WITH_STL "Whether to use Standard Library for C++ latest features" OFF)
Expand Down
8 changes: 8 additions & 0 deletions api/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ if(WITH_REMOVE_METER_PREVIEW)
INTERFACE ENABLE_REMOVE_METER_PREVIEW)
endif()

if(WITH_ABI_VERSION_2)
target_compile_definitions(opentelemetry_api
INTERFACE OPENTELEMETRY_ABI_VERSION_NO=2)
elseif(WITH_ABI_VERSION_1)
target_compile_definitions(opentelemetry_api
INTERFACE OPENTELEMETRY_ABI_VERSION_NO=1)
endif()
marcalff marked this conversation as resolved.
Show resolved Hide resolved

# A better place should be in sdk, not api
if(WITH_OTLP_HTTP_SSL_PREVIEW)
target_compile_definitions(opentelemetry_api
Expand Down
5 changes: 4 additions & 1 deletion api/include/opentelemetry/version.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
#include "opentelemetry/common/macros.h"
#include "opentelemetry/detail/preprocessor.h"

#define OPENTELEMETRY_ABI_VERSION_NO 1
#ifndef OPENTELEMETRY_ABI_VERSION_NO
# define OPENTELEMETRY_ABI_VERSION_NO 1
#endif

#define OPENTELEMETRY_VERSION "1.11.0"
#define OPENTELEMETRY_VERSION_MAJOR 1
#define OPENTELEMETRY_VERSION_MINOR 11
Expand Down
Loading