Darwinism/Parallel/MemoryMap/MapObject.vb

#Region "Microsoft.VisualBasic::1d940df528f4ea805c224c1e14fe7d99, Parallel\MemoryMap\MapObject.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:

    ' Class MapObject
    ' 
    '     Constructor: (+1 Overloads) Sub New
    ' 
    '     Function: FromObject, FromPointer, GetObject
    ' 
    '     Sub: (+2 Overloads) Dispose
    ' 
    ' /********************************************************************************/

#End Region

Imports System.IO
Imports System.IO.MemoryMappedFiles
Imports System.Runtime.CompilerServices
Imports System.Runtime.InteropServices
Imports Microsoft.VisualBasic.MIME.application.json
Imports Microsoft.VisualBasic.MIME.application.json.BSON

''' <summary>
''' 只能够在进程之间映射一个不大于2GB的对象
''' </summary>
Public Class MapObject : Implements IDisposable

    Private disposedValue As Boolean

    Dim hMem As String
    Dim size As Integer

    Public ReadOnly Property Invalid As Boolean
        Get
            Return Not (size > 0 AndAlso Not hMem.StringEmpty)
        End Get
    End Property

    Private Sub New()
    End Sub

    <MethodImpl(MethodImplOptions.AggressiveInlining)>
    Public Function GetMappingFileName() As String
        Return hMem
    End Function

    ''' <summary>
    ''' load object from the memory region by a specific type schema
    ''' </summary>
    ''' <param name="type"></param>
    ''' <returns></returns>
    Public Function GetObject(type As Type) As Object
        Dim obj As Object
        Dim memory As MemoryMappedFile = MemoryMappedFile.OpenExisting(hMem)
        Dim view As MemoryMappedViewStream = memory.CreateViewStream

        obj = BSONFormat.Load(view).CreateObject(type, decodeMetachar:=False)

        Return obj
    End Function

    Public Shared Function FromPointer(mem As UnmanageMemoryRegion) As MapObject
        Return New MapObject With {
            .hMem = mem.memoryFile,
            .size = mem.size
        }
    End Function

    Public Shared Function Exists(hMem As String) As Boolean
        Try
            Call MemoryMappedFile.OpenExisting(hMem)
            Return True
        Catch ex As Exception
            Return False
        End Try
    End Function

    ''' <summary>
    ''' serialize object in BSON to a memory region 
    ''' </summary>
    ''' <param name="obj"></param>
    ''' <returns></returns>
    Public Shared Function FromObject(obj As Object, Optional hMemP As String = Nothing) As MapObject
        Dim type As Type = obj.GetType
        Dim element = type.GetJsonElement(obj, New JSONSerializerOptions)
        Dim bufferSize As Integer
        Dim hMem As String = If(hMemP.StringEmpty, App.GetNextUniqueName($"mem_{type.Name}_"), hMemP)

        Static mapFiles As New Dictionary(Of String, MemoryMappedFile)

        Using ms As MemoryStream = BSONFormat.SafeGetBuffer(element)
            Dim buffer As Byte() = ms.ToArray

            bufferSize = buffer.Length

            ' 20210115 MemoryMappedFile.CreateNew not working on unix .net 5
            Dim hMemFile As MemoryMappedFile = MemoryMappedFile.CreateNew(hMem, bufferSize)
            Dim view As MemoryMappedViewStream = hMemFile.CreateViewStream

            SyncLock mapFiles
                Call mapFiles.Add(hMem, hMemFile)
            End SyncLock

            Call view.Write(buffer, Scan0, bufferSize)

            Erase buffer
        End Using

        Return New MapObject With {
            .hMem = hMem,
            .size = bufferSize
        }
    End Function

    Protected Overridable Sub Dispose(disposing As Boolean)
        If Not disposedValue Then
            If disposing Then
                ' TODO: 释放托管状态(托管对象)
                Marshal.FreeHGlobal(hMem)
            End If

            ' TODO: 释放未托管的资源(未托管的对象)并替代终结器
            ' TODO: 将大型字段设置为 null
            disposedValue = True
        End If
    End Sub

    ' ' TODO: 仅当“Dispose(disposing As Boolean)”拥有用于释放未托管资源的代码时才替代终结器
    ' Protected Overrides Sub Finalize()
    '     ' 不要更改此代码。请将清理代码放入“Dispose(disposing As Boolean)”方法中
    '     Dispose(disposing:=False)
    '     MyBase.Finalize()
    ' End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        ' 不要更改此代码。请将清理代码放入“Dispose(disposing As Boolean)”方法中
        Dispose(disposing:=True)
        GC.SuppressFinalize(Me)
    End Sub

    Public Shared Narrowing Operator CType(map As MapObject) As UnmanageMemoryRegion
        Return New UnmanageMemoryRegion With {
            .memoryFile = map.hMem,
            .size = map.size
        }
    End Operator
End Class