Maneira mais segura de expor um buffer de memória alocado por C usando numpy / ctypes?

Estou escrevendo ligações Python para uma biblioteca C que usa buffers de memória compartilhada para armazenar seu estado interno. A alocação e liberação desses buffers é feita fora do Python pela própria biblioteca, mas eu posso controlar indiretamente quando isso acontece chamando as funções de construtor / destruidor de dentro do Python. Eu gostaria de expor alguns dos buffers ao Python para que eu possa ler deles e, em alguns casos, forçar valores para eles. O desempenho e o uso da memória são preocupações importantes, portanto, gostaria de evitar a cópia de dados sempre que possível.

Minha abordagem atual é criar uma matriz numpy que forneça uma visão direta sobre um ponteiro de ctypes:

import numpy as np
import ctypes as C

libc = C.CDLL('libc.so.6')

class MyWrapper(object):

    def __init__(self, n=10):
        # buffer allocated by external library
        addr = libc.malloc(C.sizeof(C.c_int) * n)
        self._cbuf = (C.c_int * n).from_address(addr)

    def __del__(self):
        # buffer freed by external library
        libc.free(C.addressof(self._cbuf))
        self._cbuf = None

    @property
    def buffer(self):
        return np.ctypeslib.as_array(self._cbuf)

Além de evitar cópias, isso também significa que posso usar a sintaxe de indexação e atribuição de numpy e passá-la diretamente para outras funções numpy:

wrap = MyWrapper()
buf = wrap.buffer       # buf is now a writeable view of a C-allocated buffer

buf[:] = np.arange(10)  # this is pretty cool!
buf[::2] += 10

print(wrap.buffer)
# [10  1 12  3 14  5 16  7 18  9]

No entanto, também é inerentemente perigoso:

del wrap                # free the pointer

print(buf)              # this is bad!
# [1852404336 1969367156  538978662  538976288  538976288  538976288
#  1752440867 1763734377 1633820787       8548]

# buf[0] = 99           # uncomment this line if you <3 segfaults

Para tornar isso mais seguro, preciso verificar se o ponteiro C subjacente foi liberado antes de tentar ler / gravar no conteúdo da matriz. Tenho alguns pensamentos sobre como fazer isso:

Uma maneira seria gerar uma subclasse denp.ndarray que contém uma referência ao_cbuf atributo deMyWrapper, verifica se éNone antes de fazer qualquer leitura / gravação na memória subjacente e gera uma exceção, se for esse o caso.Eu poderia gerar facilmente várias visualizações no mesmo buffer, por exemplo por.view fundição ou corte, para que cada um deles precise herdar a referência a_cbuf e o método que executa a verificação. Eu suspeito que isso poderia ser alcançado substituindo-o__array_finalize__, mas não sei exatamente como.O método "verificação de ponteiro" também precisará ser chamado antes de qualquer operação que leia e / ou grave no conteúdo da matriz. Não sei o suficiente sobre os elementos internos do numpy para ter uma lista exaustiva de métodos a serem substituídos.

Como eu poderia implementar uma subclasse denp.ndarray que executa essa verificação? Alguém pode sugerir uma abordagem melhor?

Atualizar: Esta classe faz a maior parte do que eu quero:

class SafeBufferView(np.ndarray):

    def __new__(cls, get_buffer, shape=None, dtype=None):
        obj = np.ctypeslib.as_array(get_buffer(), shape).view(cls)
        if dtype is not None:
            obj.dtype = dtype
        obj._get_buffer = get_buffer
        return obj

    def __array_finalize__(self, obj):
        if obj is None: return
        self._get_buffer = getattr(obj, "_get_buffer", None)

    def __array_prepare__(self, out_arr, context=None):
        if not self._get_buffer(): raise Exception("Dangling pointer!")
        return out_arr

    # this seems very heavy-handed - surely there must be a better way?
    def __getattribute__(self, name):
        if name not in ["__new__", "__array_finalize__", "__array_prepare__",
                        "__getattribute__", "_get_buffer"]:
            if not self._get_buffer(): raise Exception("Dangling pointer!")
        return super(np.ndarray, self).__getattribute__(name)

Por exemplo:

wrap = MyWrapper()
sb = SafeBufferView(lambda: wrap._cbuf)
sb[:] = np.arange(10)

print(repr(sb))
# SafeBufferView([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], dtype=int32)

print(repr(sb[::2]))
# SafeBufferView([0, 2, 4, 6, 8], dtype=int32)

sbv = sb.view(np.double)
print(repr(sbv))
# SafeBufferView([  2.12199579e-314,   6.36598737e-314,   1.06099790e-313,
#          1.48539705e-313,   1.90979621e-313])

# we have to call the destructor method of `wrap` explicitly - `del wrap` won't
# do anything because `sb` and `sbv` both hold references to `wrap`
wrap.__del__()

print(sb)                # Exception: Dangling pointer!
print(sb + 1)            # Exception: Dangling pointer!
print(sbv)               # Exception: Dangling pointer!
print(np.sum(sb))        # Exception: Dangling pointer!
print(sb.dot(sb))        # Exception: Dangling pointer!

print(np.dot(sb, sb))    # oops...
# -70104698

print(np.extract(np.ones(10), sb))
# array([251019024,     32522, 498870232,     32522,         4,         5,
#               6,         7,        48,         0], dtype=int32)

# np.copyto(sb, np.ones(10, np.int32))    # don't try this at home, kids!

Tenho certeza de que há outros casos extremos que eu perdi.

Atualização 2: Eu já brinquei comweakref.proxy, conforme sugerido por@ivan_pozdeev. É uma boa idéia, mas infelizmente não consigo ver como isso funcionaria com matrizes numpy. Eu poderia tentar criar um valor fraco para a matriz numpy retornada por.buffer:

wrap = MyWrapper()
wr = weakref.proxy(wrap.buffer)
print(wr)
# ReferenceError: weakly-referenced object no longer exists
# <weakproxy at 0x7f6fe715efc8 to NoneType at 0x91a870>

Eu acho que o problema aqui é que onp.ndarray instância retornada porwrap.buffer imediatamente sai do escopo. Uma solução alternativa seria a classe instanciar a matriz na inicialização, manter uma forte referência a ela e ter o.buffer() getter retornar umweakref.proxy para a matriz:

class MyWrapper2(object):

    def __init__(self, n=10):
        # buffer allocated by external library
        addr = libc.malloc(C.sizeof(C.c_int) * n)
        self._cbuf = (C.c_int * n).from_address(addr)
        self._buffer = np.ctypeslib.as_array(self._cbuf)

    def __del__(self):
        # buffer freed by external library
        libc.free(C.addressof(self._cbuf))
        self._cbuf = None
        self._buffer = None

    @property
    def buffer(self):
        return weakref.proxy(self._buffer)

No entanto, isso será interrompido se eu criar uma segunda exibição na mesma matriz enquanto o buffer ainda estiver alocado:

wrap2 = MyWrapper2()
buf = wrap2.buffer
buf[:] = np.arange(10)

buf2 = buf[:]   # create a second view onto the contents of buf

print(repr(buf))
# <weakproxy at 0x7fec3e709b50 to numpy.ndarray at 0x210ac80>
print(repr(buf2))
# array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], dtype=int32)

wrap2.__del__()

print(buf2[:])  # this is bad
# [1291716568    32748 1291716568    32748        0        0        0
#         0       48        0] 

print(buf[:])   # WTF?!
# [34525664        0        0        0        0        0        0        0
#         0        0]  

Isto éa sério quebrado - após ligarwrap2.__del__() não só posso ler e escrever parabuf2 que era uma exibição de matriz numpy parawrap2._cbuf, mas eu posso até ler e escrever parabuf, o que não deve ser possível, dado quewrap2.__del__() conjuntoswrap2._buffer paraNone.

questionAnswers(6)

yourAnswerToTheQuestion