[pandas 2.0] Share low level C++ utility code (memory allocation, error reporting, bit manipulation) with libarrow

Closes wesm#44. This will spare us developing similar functionality in two
places for the time being -- we can keep an eye on the relationship
between the libraries in case it does make sense to split in the
future (but it may not, particularly if we use Arrow to implement
nested data natively in pandas).

Author: Wes McKinney <[email protected]>

Closes wesm#49 from wesm/link-libarrow and squashes the following commits:

1d176b1 [Wes McKinney] Refactor libpandas to use common constructs and utility code from libarrow: Status, MemoryPool, Buffer, etc.

Change-Id: I3140a3ed8dd17db376be21241fc259523a16cc88

Author: wesm

CMakeLists.txt

@@ -467,6 +467,17 @@ include_directories(SYSTEM
   thirdparty/
   src)
 
+## Arrow
+find_package(Arrow REQUIRED)
+include_directories(SYSTEM ${ARROW_INCLUDE_DIR})
+ADD_THIRDPARTY_LIB(arrow
+  SHARED_LIB ${ARROW_SHARED_LIB}
+  STATIC_LIB ${ARROW_STATIC_LIB})
+ADD_THIRDPARTY_LIB(arrow_io
+  SHARED_LIB ${ARROW_IO_SHARED_LIB})
+ADD_THIRDPARTY_LIB(arrow_ipc
+  SHARED_LIB ${ARROW_IPC_SHARED_LIB})
+
 ############################################################
 # Testing
 ############################################################
@@ -631,13 +642,11 @@ add_subdirectory(src/pandas/util)
 
 set(PANDAS_SRCS
   src/pandas/array.cc
-  src/pandas/buffer.cc
   src/pandas/dispatch.cc
   src/pandas/init.cc
   src/pandas/memory.cc
   src/pandas/numpy_interop.cc
   src/pandas/pytypes.cc
-  src/pandas/status.cc
   src/pandas/type.cc
 
   src/pandas/types/boolean.cc
@@ -649,11 +658,12 @@ set(PANDAS_SRCS
 add_library(pandas SHARED
   ${PANDAS_SRCS})
 target_link_libraries(pandas
-	pandas_util)
+  arrow
+  pandas_util)
 set_target_properties(pandas PROPERTIES LINKER_LANGUAGE CXX)
 
 if(APPLE)
-    set_target_properties(pandas PROPERTIES LINK_FLAGS "-undefined dynamic_lookup")
+  set_target_properties(pandas PROPERTIES LINK_FLAGS "-undefined dynamic_lookup")
 endif()
 
 ############################################################

cmake_modules/FindArrow.cmake

@@ -0,0 +1,97 @@
+# 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.
+
+# - Find ARROW (arrow/api.h, libarrow.a, libarrow.so)
+# This module defines
+#  ARROW_INCLUDE_DIR, directory containing headers
+#  ARROW_LIBS, directory containing arrow libraries
+#  ARROW_STATIC_LIB, path to libarrow.a
+#  ARROW_SHARED_LIB, path to libarrow's shared library
+#  ARROW_FOUND, whether arrow has been found
+
+set(ARROW_SEARCH_HEADER_PATHS
+  $ENV{ARROW_HOME}/include
+)
+
+set(ARROW_SEARCH_LIB_PATH
+  $ENV{ARROW_HOME}/lib
+)
+
+find_path(ARROW_INCLUDE_DIR arrow/array.h PATHS
+  ${ARROW_SEARCH_HEADER_PATHS}
+  # make sure we don't accidentally pick up a different version
+  NO_DEFAULT_PATH
+)
+
+find_library(ARROW_LIB_PATH NAMES arrow
+  PATHS
+  ${ARROW_SEARCH_LIB_PATH}
+  NO_DEFAULT_PATH)
+
+find_library(ARROW_IO_LIB_PATH NAMES arrow_io
+  PATHS
+  ${ARROW_SEARCH_LIB_PATH}
+  NO_DEFAULT_PATH)
+
+find_library(ARROW_IPC_LIB_PATH NAMES arrow_ipc
+  PATHS
+  ${ARROW_SEARCH_LIB_PATH}
+  NO_DEFAULT_PATH)
+
+if (ARROW_INCLUDE_DIR AND ARROW_LIB_PATH)
+  set(ARROW_FOUND TRUE)
+  set(ARROW_LIB_NAME libarrow)
+  set(ARROW_IO_LIB_NAME libarrow_io)
+  set(ARROW_IPC_LIB_NAME libarrow_ipc)
+
+  set(ARROW_LIBS ${ARROW_SEARCH_LIB_PATH})
+  set(ARROW_STATIC_LIB ${ARROW_SEARCH_LIB_PATH}/${ARROW_LIB_NAME}.a)
+  set(ARROW_SHARED_LIB ${ARROW_LIBS}/${ARROW_LIB_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
+
+  set(ARROW_IO_STATIC_LIB ${ARROW_SEARCH_LIB_PATH}/${ARROW_IO_LIB_NAME}.a)
+  set(ARROW_IO_SHARED_LIB ${ARROW_LIBS}/${ARROW_IO_LIB_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
+
+  set(ARROW_IPC_STATIC_LIB ${ARROW_SEARCH_LIB_PATH}/${ARROW_IPC_LIB_NAME}.a)
+  set(ARROW_IPC_SHARED_LIB ${ARROW_LIBS}/${ARROW_IPC_LIB_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
+
+  if (NOT Arrow_FIND_QUIETLY)
+    message(STATUS "Found the Arrow core library: ${ARROW_LIB_PATH}")
+    message(STATUS "Found the Arrow IO library: ${ARROW_IO_LIB_PATH}")
+    message(STATUS "Found the Arrow IPC library: ${ARROW_IPC_LIB_PATH}")
+  endif ()
+else ()
+  if (NOT Arrow_FIND_QUIETLY)
+    set(ARROW_ERR_MSG "Could not find the Arrow library. Looked for headers")
+    set(ARROW_ERR_MSG "${ARROW_ERR_MSG} in ${ARROW_SEARCH_HEADER_PATHS}, and for libs")
+    set(ARROW_ERR_MSG "${ARROW_ERR_MSG} in ${ARROW_SEARCH_LIB_PATH}")
+    if (Arrow_FIND_REQUIRED)
+      message(FATAL_ERROR "${ARROW_ERR_MSG}")
+    else (Arrow_FIND_REQUIRED)
+      message(STATUS "${ARROW_ERR_MSG}")
+    endif (Arrow_FIND_REQUIRED)
+  endif ()
+  set(ARROW_FOUND FALSE)
+endif ()
+
+mark_as_advanced(
+  ARROW_INCLUDE_DIR
+  ARROW_LIBS
+  ARROW_STATIC_LIB
+  ARROW_SHARED_LIB
+  ARROW_IO_STATIC_LIB
+  ARROW_IO_SHARED_LIB
+)

src/pandas/CMakeLists.txt

@@ -12,6 +12,4 @@ install(FILES
 set(PANDAS_TEST_LINK_LIBS pandas_test_util ${PANDAS_MIN_TEST_LIBS})
 
 ADD_PANDAS_TEST(array-test)
-ADD_PANDAS_TEST(buffer-test)
-ADD_PANDAS_TEST(memory-test)
 ADD_PANDAS_TEST(util-test)

src/pandas/api.h

@@ -5,8 +5,8 @@
 #define PANDAS_API_H
 
 #include "pandas/array.h"
+#include "pandas/common.h"
 #include "pandas/dispatch.h"
-#include "pandas/status.h"
 #include "pandas/type.h"
 
 #include "pandas/types/boolean.h"

src/pandas/array-test.cc

@@ -10,9 +10,8 @@
 #include "gtest/gtest.h"
 
 #include "pandas/array.h"
-#include "pandas/buffer.h"
+#include "pandas/common.h"
 #include "pandas/memory.h"
-#include "pandas/status.h"
 #include "pandas/test-util.h"
 #include "pandas/type.h"
 #include "pandas/types/numeric.h"

src/pandas/array.cc

@@ -2,7 +2,7 @@
 // copyright holders
 
 #include "pandas/array.h"
-#include "pandas/status.h"
+#include "pandas/common.h"
 #include "pandas/type.h"
 #include "pandas/util/logging.h"
 

src/pandas/array.h

@@ -9,14 +9,12 @@
 #include <string>
 #include <vector>
 
+#include "pandas/common.h"
 #include "pandas/type.h"
 #include "pandas/util.h"
 
 namespace pandas {
 
-// Forward declarations
-class Status;
-
 // Base class for physical array data structures.
 class Array {
  public: