Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Latest commit

 

History

History
260 lines (196 loc) · 9.28 KB

todo.md

File metadata and controls

260 lines (196 loc) · 9.28 KB
Raw

POSIX

BUGS

  • posix::Mutex

    • implement priority ceiling

  • File::read_to_string & File::read_range_to_string, check that there are no invalid UTF-8 characters contained

  • verify ACL_LIST_CAPACITY in posix_config

  • unix datagram socket, sending credentials and file descriptors no longer works

    • was introduced with rust 1.71.0
    • activate unit test below again fn unix_datagram_socket_sending_receiving_with_max_supported_fd_and_credentials_works

  • MAX_NUMBER_OF_ENTRIES in shared_memory_directory/mod.rs can lead to stack overflow when too large in unsafe { files.write(FileReferenceSet::default()) }; We require placement new!

    ptr->write(MaybeUninit<MyThing>::new());
(ptr as *mut MaybeUninit<MyThinkg>)->do_stuff_to_Initialize_yourself();

  • Better interrupt signal handling. The interrupt signal shall be always propagated up to the user for better CTRL+c handling etc.

  • condition_variable has spurious wakeups on windows since WaitOnAddress with a timeout does not really work. Remove ignore for windows from condition variable tests and fix problem.

  • CTRL+c does not work in windows, all examples do not clean up

  • Directory, Path, FileName, FilePath cannot handle UTF-8 file names

    • Directory panics when a directory contains non-ascii (UTF-8) characters

  • Windows: publisher::zero_copy::publisher_block_when_unable_to_deliver_blocks seems to sometimes deadlock

continue

  • document

    • service

  • ?is publisher history tested?

  • test all QoS of all services, also with requirements when opening

  • Write tests for Sample & SampleMut

  • Fix platforms

    • macos
      • iceoryx2_bb_posix
        • add timeout to pthread_cond_timedwait
      • use concepts based on shared memory directory to circumvent to 30 char restriction on the shm name in mac os
    • use second shm for shm size storage of main shm in windows instead of file

  • Stale services when creator goes out of scope

    • add ability to create persistent service
      • add persistency flag in static storage
    • simplify Service (zero_copy/process_local)
      • ServiceState has new/drop to check for stale services
    • when OpenDynamicStorageFailure::IsMarkedForDestruction activated then wait for some time and retry to create the service, only if open or create was used

  • Event Messaging Pattern

    • introduce degration callback for notifier, used when a connection to a listener could not be established
    • make Publisher::update_connections private

  • Rename PortFactory<...> into Service<...> and make it easier to access by the user

    • ability to store it in vec etc

  • Splitup NamedConceptBuilder into NamedConceptOpener and NamedConceptCreator

    • has_ownership only for creator
    • has_ownership/release_ownership should be part of the NamedConceptMgmt
    • introduce acquire_ownership in NamedConceptMgmt
    • make windows shm persistent first

  • Event concept

    • process_local should be based on a bitset, introduce max trigger id into event/notifier
      • implement atomic bitset, with compile time capacity, atomic set and atomic exchange consume via callback
    • ?add ability to create Listener in a different process and open it later, excludes every socket variant?

  • KeepAlive of subscriber/publisher

    • set publisher/subscriber timing contract, if violated subscriber/publisher can close connection

  • ZeroCopyConnection

    • remove blocking_send
    • the builder shall be able to either create a connection or open a sender or receiver

  • CommunicationChannel

    • remove safe_overflow support
    • ?add ability to create receiver in a different instance and open it later, excludes every socket variant?

  • rename zero_copy::Service into ipc::Service, -> ??intra_process::Service for process_local??

  • consolidate name- and config-generation functions from ipc/src/port/publisher.rs ipc/src/service/mod.rs {dynamic|static}config_storage{name|config} {connection}_{name|config}

  • Cargo.toml, add version inheritance from root workspace

  • freebsd

    • advanced signal handling - signal_call_and_fetch_with_registered_handler_works

  • windows,

    • back shm in windows with file

  • posix thread wrapper uses currently heap when creating new thread with pthread_create

    • introduce global mempool allocated on program start for this operation

  • split up UnixDatagramSocket into one with ancillary data and one without

    • add to builder if credentials shall always be sent
    • check if fd exchange with messages is supported
    • check if multiple fds can be exchanged with one message

  • check all posix wrapper that creation/open happens in the builder to avoid invalid states in objects

  • ensure non-movability via separate handle + remove is_initialized and construct in builder

    • condition variable
      • remove ipc support for multi condition variable

  • refactor error handling

    • error pyramid concept
    • extend and test fail! macro

  • ZeroCopyConnection, add builder option to enable tracking of samples from sender to receiver and back

  • add this to port factory publisher builder

    • TEST
      • remove all unwrap and test them

  • Refactor SampleMut, TypeStatePattern - only the initialized sample can be sent

    • release underlying memory manually and sent/release it manually

  • Subscriber strategies for multi publisher

    • priority?
    • timestamp?
    • random order?

  • Refactor global_config

  • RelocatableContainer test which verifies that init does not write/modify more memory then it requires according to memory_size()

  • Rename CommunicationChannel into named pipe

  • subscriber internal cache which orders samples from multiple publishers

  • iceoryx2_ipc finalize

    • remove all unwrap()
    • global_config.rs use correct string types
      • introduce file_suffix_name.rs and use it there
    • remove all string usages and replace it with semantic_string impls

  • Introduce BasePort, contains always

    • portId: UniquePortId
    • dynamic_config_guard
    • fn new(service: &Service) -> Self

  • rename things

    • with modules, every public thing should be named like the module, it will be differentiate with the namespace
      • all iceoryx2_cals

  • what if reference_counter == 0 when creating new service ... wait for cleanup

  • introduce ShmIpc trait and derive macro to add #[repr(C)] to all shm transferable types

    • Introduce typed shared memory to avoid this problem
      • use it in comm channel
    • Management in communication_channel_shm_index_queue
    • IndexQueue
    • UnnamedSemaphore
    • All the other things in posix/etc

  • Use rust singleton pattern for signal handler https://docs.rust-embedded.org/book/peripherals/singletons.html

Default Setup - without configuration & Grouping Support

  • Goal: multiple concepts share the same resources
    • ?Introduce second name in NamedConcept, the group as FileName?
  • create dynamic shared memory abstraction (below concept layer)
    • must be able to dynamically resize (grow and shrink)
    • requires sophisticated allocator that can handle arbitrary sizes
    • must be emulate some kind of file system
      • idea is that the concept can use this construct to create and open specified instances via name
  • use dynamic shared memory

Performance

  • mpmc_container, mpmc_unique_index_set, try to avoid constant verify_memory_initialization call

Important Question

  • free list approach, what happens when publisher goes out of scope before subscriber does?
  • RelocatableContainer, make this trait somehow unmovable.
  • ServiceStaticConfig, pack individual communication pattern configs into MessagingPattern
  • Performance and Safety Critical mode
    • Default clock is in performance mode Realtime
  • Revisit concept abstraction trait structure?
    • maybe: "concept_name.rs"
      • contains trait and all impls as pubs under same namespace
  • DynamicStorage

Advanced

Containers

  • FilePath/Path check that every single entry is not longer than FILENAME_LENGTH
  • Implement StackBox where the box max size is provided as generic user argument
    • use it in allocator Memory cleanup function
  • introduce string
  • introduce vector
  • introduce list
  • introduce red-black-tree
  • introduce set
  • introduce hashmap

Concurrent

  • lock-free list
    • use unique index set as base
  • introduce ThreadPool
    • introduce ActiveObject

IPC

  • posh/ipc/service
    • unique global service list file
      • new service must add entry there, on remove, remove entry

Open Problems

  • iceoryx2_config use lock free singleton approach from iceoryx2
  • remove ENAMETOOLONG and replace it with a path/filename string with maximum size
    • see unlink, does_file_exist
  • semaphore
    • implement timedwait with gnu libc sem_clockwait
  • ReadWriteMutex
    • implement timedwait with gnu libc pthread_rwlock_clockrdlock. pthread_rwlock_clockwrlock
  • Publisher delivers history only when calling send
    • new subscriber may waits a long time when send is not called