Skip to content

Commit

Permalink
fix(ext): segv on fork
Browse files Browse the repository at this point in the history
We would segv when using proj and then fork a process. This is fixed
by using proj's thread-safe context.

Fixes #39
  • Loading branch information
BuonOmo committed Jun 9, 2023
1 parent 747052a commit c9033df
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 17 deletions.
37 changes: 21 additions & 16 deletions ext/proj4_c_impl/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ typedef struct {
PJ *crs_to_crs;
} RGeo_CRSToCRSData;

// PROJ context for multithreaded environments. This avoids segfaults or
// hanging processes on fork. We only use one context, initialized on load.
static PJ_CONTEXT* local_proj_context;

// Destroy function for proj data.
static void rgeo_proj4_free(void *ptr) {
RGeo_Proj4Data *data = (RGeo_Proj4Data *)ptr;
Expand Down Expand Up @@ -154,10 +158,10 @@ static VALUE method_proj4_initialize_copy(VALUE self, VALUE orig) {
TypedData_Get_Struct(orig, RGeo_Proj4Data, &rgeo_proj4_data_type, orig_data);
if (!NIL_P(orig_data->original_str)) {
self_data->pj =
proj_create(PJ_DEFAULT_CTX, StringValuePtr(orig_data->original_str));
proj_create(local_proj_context, StringValuePtr(orig_data->original_str));
} else {
str = proj_as_proj_string(PJ_DEFAULT_CTX, orig_data->pj, PJ_PROJ_4, NULL);
self_data->pj = proj_create(PJ_DEFAULT_CTX, str);
str = proj_as_proj_string(local_proj_context, orig_data->pj, PJ_PROJ_4, NULL);
self_data->pj = proj_create(local_proj_context, str);
}
self_data->original_str = orig_data->original_str;
self_data->uses_radians = orig_data->uses_radians;
Expand All @@ -175,7 +179,7 @@ static VALUE method_proj4_set_value(VALUE self, VALUE str, VALUE uses_radians) {
rgeo_proj4_clear_struct(self_data);

// Set new data
self_data->pj = proj_create(PJ_DEFAULT_CTX, StringValuePtr(str));
self_data->pj = proj_create(local_proj_context, StringValuePtr(str));
self_data->original_str = str;
self_data->uses_radians = RTEST(uses_radians) ? 1 : 0;

Expand All @@ -194,7 +198,7 @@ static VALUE method_proj4_get_geographic(VALUE self) {
TypedData_Get_Struct(self, RGeo_Proj4Data, &rgeo_proj4_data_type,
self_data);

geographic_proj = proj_crs_get_geodetic_crs(PJ_DEFAULT_CTX, self_data->pj);
geographic_proj = proj_crs_get_geodetic_crs(local_proj_context, self_data->pj);
if (geographic_proj == 0) {
FREE(new_data);
rb_raise(rb_eRGeoInvalidProjectionError,
Expand Down Expand Up @@ -233,7 +237,7 @@ static VALUE method_proj4_canonical_str(VALUE self) {
TypedData_Get_Struct(self, RGeo_Proj4Data, &rgeo_proj4_data_type, data);
pj = data->pj;
if (pj) {
str = proj_as_proj_string(PJ_DEFAULT_CTX, pj, PJ_PROJ_4, NULL);
str = proj_as_proj_string(local_proj_context, pj, PJ_PROJ_4, NULL);
if (str) {
result = rb_str_new2(str);
}
Expand All @@ -252,7 +256,7 @@ static VALUE method_proj4_wkt_str(VALUE self) {
pj = data->pj;
if (pj) {
const char *const options[] = {"MULTILINE=NO", NULL};
str = proj_as_wkt(PJ_DEFAULT_CTX, pj, WKT_TYPE, options);
str = proj_as_wkt(local_proj_context, pj, WKT_TYPE, options);
if (str) {
result = rb_str_new2(str);
}
Expand Down Expand Up @@ -297,9 +301,9 @@ static VALUE method_proj4_axis_and_unit_info_str(VALUE self, VALUE dimension) {
TypedData_Get_Struct(self, RGeo_Proj4Data, &rgeo_proj4_data_type, data);
pj = data->pj;
if (pj) {
pj_cs = proj_crs_get_coordinate_system(PJ_DEFAULT_CTX, pj);
pj_cs = proj_crs_get_coordinate_system(local_proj_context, pj);
if (pj_cs) {
if (proj_cs_get_axis_info(PJ_DEFAULT_CTX, pj_cs, dimension_index,
if (proj_cs_get_axis_info(local_proj_context, pj_cs, dimension_index,
&axis_info, NULL, NULL, NULL, &unit_name, NULL,
NULL)) {
result = rb_sprintf("%s:%s", axis_info, unit_name);
Expand All @@ -322,9 +326,9 @@ static VALUE method_proj4_axis_count(VALUE self) {
TypedData_Get_Struct(self, RGeo_Proj4Data, &rgeo_proj4_data_type, data);
pj = data->pj;
if (pj) {
pj_cs = proj_crs_get_coordinate_system(PJ_DEFAULT_CTX, pj);
pj_cs = proj_crs_get_coordinate_system(local_proj_context, pj);
if (pj_cs) {
count = proj_cs_get_axis_count(PJ_DEFAULT_CTX, pj_cs);
count = proj_cs_get_axis_count(local_proj_context, pj_cs);
result = INT2FIX(count);

proj_destroy(pj_cs);
Expand Down Expand Up @@ -412,7 +416,7 @@ static VALUE cmethod_proj4_create(VALUE klass, VALUE str, VALUE uses_radians) {
Check_Type(str, T_STRING);
data = ALLOC(RGeo_Proj4Data);
if (data) {
data->pj = proj_create(PJ_DEFAULT_CTX, StringValuePtr(str));
data->pj = proj_create(local_proj_context, StringValuePtr(str));
data->original_str = str;
data->uses_radians = RTEST(uses_radians) ? 1 : 0;
result = TypedData_Wrap_Struct(klass, &rgeo_proj4_data_type, data);
Expand All @@ -436,7 +440,7 @@ static VALUE cmethod_crs_to_crs_create(VALUE klass, VALUE from, VALUE to) {
from_pj = from_data->pj;
to_pj = to_data->pj;
crs_to_crs =
proj_create_crs_to_crs_from_pj(PJ_DEFAULT_CTX, from_pj, to_pj, 0, NULL);
proj_create_crs_to_crs_from_pj(local_proj_context, from_pj, to_pj, 0, NULL);

// check for invalid transformation
if (crs_to_crs == 0) {
Expand All @@ -447,7 +451,7 @@ static VALUE cmethod_crs_to_crs_create(VALUE klass, VALUE from, VALUE to) {
// necessary to use proj_normalize_for_visualization so that we
// do not have to worry about the order of coordinates in every
// coord system
gis_pj = proj_normalize_for_visualization(PJ_DEFAULT_CTX, crs_to_crs);
gis_pj = proj_normalize_for_visualization(local_proj_context, crs_to_crs);
if (gis_pj) {
proj_destroy(crs_to_crs);
crs_to_crs = gis_pj;
Expand Down Expand Up @@ -503,7 +507,7 @@ static VALUE method_crs_to_crs_wkt_str(VALUE self) {
crs_to_crs_pj = crs_to_crs_data->crs_to_crs;
if (crs_to_crs_pj) {
const char *const options[] = {"MULTILINE=NO", NULL};
str = proj_as_wkt(PJ_DEFAULT_CTX, crs_to_crs_pj, WKT_TYPE, options);
str = proj_as_wkt(local_proj_context, crs_to_crs_pj, WKT_TYPE, options);
if (str) {
result = rb_str_new2(str);
}
Expand All @@ -522,7 +526,7 @@ static VALUE method_crs_to_crs_area_of_use_str(VALUE self) {
crs_to_crs_data);
crs_to_crs_pj = crs_to_crs_data->crs_to_crs;
if (crs_to_crs_pj) {
if (proj_get_area_of_use(PJ_DEFAULT_CTX, crs_to_crs_pj, NULL, NULL, NULL,
if (proj_get_area_of_use(local_proj_context, crs_to_crs_pj, NULL, NULL, NULL,
NULL, &str)) {
result = rb_str_new2(str);
}
Expand Down Expand Up @@ -639,6 +643,7 @@ static void rgeo_init_proj4() {

void Init_proj4_c_impl() {
#ifdef RGEO_PROJ4_SUPPORTED
local_proj_context = proj_context_create();
rgeo_init_proj4();
rgeo_init_proj_errors();
#endif
Expand Down
22 changes: 22 additions & 0 deletions test/non_regression_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# frozen_string_literal: true

require_relative "test_helper"
require "timeout"

class NonRegressionTest < Minitest::Test
# When this test fail, you should end up with a segv. Note that it does
# not fail systematically, so running it ~10 times will help you be sure
# that you are not regressing on that topic again.
#
# See https://github.com/rgeo/rgeo-proj4/issues/39.
def test_forking_issue_39
RGeo::CoordSys::Proj4.create("EPSG:4326")
pid = Process.fork {}
Timeout.timeout(1) { Process.wait pid }
ensure
begin
Process.kill(9, pid)
rescue Errno::ESRCH
end
end
end
2 changes: 1 addition & 1 deletion test/test_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

require "minitest/autorun"
require "rgeo/proj4"
require "common/factory_tests"
require_relative "common/factory_tests"
require "psych"

# Only here for Psych 4.0.0 breaking change.
Expand Down

0 comments on commit c9033df

Please sign in to comment.