forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
apacheGH-37938: [Swift] initial impl of C Data interface
- Loading branch information
Showing
19 changed files
with
987 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // 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 Foundation | ||
| import ArrowC | ||
| import Atomics | ||
|
|
||
| extension String { | ||
| var cstring: UnsafePointer<CChar> { | ||
| (self as NSString).cString(using: String.Encoding.utf8.rawValue)! | ||
| } | ||
| } | ||
|
|
||
| // The memory used by UnsafeAtomic is not automatically | ||
| // reclaimed. Since this value is initialized once | ||
| // and used until the program/app is closed it's | ||
| // memory will be released on program/app exit | ||
| let exportDataCounter: UnsafeAtomic<Int> = .create(0) | ||
|
|
||
| public class ArrowCExporter { | ||
| private class ExportData { | ||
| let id: Int | ||
| var cArray = ArrowC.ArrowArray() | ||
| private let arrowData: ArrowData | ||
| private(set) var data = [UnsafeRawPointer?]() | ||
| private(set) var buffers: UnsafeMutablePointer<UnsafeRawPointer?> | ||
| init(_ arrowData: ArrowData) { | ||
| id = exportDataCounter.loadThenWrappingIncrement(ordering: .relaxed) | ||
|
|
||
| // keep a reference to the ArrowData | ||
| // obj so the memory doesn't get | ||
| // deallocated | ||
| self.arrowData = arrowData | ||
| for arrowBuffer in arrowData.buffers { | ||
| data.append(arrowBuffer.rawPointer) | ||
| } | ||
|
|
||
| self.buffers = UnsafeMutablePointer(mutating: data) | ||
| ArrowCExporter.exportedData[id] = self | ||
| } | ||
|
|
||
| func release() { | ||
| // the data associated with this export data | ||
| // does not need to be released as they are | ||
| // still associated with the ArrowBuffer | ||
| // and it will deallocate this memory | ||
| ArrowCExporter.exportedData.removeValue(forKey: id.hashValue) | ||
| } | ||
| } | ||
|
|
||
| private static var exportedData = [Int: ExportData]() | ||
|
|
||
| public init() {} | ||
|
|
||
| public func exportType(_ cSchema: inout ArrowC.ArrowSchema, arrowType: ArrowType, name: String = "") -> | ||
| Result<Bool, ArrowError> { | ||
| do { | ||
| cSchema.format = try arrowType.cDataFormatId.cstring | ||
| cSchema.name = name.cstring | ||
| cSchema.release = {data in | ||
| data?.pointee.release = nil | ||
| } | ||
| } catch { | ||
| return .failure(.unknownError("\(error)")) | ||
| } | ||
| return .success(true) | ||
| } | ||
|
|
||
| public func exportField(_ schema: inout ArrowC.ArrowSchema, field: ArrowField) -> | ||
| Result<Bool, ArrowError> { | ||
| return exportType(&schema, arrowType: field.type, name: field.name) | ||
| } | ||
|
|
||
| public func exportArray(_ cArray: inout ArrowC.ArrowArray, arrowData: ArrowData) { | ||
| let exportData = ExportData(arrowData) | ||
| cArray.buffers = exportData.buffers | ||
| cArray.length = Int64(arrowData.length) | ||
| cArray.null_count = Int64(arrowData.nullCount) | ||
| cArray.n_buffers = Int64(arrowData.buffers.count) | ||
| cArray.n_children = 0 | ||
| cArray.children = nil | ||
| cArray.dictionary = nil | ||
| cArray.private_data = | ||
| UnsafeMutableRawPointer(mutating: UnsafeRawPointer(bitPattern: exportData.id.hashValue)) | ||
| cArray.release = {data in | ||
| var arrayData = data?.pointee | ||
| let exportId = Int(bitPattern: arrayData?.private_data) | ||
| if let exportData = ArrowCExporter.exportedData[exportId] { | ||
| exportData.release() | ||
| } | ||
| arrayData?.release = nil | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| // 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 Foundation | ||
| import ArrowC | ||
|
|
||
| public class ArrowCImporter { | ||
| private func appendToBuffer( | ||
| _ cBuffer: UnsafeRawPointer?, | ||
| arrowBuffers: inout [ArrowBuffer], | ||
| byteCount: Int, | ||
| length: UInt, | ||
| nullCount: UInt? = nil) { | ||
| if cBuffer == nil { | ||
| arrowBuffers.append(ArrowBuffer.createEmptyBuffer()) | ||
| return | ||
| } | ||
|
|
||
| let pointer = UnsafeMutableRawPointer(mutating: cBuffer)! | ||
| arrowBuffers.append( | ||
| ArrowBuffer(length: length, capacity: UInt(byteCount), rawPointer: pointer, isMemoryOwner: false)) | ||
| } | ||
|
|
||
| public init() {} | ||
|
|
||
| public func importType(_ cArrow: String, name: String = "") -> | ||
| Result<ArrowField, ArrowError> { | ||
| do { | ||
| let type = try ArrowType.fromCDataFormatId(cArrow) | ||
| return .success(ArrowField(name, type: ArrowType(type.info), isNullable: true)) | ||
| } catch { | ||
| return .failure(.invalid("\(error)")) | ||
| } | ||
| } | ||
|
|
||
| public func importField(_ cSchema: ArrowC.ArrowSchema) -> | ||
| Result<ArrowField, ArrowError> { | ||
| if cSchema.n_children > 0 { | ||
| return .failure(.invalid("Children currently not supported")) | ||
| } else if cSchema.dictionary != nil { | ||
| return .failure(.invalid("Dictinoary types currently not supported")) | ||
| } | ||
|
|
||
| switch importType( | ||
| String(cString: cSchema.format), name: String(cString: cSchema.name)) { | ||
| case .success(let field): | ||
| release(cSchema) | ||
| return .success(field) | ||
| case .failure(let err): | ||
| return .failure(err) | ||
| } | ||
| } | ||
|
|
||
| public func importArray( | ||
| _ cArray: ArrowC.ArrowArray, | ||
| arrowType: ArrowType, | ||
| isNullable: Bool = false) -> Result<ArrowArrayHolder, ArrowError> { | ||
| let arrowField = ArrowField("", type: arrowType, isNullable: isNullable) | ||
| return importArray(cArray, arrowField: arrowField) | ||
| } | ||
|
|
||
| public func importArray( | ||
| _ cArray: ArrowC.ArrowArray, | ||
| arrowField: ArrowField) -> Result<ArrowArrayHolder, ArrowError> { | ||
| if cArray.null_count < 0 { | ||
| return .failure(.invalid("Uncomputed null count is not supported")) | ||
| } else if cArray.n_children > 0 { | ||
| return .failure(.invalid("Children currently not supported")) | ||
| } else if cArray.dictionary != nil { | ||
| return .failure(.invalid("Dictionary types currently not supported")) | ||
| } else if cArray.offset != 0 { | ||
| return .failure(.invalid("Offset of 0 is required but found offset: \(cArray.offset)")) | ||
| } | ||
|
|
||
| let arrowType = arrowField.type | ||
| let length = UInt(cArray.length) | ||
| let nullCount = UInt(cArray.null_count) | ||
| let nullBytes = Int(ceil(Double(length) / 8)) | ||
| var arrowBuffers = [ArrowBuffer]() | ||
|
|
||
| if cArray.n_buffers > 0 { | ||
| if cArray.buffers == nil { | ||
| return .failure(.invalid("C array buffers is nil")) | ||
| } | ||
|
|
||
| switch arrowType.info { | ||
| case .variableInfo: | ||
| if cArray.n_buffers != 3 { | ||
| return .failure( | ||
| .invalid("Variable buffer count expected 3 but found \(cArray.n_buffers)")) | ||
| } | ||
|
|
||
| appendToBuffer(cArray.buffers[0], arrowBuffers: &arrowBuffers, byteCount: nullBytes, length: length, | ||
| nullCount: nullCount) | ||
| let byteCount = MemoryLayout<Int32>.stride * Int(length) | ||
| appendToBuffer(cArray.buffers[1], arrowBuffers: &arrowBuffers, byteCount: byteCount, length: length) | ||
| let offsetIndex = MemoryLayout<Int32>.stride * Int(length - 1) | ||
| let endIndex = arrowBuffers[1].rawPointer.advanced(by: offsetIndex).load(as: Int32.self) | ||
| appendToBuffer(cArray.buffers[2], arrowBuffers: &arrowBuffers, byteCount: Int(endIndex), length: length) | ||
| default: | ||
| if cArray.n_buffers != 2 { | ||
| return .failure(.invalid("Expected buffer count 2 but found \(cArray.n_buffers)")) | ||
| } | ||
|
|
||
| appendToBuffer(cArray.buffers[0], arrowBuffers: &arrowBuffers, byteCount: nullBytes, length: length, | ||
| nullCount: nullCount) | ||
| let byteCount = arrowType.getStride() * Int(length) | ||
| appendToBuffer(cArray.buffers[1], arrowBuffers: &arrowBuffers, byteCount: byteCount, length: length) | ||
| } | ||
| } | ||
|
|
||
| return makeArrayHolder(arrowField, buffers: arrowBuffers, nullCount: nullCount) | ||
| } | ||
|
|
||
| public func release(_ cArray: ArrowC.ArrowArray) { | ||
| if cArray.release != nil { | ||
| let cArrayPtr = UnsafeMutablePointer<ArrowC.ArrowArray>.allocate(capacity: 1) | ||
| cArrayPtr.initialize(to: cArray) | ||
| cArray.release(cArrayPtr) | ||
| } | ||
| } | ||
|
|
||
| public func release(_ cSchema: ArrowC.ArrowSchema) { | ||
| if cSchema.release != nil { | ||
| let cSchemaPtr = UnsafeMutablePointer<ArrowC.ArrowSchema>.allocate(capacity: 1) | ||
| cSchemaPtr.initialize(to: cSchema) | ||
| cSchema.release(cSchemaPtr) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.