wiki:FAQMiscellaneous

FAQ - Miscellaneous

  1. Is the GDAL library thread-safe?
  2. Does GDAL work in different international numeric locales?
  3. How do I debug GDAL?
  4. How should I deallocate resources acquainted from GDAL on Windows?
  5. C API vs C++ API
  6. How do I suppress warning encountered in Python API?
  7. What are configuration options, and what ones exist?
  8. What XML parsers are available or used in GDAL/OGR?

Is the GDAL library thread-safe?

There is not a plain yes/no answer. When care is taken, GDAL use should be thread safe in most situations ( we cannot exclude that historic/esoteric drivers might have thread safety issues ). One important point is that the same GDALDataset object should not be accessed by several threads at the same time. But of course, it is fine to use 2 different handles pointing to the same file in 2 threads (*). Before GDAL 2.0, it was not safe either to have a thread doing write operations on a dataset while one or several other threads were doing read operations on (other) datasets. Starting with GDAL 2.0, this is now possible.

(*) When using GDAL .vrt files, special care must be taken. See the Multi-threading issues section of the VRT tutorial.

Does GDAL work in different international numeric locales?

Starting with GDAL 2.0, this should work in most cases.

In earlier versions, GDAL made extensive use of sprintf() and atof() internally to translate numeric values. If a locale is in effect that modifies formatting of numbers, altering the role of commas and periods in numbers, then PROJ.4 will not work. This problem is common in some European locales.

On Unix-like platforms, this problem could be avoided by forcing the use of the default numeric locale by setting the LC_NUMERIC environment variable to C, e.g.

$ export LC_NUMERIC=C
$ gdalinfo abc.tif

How do I debug GDAL?

Various helpful debugging information will be produced by GDAL and OGR if the CPL_DEBUG confiuration option is set to the value ON. Review the documentation for the CPLDebug() function for more information on built-in debugging messages.

For versions prior to GDAL 1.5, on Unix operating systems GDAL can be built with the CFG environment variable set to debug to enable debugger support with the -g compiler switch. For GDAL versions 1.5+, you can enable debugging symbols with the --enable-debug configure switch.

On Windows edit the nmake.opt and ensure /Zi appears in the OPTFLAGS variable.

How should I deallocate resources acquainted from GDAL on Windows?

The safest way to release resources allocated and returned (with ownership transfered to caller) from GDAL library is to use dedicated deallocator function. Deallocators promise to release resources on the right module side, without crossing modules boundaries what usually causes memory access violation errors.

  • Example of correct resource deallocation:
OGRDataSource* poDS = NULL;

// OGRDataSource aquisition made on side of the GDAL module
poDS = OGRSFDriverRegistrar::Open( "point.shp", FALSE );

// ...

// Properly resource release using deallocator function
OGRDataSource::DestroyDataSource( poDS );
  • Example of incorrect resource deallocation:
OGRDataSource* poDS = NULL;

// OGRDataSource aquisition made on side of the GDAL module
poDS = OGRSFDriverRegistrar::Open( "point.shp", FALSE );

// ...

// Deallocation across modules boundaries.
// Here, the deallocation crosses GDAL DLL library and client's module (ie. executable module)
delete poDS;

More detailed explanation of the problem can be found in following articles:

C API vs C++ API

If you intend writing code using GDAL/OGR that will not require recompilation when run against different GDAL/OGR versions, you should try to stick to the C API when possible. Although the changes in the C++ API are generally made in a upward compatible way, the C++ ABI might change from a minor release to another one (for example from GDAL 1.5.0 to GDAL 1.6.0) due to additions of new virtual methods, new member variables to core classes, etc.

How do I suppress warning encountered in Python API?

Set error handler to quite one:

gdal.PushErrorHandler('CPLQuietErrorHandler')

What are configuration options, and what ones exist?

Configuration options are values the user or application developer can set at runtime to affect the behavior of the library. Details and a partial listing of options are available in the ConfigOptions page.

What XML parsers are available or used in GDAL/OGR?

Based on Preferred XML parsers thread, we have a variety of XML parsers used:

  • The built-in CPLMiniXML parser (port/cpl_minixml.h) that is a simple DOM parser without any fancy feature (it doesn't have explicit support for encodings for example. If you've need for recoding, you'll have to do it explicitely with CPLRecode() API) but that works well and is used for parsing PAM .aux.xml, .vrt, etc.
  • Expat for SAX parsing in quite a lot of OGR drivers : GPX, GeoRSS, GML, XLSX, ODS, SVG.
  • Xerces used in GML (GML can use Expat or Xerces), its derived driver NAS and in the existing Interlis driver as you mentionned.
Last modified 8 months ago Last modified on Jan 4, 2016 4:06:07 AM