wjones127 commented on code in PR #34133: URL: https://github.com/apache/arrow/pull/34133#discussion_r1123511088
########## csharp/src/Apache.Arrow/C/CArrowSchema.cs: ########## @@ -0,0 +1,584 @@ +// 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. + +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Runtime.InteropServices; +using Apache.Arrow.Types; + +[UnmanagedFunctionPointer(CallingConvention.StdCall)] +public delegate void ReleaseCArrowSchema(IntPtr schema); + +namespace Apache.Arrow.C +{ + /// <summary> + /// An Arrow C Data Interface Schema, which represents a type, field, or schema. + /// </summary> + /// + /// <remarks> + /// This is used to export <see cref="ArrowType"/>, <see cref="Field"/>, or + /// <see cref="Schema"/> to other languages. It matches the layout of the + /// ArrowSchema struct described in https://github.com/apache/arrow/blob/main/cpp/src/arrow/c/abi.h. + /// </remarks> + [StructLayout(LayoutKind.Sequential)] + public struct CArrowSchema + { + public IntPtr format; + public IntPtr name; + public IntPtr metadata; + public long flags; + public long n_children; + public IntPtr children; + public IntPtr dictionary; + [MarshalAs(UnmanagedType.FunctionPtr)] + public ReleaseCArrowSchema release; + public IntPtr private_data; + + private static string GetFormat(IArrowType datatype) + { + TypeFormatter formatter = new TypeFormatter(); + datatype.Accept(formatter); + return formatter.FormatString; + } + + private static long GetFlags(IArrowType datatype, bool nullable = true) + { + long flags = 0; + + if (nullable) + { + flags |= ArrowFlagNullable; + } + + if (datatype is DictionaryType dictionaryType) + { + if (dictionaryType.Ordered) + { + flags |= ArrowFlagDictionaryOrdered; + } + } + + // TODO: when we implement MapType, make sure to set the KEYS_SORTED flag. + return flags; + } + + private static IntPtr ConstructChildren(IArrowType datatype, out long numChildren) + { + if (datatype is NestedType nestedType) + { + IReadOnlyList<Field> fields = nestedType.Fields; + int numFields = fields.Count; + numChildren = numFields; + + unsafe + { + IntPtr* pointerList = (IntPtr*)Marshal.AllocHGlobal(numFields * IntPtr.Size); + + for (var i = 0; i < numChildren; i++) + { + var cSchema = new CArrowSchema(fields[i]); + IntPtr exportedSchema = cSchema.AllocateAsPtr(); + pointerList[i] = exportedSchema; + } + + return (IntPtr)pointerList; + } + + } + else + { + numChildren = 0; + return IntPtr.Zero; + } + } + + private IntPtr GetChild(int i) + { + if (i >= n_children) + { + throw new Exception("Child index out of bounds."); + } + if (children == IntPtr.Zero) + { + throw new Exception("Children array is null."); + } + unsafe + { + return ((IntPtr*)children)[i]; + } + } + + private static IntPtr ConstructDictionary(IArrowType datatype) + { + if (datatype is DictionaryType dictType) + { + var cSchema = new CArrowSchema(dictType.ValueType); + return cSchema.AllocateAsPtr(); + } + else + { + return IntPtr.Zero; + } + } + + /// <summary> + /// Initialize the exported C schema as an Arrow type. + /// </summary> + /// <param name="datatype">The Arrow type to export.</param> + public CArrowSchema(IArrowType datatype) + { + format = StringUtil.ToCStringUtf8(GetFormat(datatype)); + name = IntPtr.Zero; + metadata = IntPtr.Zero; + flags = GetFlags(datatype); + + children = ConstructChildren(datatype, out var numChildren); + n_children = numChildren; + + dictionary = ConstructDictionary(datatype); + + release = (IntPtr self) => + { + var schema = Marshal.PtrToStructure<CArrowSchema>(self); + + Marshal.FreeHGlobal(schema.format); + Marshal.FreeHGlobal(schema.name); + Marshal.FreeHGlobal(schema.metadata); + + if (schema.n_children > 0) + { + for (int i = 0; i < schema.n_children; i++) + { + FreePtr(schema.GetChild(i)); + } + Marshal.FreeHGlobal((IntPtr)schema.children); + } + + if (schema.dictionary != IntPtr.Zero) + { + FreePtr(schema.dictionary); + } + Marshal.DestroyStructure<CArrowSchema>(self); + }; + + private_data = IntPtr.Zero; + } + + /// <summary> + /// Initialize the exported C schema as a field. + /// </summary> + /// <param name="field">Field to export.</param> + public CArrowSchema(Field field) : this(field.DataType) + { + name = StringUtil.ToCStringUtf8(field.Name); + // TODO: field metadata + metadata = IntPtr.Zero; + flags = GetFlags(field.DataType, field.IsNullable); + } + + /// <summary> + /// Initialize the exported C schema as a schema. + /// </summary> + /// <param name="schema">Schema to export.</param> + public CArrowSchema(Schema schema) : this(new StructType(schema.Fields.Values.ToList())) + { + // TODO: top-level metadata + } + + /// <summary> + /// Allocate an unmanaged pointer and copy this instances data to it. + /// </summary> + /// <remarks> + /// To avoid a memory leak, you must call <see cref="FreePtr"/> on this + /// pointer when done using it. + /// </remarks> + public IntPtr AllocateAsPtr() + { + IntPtr ptr = Marshal.AllocHGlobal(Marshal.SizeOf(this)); + Marshal.StructureToPtr<CArrowSchema>(this, ptr, false); + return ptr; + } + + /// <summary> + /// Free a pointer that was allocated in <see cref="AllocateAsPtr"/>. + /// </summary> + /// <remarks> + /// Do not call this on a pointer that was allocated elsewhere. + /// </remarks> + public static void FreePtr(IntPtr ptr) + { + var schema = Marshal.PtrToStructure<CArrowSchema>(ptr); + if (schema.release != null) + { + // Call release if not already called. + schema.release(ptr); + } + Marshal.FreeHGlobal(ptr); + } + + /// <summary> + /// Export to an existing pointer + /// </summary> + /// <param name="ptr">An allocated but uninitialized pointer.</param> + public void Export(IntPtr ptr) + { + Marshal.StructureToPtr<CArrowSchema>(this, ptr, false); + } + + /// <summary> + /// Allocated a new pointer to an uninitialized CArrowSchema. + /// </summary> + /// <remarks>This is used to import schemas. See <see cref="ImportType"/>, + /// <see cref="ImportField"/>, and <see cref="ImportSchema"/>. Once data + /// is imported, this pointer must be cleaned up with <see cref="FreePtr"/>. + /// </remarks> + public static IntPtr AllocateUninitialized() + { + return Marshal.AllocHGlobal(Marshal.SizeOf<CArrowSchema>()); + } + + /// <summary> + /// Import C pointer as an <see cref="ArrowType"/>. + /// </summary> + /// <examples> + /// Typically, you will allocate a uninitialized CArrowSchema pointer, + /// pass that to external function, and then use this method to import + /// the result. + /// + /// <code> + /// IntPtr importedPtr = CArrowSchema.AllocateUninitialized(); + /// foreign_export_function(importedPtr); + /// ArrowType importedType = CArrowSchema.ImportType(importedPtr); + /// CArrowSchema.FreePtr(importedPtr); + /// </code> + /// </examples> + public static ArrowType ImportType(IntPtr ptr) + { + using var importedType = new ImportedArrowSchema(ptr); + return importedType.GetAsType(); + } + + /// <summary> + /// Import C pointer as an <see cref="Field"/>. + /// </summary> + /// <examples> + /// Typically, you will allocate a uninitialized CArrowSchema pointer, + /// pass that to external function, and then use this method to import + /// the result. + /// + /// <code> + /// IntPtr importedPtr = CArrowSchema.AllocateUninitialized(); + /// foreign_export_function(importedPtr); + /// Field importedField = CArrowSchema.ImportField(importedPtr); + /// CArrowSchema.FreePtr(importedPtr); + /// </code> + /// </examples> + public static Field ImportField(IntPtr ptr) + { + using var importedField = new ImportedArrowSchema(ptr); + return importedField.GetAsField(); + } + + /// <summary> + /// Import C pointer as an <see cref="Schema"/>. + /// </summary> + /// <examples> + /// Typically, you will allocate a uninitialized CArrowSchema pointer, + /// pass that to external function, and then use this method to import + /// the result. + /// + /// <code> + /// IntPtr importedPtr = CArrowSchema.AllocateUninitialized(); + /// foreign_export_function(importedPtr); + /// Field importedSchema = CArrowSchema.ImportSchema(importedPtr); + /// CArrowSchema.FreePtr(importedPtr); + /// </code> + /// </examples> + public static Schema ImportSchema(IntPtr ptr) + { + using var importedSchema = new ImportedArrowSchema(ptr); + return importedSchema.GetAsSchema(); + } + + public const int ArrowFlagDictionaryOrdered = 1; + public const int ArrowFlagNullable = 2; + public const int ArrowFlagMapKeysSorted = 4; + + private class TypeFormatter : + IArrowTypeVisitor<NullType>, + IArrowTypeVisitor<BooleanType>, + IArrowTypeVisitor<Int8Type>, + IArrowTypeVisitor<Int16Type>, + IArrowTypeVisitor<Int32Type>, + IArrowTypeVisitor<Int64Type>, + IArrowTypeVisitor<UInt8Type>, + IArrowTypeVisitor<UInt16Type>, + IArrowTypeVisitor<UInt32Type>, + IArrowTypeVisitor<UInt64Type>, + IArrowTypeVisitor<HalfFloatType>, + IArrowTypeVisitor<FloatType>, + IArrowTypeVisitor<DoubleType>, + IArrowTypeVisitor<Decimal128Type>, + IArrowTypeVisitor<Decimal256Type>, + IArrowTypeVisitor<Date32Type>, + IArrowTypeVisitor<Date64Type>, + IArrowTypeVisitor<Time32Type>, + IArrowTypeVisitor<Time64Type>, + IArrowTypeVisitor<TimestampType>, + IArrowTypeVisitor<StringType>, + IArrowTypeVisitor<BinaryType>, + IArrowTypeVisitor<FixedSizeBinaryType>, + IArrowTypeVisitor<ListType>, + IArrowTypeVisitor<StructType>, + IArrowTypeVisitor<DictionaryType> + { + public string FormatString; + public void Visit(NullType _) => FormatString = "n"; + public void Visit(BooleanType _) => FormatString = "b"; + // Integers + public void Visit(Int8Type _) => FormatString = "c"; + public void Visit(UInt8Type _) => FormatString = "C"; + public void Visit(Int16Type _) => FormatString = "s"; + public void Visit(UInt16Type _) => FormatString = "S"; + public void Visit(Int32Type _) => FormatString = "i"; + public void Visit(UInt32Type _) => FormatString = "I"; + public void Visit(Int64Type _) => FormatString = "l"; + public void Visit(UInt64Type _) => FormatString = "L"; + // Floats + public void Visit(HalfFloatType _) => FormatString = "e"; + public void Visit(FloatType _) => FormatString = "f"; + public void Visit(DoubleType _) => FormatString = "g"; + // Binary + public void Visit(BinaryType _) => FormatString = "z"; + public void Visit(StringType _) => FormatString = "u"; + public void Visit(FixedSizeBinaryType datatype) + { + FormatString = $"w:{datatype.ByteWidth}"; + } + // Decimal + public void Visit(Decimal128Type datatype) + { + FormatString = $"d:{datatype.Precision},{datatype.Scale}"; + } + public void Visit(Decimal256Type datatype) + { + FormatString = $"w:{datatype.Precision},{datatype.Scale},256"; Review Comment: Thanks for catching this. Reminds me I meant to test decimals and timestamps. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
