"multiprocessing.shared_memory" --- Memória compartilhada para acesso direto entre processos
********************************************************************************************

**Código-fonte:** Lib/multiprocessing/shared_memory.py

Novo na versão 3.8.

======================================================================

Este módulo fornece uma classe, "SharedMemory", para a alocação e
gerenciamento da memória compartilhada a ser acessada por um ou mais
processos em uma máquina multicore ou de multiprocessamento simétrico
(SMP). Para ajudar com o gerenciamento do ciclo de vida da memória
compartilhada especialmente entre processos distintos, uma subclasse
de "BaseManager", "SharedMemoryManager", também é fornecida no módulo
"multiprocessing.managers".

Neste módulo, memória compartilhada refere-se a blocos de memória
compartilhada no "estilo POSIX" (embora não seja necessariamente
implementado explicitamente como tal) e não se refere a "memória
compartilhada distribuída". Este estilo de memória compartilhada
permite que processos distintos potencialmente leiam e escrevam em uma
região comum (ou compartilhada) de memória volátil. Os processos são
convencionalmente limitados a ter acesso somente ao próprio espaço de
memória de processo mas a memória compartilhada permite o
compartilhamento de dados entre processos, evitando a necessidade de
enviar mensagens entre processos contendo estes dados. Compartilhar
dados diretamente via memória pode fornecer ganhos de desempenho
significativos comparado ao compartilhamento de dados via disco ou
soquete ou outras comunicações que requerem a
serialização/desserialização e cópia dos dados.

class multiprocessing.shared_memory.SharedMemory(name=None, create=False, size=0)

   Cria uma instância da classe "SharedMemory" para criar um novo
   bloco de memória compartilhada ou anexar a um bloco de memória
   compartilhada existente. A cada bloco de memória compartilhada é
   atribuído um nome único. Desta forma, um processo pode criar um
   bloco de memória compartilhada com um nome particular e um processo
   diferente pode ser anexado a esse mesmo bloco de memória
   compartilhada usando este mesmo nome.

   Como um recurso para compartilhar dados entre processos, os blocos
   de memória compartilhada podem sobreviver ao processo original que
   os criou. Quando um processo não precisa mais acessar um bloco de
   memória compartilhada que ainda pode ser necessário para outros
   processos, o método "close()" deve ser chamado. Quando um bloco de
   memória compartilhada não é mais necessário para nenhum processo, o
   método "unlink()" deve ser chamado para garantir a limpeza
   apropriada.

   Parâmetros:
      * **name** (*str** | **None*) -- O nome único para a memória
        compartilhada requisitada, especificado como uma string. Ao
        criar um novo bloco de memória compartilhada, se "None" (o
        padrão) é fornecido para o nome, um novo nome será gerado.

      * **create** (*bool*) -- Controla quando um novo bloco de
        memória compartilhada é criado ("True") ou um bloco de memória
        compartilhada existente é anexado ("False").

      * **size** (*int*) -- O número de bytes requeridos ao criar um
        novo bloco de memória compartilhada. Como algumas plataformas
        optam por alocar pedaços de memória com base no tamanho da
        página de memória da própria plataforma, o tamanho exato do
        bloco de memória compartilhada pode ser maior ou igual ao
        tamanho requerido. Ao anexar a um bloco de memória
        compartilhada existente, o parâmetro *size* é ignorado.

   close()

      Close access to the shared memory from this instance.  In order
      to ensure proper cleanup of resources, all instances should call
      "close()" once the instance is no longer needed.  Note that
      calling "close()" does not cause the shared memory block itself
      to be destroyed.

   unlink()

      Request that the underlying shared memory block be destroyed.
      In order to ensure proper cleanup of resources, "unlink()"
      should be called once (and only once) across all processes which
      have need for the shared memory block.  After requesting its
      destruction, a shared memory block may or may not be immediately
      destroyed and this behavior may differ across platforms.
      Attempts to access data inside the shared memory block after
      "unlink()" has been called may result in memory access errors.
      Note: the last process relinquishing its hold on a shared memory
      block may call "unlink()" and "close()" in either order.

   buf

      Uma visualização de memória do conteúdo do bloco de memória
      compartilhada.

   name

      Acesso somente leitura ao nome único do bloco de memória
      compartilhada.

   size

      Acesso somente leitura ao tamanho em bytes do bloco de memória
      compartilhada.

O exemplo a seguir demonstra um uso baixo nível de instâncias de
"SharedMemory":

   >>> from multiprocessing import shared_memory
   >>> shm_a = shared_memory.SharedMemory(create=True, size=10)
   >>> type(shm_a.buf)
   <class 'memoryview'>
   >>> buffer = shm_a.buf
   >>> len(buffer)
   10
   >>> buffer[:4] = bytearray([22, 33, 44, 55])  # Modify multiple at once
   >>> buffer[4] = 100                           # Modify single byte at a time
   >>> # Attach to an existing shared memory block
   >>> shm_b = shared_memory.SharedMemory(shm_a.name)
   >>> import array
   >>> array.array('b', shm_b.buf[:5])  # Copy the data into a new array.array
   array('b', [22, 33, 44, 55, 100])
   >>> shm_b.buf[:5] = b'howdy'  # Modify via shm_b using bytes
   >>> bytes(shm_a.buf[:5])      # Access via shm_a
   b'howdy'
   >>> shm_b.close()   # Close each SharedMemory instance
   >>> shm_a.close()
   >>> shm_a.unlink()  # Call unlink only once to release the shared memory

O exemplo a seguir demonstra um uso prático da classe "SharedMemory"
com arrays do NumPy, acessando o mesmo "numpy.ndarray" de dois
consoles Python distintos.

   >>> # In the first Python interactive shell
   >>> import numpy as np
   >>> a = np.array([1, 1, 2, 3, 5, 8])  # Start with an existing NumPy array
   >>> from multiprocessing import shared_memory
   >>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes)
   >>> # Now create a NumPy array backed by shared memory
   >>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf)
   >>> b[:] = a[:]  # Copy the original data into shared memory
   >>> b
   array([1, 1, 2, 3, 5, 8])
   >>> type(b)
   <class 'numpy.ndarray'>
   >>> type(a)
   <class 'numpy.ndarray'>
   >>> shm.name  # We did not specify a name so one was chosen for us
   'psm_21467_46075'

   >>> # In either the same shell or a new Python shell on the same machine
   >>> import numpy as np
   >>> from multiprocessing import shared_memory
   >>> # Attach to the existing shared memory block
   >>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075')
   >>> # Note that a.shape is (6,) and a.dtype is np.int64 in this example
   >>> c = np.ndarray((6,), dtype=np.int64, buffer=existing_shm.buf)
   >>> c
   array([1, 1, 2, 3, 5, 8])
   >>> c[-1] = 888
   >>> c
   array([  1,   1,   2,   3,   5, 888])

   >>> # Back in the first Python interactive shell, b reflects this change
   >>> b
   array([  1,   1,   2,   3,   5, 888])

   >>> # Clean up from within the second Python shell
   >>> del c  # Unnecessary; merely emphasizing the array is no longer used
   >>> existing_shm.close()

   >>> # Clean up from within the first Python shell
   >>> del b  # Unnecessary; merely emphasizing the array is no longer used
   >>> shm.close()
   >>> shm.unlink()  # Free and release the shared memory block at the very end

class multiprocessing.managers.SharedMemoryManager([address[, authkey]])

   Uma subclasse de "multiprocessing.managers.BaseManager" que pode
   ser usada para o gerenciamento dos blocos de memória compartilhada
   entre processos.

   Uma chamada ao método "start()" em uma instância de
   "SharedMemoryManager" faz com que um novo processo seja iniciado. A
   única finalidade desse novo processo é gerenciar o ciclo de vida de
   todos os blocos de memória criados através dele. Para acionar a
   liberação de todos os blocos de memória gerenciados por este
   processo, invoque o método "shutdown()" na instância. Isso aciona
   uma chamada de "unlink()" em todos os objetos "SharedMemory"
   gerenciados por esse processo e então para o processo em si. Ao
   criar instâncias de "SharedMemory" através de um
   "SharedMemoryManager", evitamos a necessidade de rastrear e acionar
   manualmente a liberação dos recursos de memória compartilhada.

   Esta classe fornece métodos para criar e retornar instâncias de
   "SharedMemory" e para criar um objeto lista ou similar
   ("ShareableList") apoiado por memória compartilhada.

   Consulte "BaseManager" para obter uma descrição dos argumentos de
   entrada opcionais herdados *address* e *authkey* e como eles podem
   ser usados para conectar-se a um serviço "SharedMemoryManager"
   existente de outros processos.

   SharedMemory(size)

      Cria e retorna um novo objeto "SharedMemory" com o *size*
      especificado em bytes.

   ShareableList(sequence)

      Cria e retorna um novo objeto "ShareableList", inicializado
      pelos valores da entrada *sequence*.

O exemplo a seguir demonstra os mecanismos básicos de um
"SharedMemoryManager":

   >>> from multiprocessing.managers import SharedMemoryManager
   >>> smm = SharedMemoryManager()
   >>> smm.start()  # Start the process that manages the shared memory blocks
   >>> sl = smm.ShareableList(range(4))
   >>> sl
   ShareableList([0, 1, 2, 3], name='psm_6572_7512')
   >>> raw_shm = smm.SharedMemory(size=128)
   >>> another_sl = smm.ShareableList('alpha')
   >>> another_sl
   ShareableList(['a', 'l', 'p', 'h', 'a'], name='psm_6572_12221')
   >>> smm.shutdown()  # Calls unlink() on sl, raw_shm, and another_sl

O exemplo a seguir retrata um padrão potencialmente mais conveniente
para usar objetos "SharedMemoryManager" através da instrução "with"
para garantir que todos os blocos de memória compartilhada são
liberados depois que não são mais necessários.

   >>> with SharedMemoryManager() as smm:
   ...     sl = smm.ShareableList(range(2000))
   ...     # Divide the work among two processes, storing partial results in sl
   ...     p1 = Process(target=do_work, args=(sl, 0, 1000))
   ...     p2 = Process(target=do_work, args=(sl, 1000, 2000))
   ...     p1.start()
   ...     p2.start()  # A multiprocessing.Pool might be more efficient
   ...     p1.join()
   ...     p2.join()   # Wait for all work to complete in both processes
   ...     total_result = sum(sl)  # Consolidate the partial results now in sl

Ao usar um "SharedMemoryManager" em uma instrução "with", os blocos de
memória compartilhada criados utilizando este gerenciador são todos
liberados quando o bloco de código com a instrução "with" termina sua
execução.

class multiprocessing.shared_memory.ShareableList(sequence=None, *, name=None)

   Fornece um objeto mutável do tipo lista onde todos os valores
   armazenados dentro são armazenados em um bloco de memória
   compartilhada. Isso restringe valores armazenáveis aos seguintes
   tipos de dados embutidos:

   * "int" (com sinal, 64-bit)

   * "float"

   * "bool"

   * "str" (menos de 10M bytes cada quando codificado como UTF-8)

   * "bytes" (menos de 10M bytes cada)

   * "None"

   Ele também difere notavelmente do tipo embutido "list", pois essas
   listas não podem alterar seu comprimento geral (ou seja, sem
   "append()", "insert()", etc.) e não oferecem suporte à criação
   dinâmica de novas instâncias "ShareableList" por meio de
   fatiamento.

   *sequence* é usado para preencher um "ShareableList" com valores.
   Defina como "None" para anexar a uma "ShareableList" já existente
   pelo seu nome único de memória compartilhada.

   *name* é um nome único para a memória compartilhada requerida, como
   descrito na definição de "SharedMemory". Ao anexar a uma
   "ShareableList" já existente, deve-se especificar o nome único do
   bloco de memória compartilhada e definir *sequence* como "None".

   Nota:

     Existe um problema conhecido para os valores "bytes" e "str". Se
     eles terminarem com bytes ou caracteres nulos "\x00", eles podem
     ser *silenciosamente removidos* ao buscá-los pelo índice da
     "ShareableList". Esse comportamento ".rstrip(b'\x00')" é
     considerado um bug e pode desaparecer no futuro. Veja gh-106939.

   Para aplicações onde a remoção de nulos finais é um problema,
   contorne-o sempre anexando incondicionalmente um byte extra
   diferente de 0 ao final de tais valores ao armazená-los e
   removendo-os incondicionalmente ao buscá-los:

      >>> from multiprocessing import shared_memory
      >>> nul_bug_demo = shared_memory.ShareableList(['?\x00', b'\x03\x02\x01\x00\x00\x00'])
      >>> nul_bug_demo[0]
      '?'
      >>> nul_bug_demo[1]
      b'\x03\x02\x01'
      >>> nul_bug_demo.shm.unlink()
      >>> padded = shared_memory.ShareableList(['?\x00\x07', b'\x03\x02\x01\x00\x00\x00\x07'])
      >>> padded[0][:-1]
      '?\x00'
      >>> padded[1][:-1]
      b'\x03\x02\x01\x00\x00\x00'
      >>> padded.shm.unlink()

   count(value)

      Retorna o número de ocorrências de *value*.

   index(value)

      Retorna a primeira posição do índice de *value*. Levanta
      "ValueError" se *value* não estiver presente.

   format

      Atributo somente leitura contendo o formato de empacotamento
      "struct" usado por todos os valores armazenados atualmente.

   shm

      A instância de "SharedMemory" onde os valores são armazenados.

O exemplo a seguir demonstra o uso básico de uma instância de
"ShareableList":

>>> from multiprocessing import shared_memory
>>> a = shared_memory.ShareableList(['howdy', b'HoWdY', -273.154, 100, None, True, 42])
>>> [ type(entry) for entry in a ]
[<class 'str'>, <class 'bytes'>, <class 'float'>, <class 'int'>, <class 'NoneType'>, <class 'bool'>, <class 'int'>]
>>> a[2]
-273.154
>>> a[2] = -78.5
>>> a[2]
-78.5
>>> a[2] = 'dry ice'  # Changing data types is supported as well
>>> a[2]
'dry ice'
>>> a[2] = 'larger than previously allocated storage space'
Traceback (most recent call last):
  ...
ValueError: exceeds available storage for existing str
>>> a[2]
'dry ice'
>>> len(a)
7
>>> a.index(42)
6
>>> a.count(b'howdy')
0
>>> a.count(b'HoWdY')
1
>>> a.shm.close()
>>> a.shm.unlink()
>>> del a  # Use of a ShareableList after call to unlink() is unsupported

O exemplo a seguir retrata como um, dois ou mais processos podem
acessar a mesma "ShareableList" fornecendo o nome do bloco de memória
compartilhada por trás dela:

>>> b = shared_memory.ShareableList(range(5))         # In a first process
>>> c = shared_memory.ShareableList(name=b.shm.name)  # In a second process
>>> c
ShareableList([0, 1, 2, 3, 4], name='...')
>>> c[-1] = -999
>>> b[-1]
-999
>>> b.shm.close()
>>> c.shm.close()
>>> c.shm.unlink()

Os exemplos a seguir demonstram que os objetos  "ShareableList" (e o
subjacente "SharedMemory") podem ser serializados e desserializados
com pickle, se preciso. Note, ainda será o mesmo objeto compartilhado.
Isto acontece pois o objeto desserializado tem o mesmo nome único e é
somente anexado ao objeto existente com o mesmo nome (se o objeto
ainda existe):

>>> import pickle
>>> from multiprocessing import shared_memory
>>> sl = shared_memory.ShareableList(range(10))
>>> list(sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

>>> deserialized_sl = pickle.loads(pickle.dumps(sl))
>>> list(deserialized_sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

>>> sl[0] = -1
>>> deserialized_sl[1] = -2
>>> list(sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]
>>> list(deserialized_sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]

>>> sl.shm.close()
>>> sl.shm.unlink()
