LCOV - code coverage report
Current view: top level - util/shmem - fd_shmem_user.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 109 367 29.7 %
Date: 2026-03-19 18:19:27 Functions: 8 14 57.1 %

          Line data    Source code
       1             : #if FD_HAS_HOSTED
       2             : #define _GNU_SOURCE
       3             : #endif
       4             : 
       5             : #include "fd_shmem_private.h"
       6             : 
       7             : #if FD_HAS_HOSTED
       8             : 
       9             : #include <errno.h>
      10             : #include <unistd.h>
      11             : #include <fcntl.h>
      12             : #include <sys/mman.h>
      13             : #include <sys/random.h>
      14             : 
      15             : /* fd_shmem_private_key converts the cstr pointed to by name into a
      16             :    valid key and stores it at the location pointed to by key assumed
      17             :    valid).  Returns key on success and NULL on failure (i.e. name does
      18             :    not point to a valid shmem region name).  All bytes of key will be
      19             :    unambiguously initialized so there is no issue with using things like
      20             :    memcmp to compare keys, etc. */
      21             : 
      22             : static inline fd_shmem_private_key_t *
      23             : fd_shmem_private_key( fd_shmem_private_key_t * key,
      24           1 :                       char const *             name ) {
      25           1 :   ulong len = fd_shmem_name_len( name );
      26           1 :   if( FD_UNLIKELY( !len ) ) return NULL;
      27           1 :   fd_memset( key->cstr, 0, FD_SHMEM_NAME_MAX );
      28           1 :   fd_memcpy( key->cstr, name, len );
      29           1 :   return key;
      30           1 : }
      31             : 
      32             : static fd_shmem_private_key_t const fd_shmem_private_key_null; /* Will be zeros at thread group start */
      33             : 
      34        6733 : #define FD_SHMEM_PRIVATE_MAP_LG_SLOT_CNT (8)
      35        6730 : #define FD_SHMEM_PRIVATE_MAP_SLOT_CNT    (1UL<<FD_SHMEM_PRIVATE_MAP_LG_SLOT_CNT)
      36             : FD_STATIC_ASSERT( FD_SHMEM_JOIN_MAX < FD_SHMEM_PRIVATE_MAP_SLOT_CNT, increase_lg_slot_count );
      37             : 
      38             : #define MAP_NAME              fd_shmem_private_map
      39           2 : #define MAP_T                 fd_shmem_join_info_t
      40           3 : #define MAP_LG_SLOT_CNT       FD_SHMEM_PRIVATE_MAP_LG_SLOT_CNT
      41           3 : #define MAP_KEY_T             fd_shmem_private_key_t
      42           1 : #define MAP_KEY_NULL          fd_shmem_private_key_null
      43        6731 : #define MAP_KEY_INVAL(k)      (!((k).cstr[0]))
      44           0 : #define MAP_KEY_EQUAL(k0,k1)  (!memcmp( (k0).cstr, (k1).cstr, FD_SHMEM_NAME_MAX ))
      45             : #define MAP_KEY_EQUAL_IS_SLOW (1)
      46           2 : #define MAP_KEY_HASH(k)       ((uint)fd_hash( 0UL, (k).cstr, FD_SHMEM_NAME_MAX ))
      47             : #include "../tmpl/fd_map.c"
      48             : 
      49             : /* fd_shmem_private_map_query_by_{join,addr} are some extra
      50             :    fd_shmem_private_map APIs allow looking up the join info for a region
      51             :    by its join handle and/or by a pointer at a byte in the region int
      52             :    the thread group's local address space.  These aren't algorithmically
      53             :    efficient but aren't expected to be and are plenty fast in normal use
      54             :    anyway. */
      55             : 
      56             : static inline fd_shmem_join_info_t *
      57             : fd_shmem_private_map_query_by_join( fd_shmem_join_info_t * map,
      58             :                                     void const *           join,
      59           2 :                                     fd_shmem_join_info_t * def ) {
      60         285 :   for( ulong slot_idx=0UL; slot_idx<FD_SHMEM_PRIVATE_MAP_SLOT_CNT; slot_idx++ )
      61         284 :     if( ((!fd_shmem_private_map_key_inval( map[slot_idx].key )) & (map[slot_idx].join==join)) ) return &map[slot_idx];
      62           1 :   return def;
      63           2 : }
      64             : 
      65             : static inline fd_shmem_join_info_t *
      66             : fd_shmem_private_map_query_by_addr( fd_shmem_join_info_t * map,
      67             :                                     ulong                  a0,
      68             :                                     ulong                  a1,      /* Assumes a1>=a0 */
      69         222 :                                     fd_shmem_join_info_t * def ) {
      70        6445 :   for( ulong slot_idx=0UL; slot_idx<FD_SHMEM_PRIVATE_MAP_SLOT_CNT; slot_idx++ ) {
      71        6444 :     ulong j0 = (ulong)map[slot_idx].shmem;
      72        6444 :     ulong j1 = j0 + map[slot_idx].page_sz*map[slot_idx].page_cnt - 1UL;
      73        6444 :     if( ((!fd_shmem_private_map_key_inval( map[slot_idx].key )) & (a1>=j0) & (a0<=j1)) ) return &map[slot_idx];
      74        6444 :   }
      75           1 :   return def;
      76         222 : }
      77             : 
      78             : /*
      79             :  * fd_shmem_private_grab_region will attempt to map a region at the passed
      80             :  * address with the passed size. If the return value of `mmap` equals the
      81             :  * passed address this means the area of memory was unmapped previously and
      82             :  * we have successfully "grabbed" the region. We can then call `mmap` with
      83             :  * MAP_FIXED over the region and be certain no corruption occurs. If the
      84             :  * return value of `mmap` does not return the passed address this means that
      85             :  * the passed region is already atleast partially mapped and we cannot grab it.
      86             :  */
      87             : static void *
      88             : fd_shmem_private_grab_region( ulong addr,
      89             :                               ulong size,
      90           1 :                               int   prot ) {
      91           1 :   void * mmap_ret = mmap( (void*)addr, size, prot, MAP_ANON|MAP_PRIVATE, -1, 0 );
      92           1 :   if( FD_UNLIKELY( mmap_ret == MAP_FAILED ) ) return mmap_ret;
      93             : 
      94           1 :   if( FD_UNLIKELY( (ulong)mmap_ret != addr ) ) {
      95           0 :     if( munmap( mmap_ret, size ) ) {
      96           0 :       FD_LOG_ERR(( "failed to unmap temporary mapping, munmap() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
      97           0 :     }
      98           0 :     return MAP_FAILED;
      99           0 :   }
     100             : 
     101           1 :   return mmap_ret;
     102           1 : }
     103             : 
     104             : void *
     105             : fd_shmem_private_map_rand( ulong size,
     106             :                            ulong align,
     107           1 :                            int   prot ) {
     108           1 :   ulong ret_addr = 0;
     109             : 
     110             :   /* Failure is unlikely, 1000 iterations should guarantee success */
     111           1 :   for( ulong i = 0; i < 1000; i++ ) {
     112           1 :     long n = getrandom( &ret_addr, sizeof(ret_addr), 0 );
     113           1 :     if( FD_UNLIKELY( n!=sizeof(ret_addr) ) ) FD_LOG_ERR(( "could not generate random address, getrandom() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
     114             : 
     115             :     /* Assume 47-bit virtual addressing */
     116           1 :     ret_addr &= 0x00007FFFFFFFFFFFUL;
     117           1 :     ret_addr  = fd_ulong_align_up( ret_addr, align );
     118             : 
     119           1 :     if( fd_shmem_private_grab_region( ret_addr, size, prot )!=MAP_FAILED ) {
     120           1 :       return (void *)ret_addr;
     121           1 :     }
     122           1 :   }
     123             : 
     124           0 :   FD_LOG_ERR(( "unable to find random address for memory map after 1000 attempts" ));
     125           0 : }
     126             : 
     127             : static fd_shmem_join_info_t fd_shmem_private_map[ FD_SHMEM_PRIVATE_MAP_SLOT_CNT ]; /* Empty on thread group start */
     128             : static ulong                fd_shmem_private_map_cnt;                              /* 0 on thread group start */
     129             : 
     130             : void *
     131             : fd_shmem_join( char const *               name,
     132             :                int                        mode,
     133             :                int                        dump,
     134             :                fd_shmem_joinleave_func_t  join_func,
     135             :                void *                     context,
     136           0 :                fd_shmem_join_info_t *     opt_info ) {
     137             : 
     138             :   /* Check input args */
     139             : 
     140           0 :   fd_shmem_private_key_t key;
     141           0 :   if( FD_UNLIKELY( !fd_shmem_private_key( &key, name ) ) ) {
     142           0 :     FD_LOG_WARNING(( "bad name (%s)", name ? name : "NULL" ));
     143           0 :     return NULL;
     144           0 :   }
     145             : 
     146           0 :   if( FD_UNLIKELY( !( (mode==FD_SHMEM_JOIN_MODE_READ_ONLY) | (mode==FD_SHMEM_JOIN_MODE_READ_WRITE) ) ) ) {
     147           0 :     FD_LOG_WARNING(( "unsupported join mode (%i) for %s", mode, name ));
     148           0 :     return NULL;
     149           0 :   }
     150             : 
     151           0 :   FD_SHMEM_LOCK;
     152             : 
     153             :   /* Query for an existing mapping */
     154             : 
     155           0 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query( fd_shmem_private_map, key, NULL );
     156           0 :   if( join_info ) {
     157           0 :     if( FD_UNLIKELY( join_info->ref_cnt<0L ) ) {
     158           0 :       FD_LOG_WARNING(( "join/leave circular dependency detected for %s", name ));
     159           0 :       FD_SHMEM_UNLOCK;
     160           0 :       return NULL;
     161           0 :     }
     162           0 :     join_info->ref_cnt++;
     163             : 
     164           0 :     if( opt_info ) *opt_info = *join_info;
     165           0 :     FD_SHMEM_UNLOCK;
     166           0 :     return join_info->join;
     167           0 :   }
     168             : 
     169             :   /* Not currently mapped.  See if we have enough room.  */
     170             : 
     171           0 :   if( FD_UNLIKELY( fd_shmem_private_map_cnt>=FD_SHMEM_JOIN_MAX ) ) {
     172           0 :     FD_SHMEM_UNLOCK;
     173           0 :     FD_LOG_WARNING(( "too many concurrent joins for %s", name ));
     174           0 :     return NULL;
     175           0 :   }
     176             : 
     177             :   /* We have enough room for it.  Try to map the memory. */
     178             : 
     179           0 :   fd_shmem_info_t shmem_info[1];
     180           0 :   if( FD_UNLIKELY( fd_shmem_info( name, 0UL, shmem_info ) ) ) {
     181           0 :     FD_SHMEM_UNLOCK;
     182           0 :     FD_LOG_WARNING(( "unable to query region \"%s\"\n\tprobably does not exist or bad permissions", name ));
     183           0 :     return NULL;
     184           0 :   }
     185           0 :   ulong page_sz  = shmem_info->page_sz;
     186           0 :   ulong page_cnt = shmem_info->page_cnt;
     187           0 :   ulong sz       = page_sz*page_cnt;
     188           0 :   int   rw       = (mode==FD_SHMEM_JOIN_MODE_READ_WRITE);
     189             : 
     190             :   /* Map the region into our address space. */
     191             : 
     192           0 :   char path[ FD_SHMEM_PRIVATE_PATH_BUF_MAX ];
     193           0 :   int fd = open( fd_shmem_private_path( name, page_sz, path ), rw ? O_RDWR : O_RDONLY, (mode_t)0 );
     194           0 :   if( FD_UNLIKELY( fd==-1 ) ) {
     195           0 :     FD_SHMEM_UNLOCK;
     196           0 :     FD_LOG_WARNING(( "open(\"%s\",%s,0) failed (%i-%s)", path, rw ? "O_RDWR" : "O_RDONLY", errno, fd_io_strerror( errno ) ));
     197           0 :     return NULL;
     198           0 :   }
     199             : 
     200             :   /* Generate a random address that we are guaranteed to be able to map */
     201           0 :   void * const map_addr = fd_shmem_private_map_rand( sz, page_sz, PROT_READ );
     202           0 :   if( FD_UNLIKELY( map_addr==MAP_FAILED ) ) FD_LOG_ERR(( "fd_shmem_private_map_rand failed" ));
     203             : 
     204             :   /* Note that MAP_HUGETLB and MAP_HUGE_* are implied by the mount point */
     205           0 :   void * shmem = mmap( map_addr, sz, PROT_READ|( rw?PROT_WRITE:0 ) , MAP_SHARED|MAP_FIXED, fd, (off_t)0 );
     206             : 
     207           0 :   int mmap_errno = errno;
     208           0 :   if( FD_UNLIKELY( close( fd ) ) )
     209           0 :     FD_LOG_WARNING(( "close(\"%s\") failed (%i-%s); attempting to continue", path, errno, fd_io_strerror( errno ) ));
     210             : 
     211             :   /* Validate the mapping */
     212             : 
     213           0 :   if( FD_UNLIKELY( shmem==MAP_FAILED ) ) {
     214           0 :     FD_SHMEM_UNLOCK;
     215           0 :     FD_LOG_WARNING(( "mmap(%p,%lu KiB,%s,MAP_SHARED,\"%s\",0) failed (%i-%s)",
     216           0 :                      map_addr, sz>>10, rw ? "PROT_READ|PROT_WRITE" : "PROT_READ", path, mmap_errno, fd_io_strerror( mmap_errno ) ));
     217           0 :     return NULL;
     218           0 :   }
     219             : 
     220           0 :   if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)shmem, page_sz ) ) ) {
     221           0 :     if( FD_UNLIKELY( munmap( shmem, sz ) ) )
     222           0 :       FD_LOG_WARNING(( "munmap(\"%s\",%lu KiB) failed (%i-%s); attempting to continue",
     223           0 :                        path, sz>>10, errno, fd_io_strerror( errno ) ));
     224           0 :     FD_SHMEM_UNLOCK;
     225           0 :     FD_LOG_WARNING(( "misaligned memory mapping for \"%s\"\n\t"
     226           0 :                      "This thread group's hugetlbfs mount path (--shmem-path / FD_SHMEM_PATH):\n\t"
     227           0 :                      "\t%s\n\t"
     228           0 :                      "has probably been corrupted and needs to be redone.\n\t"
     229           0 :                      "See 'bin/fd_shmem_cfg help' for more information.",
     230           0 :                      path, fd_shmem_private_base ));
     231           0 :     return NULL;
     232           0 :   }
     233             : 
     234             :   /* Lock this region in DRAM to prevent it going to swap and (try) to
     235             :      keep the virtual to physical DRAM mapping fixed for the join
     236             :      duration.  Also advise the kernel to not dump this region to avoid
     237             :      large shared mappings in concurrent use by multiple processes
     238             :      destroying the system with core files if a bunch of thread using
     239             :      this mapping seg fault concurrently. */
     240             : 
     241           0 :   if( FD_UNLIKELY( fd_numa_mlock( shmem, sz ) ) )
     242           0 :     FD_LOG_WARNING(( "fd_numa_mlock(\"%s\",%lu KiB) failed (%i-%s); attempting to continue",
     243           0 :                     path, sz>>10, errno, fd_io_strerror( errno ) ));
     244             : 
     245           0 :   if( FD_LIKELY( !dump ) ) {
     246           0 :     if( FD_UNLIKELY( madvise( shmem, sz, MADV_DONTDUMP ) ) )
     247           0 :       FD_LOG_WARNING(( "madvise(\"%s\",%lu KiB) failed (%i-%s); attempting to continue",
     248           0 :                       path, sz>>10, errno, fd_io_strerror( errno ) ));
     249           0 :   }
     250             : 
     251             :   /* We have mapped the region.  Try to complete the join.  Note:
     252             :      map_query above and map_insert could be combined to improve
     253             :      efficiency further here (and eliminate the paranoid if check in the
     254             :      process). */
     255             : 
     256           0 :   join_info = fd_shmem_private_map_insert( fd_shmem_private_map, key );
     257           0 :   if( FD_UNLIKELY( !join_info ) ) /* should be impossible */
     258           0 :     FD_LOG_ERR(( "unable to insert region \"%s\" (internal error)", name ));
     259           0 :   fd_shmem_private_map_cnt++;
     260             : 
     261           0 :   join_info->ref_cnt  = -1L;  /* Mark join/leave in progress so we can detect circular join/leave dependencies */
     262           0 :   join_info->join     = NULL; /* Overridden below */
     263           0 :   join_info->shmem    = shmem;
     264           0 :   join_info->page_sz  = page_sz;
     265           0 :   join_info->page_cnt = page_cnt;
     266           0 :   join_info->mode     = mode;
     267             :   /* join_info->hash handled by insert */
     268             :   /* join_info->name "                 */
     269             :   /* join_info->key  "                 */
     270             : 
     271           0 :   void * join = join_func ? join_func( context, join_info ): shmem; /* Reset by the join func if provided */
     272           0 :   if( FD_UNLIKELY( !join ) ) {
     273           0 :     fd_shmem_private_map_remove( fd_shmem_private_map, join_info );
     274           0 :     fd_shmem_private_map_cnt--;
     275           0 :     if( FD_UNLIKELY( munmap( shmem, sz ) ) )
     276           0 :       FD_LOG_WARNING(( "munmap(\"%s\",%lu KiB) failed (%i-%s); attempting to continue",
     277           0 :                        name, sz>>10, errno, fd_io_strerror( errno ) ));
     278           0 :     FD_SHMEM_UNLOCK;
     279           0 :     FD_LOG_WARNING(( "unable to join region \"%s\"", name ));
     280           0 :     return NULL;
     281           0 :   }
     282           0 :   join_info->ref_cnt = 1UL;
     283           0 :   join_info->join    = join;
     284             : 
     285           0 :   if( opt_info ) *opt_info = *join_info;
     286           0 :   FD_SHMEM_UNLOCK;
     287           0 :   return join;
     288           0 : }
     289             : 
     290             : int
     291             : fd_shmem_leave( void *                    join,
     292             :                 fd_shmem_joinleave_func_t leave_func,
     293           0 :                 void *                    context ) {
     294           0 :   if( FD_UNLIKELY( !join ) ) { FD_LOG_WARNING(( "NULL join" )); return 1; }
     295             : 
     296           0 :   FD_SHMEM_LOCK;
     297             : 
     298           0 :   if( FD_UNLIKELY( !fd_shmem_private_map_cnt ) ) {
     299           0 :     FD_SHMEM_UNLOCK;
     300           0 :     FD_LOG_WARNING(( "join is not a current join" ));
     301           0 :     return 1;
     302           0 :   }
     303           0 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query_by_join( fd_shmem_private_map, join, NULL );
     304           0 :   if( FD_UNLIKELY( !join_info ) ) {
     305           0 :     FD_SHMEM_UNLOCK;
     306           0 :     FD_LOG_WARNING(( "join is not a current join" ));
     307           0 :     return 1;
     308           0 :   }
     309             : 
     310           0 :   long ref_cnt = join_info->ref_cnt;
     311           0 :   if( join_info->ref_cnt>1L ) {
     312           0 :     join_info->ref_cnt = ref_cnt-1L;
     313           0 :     FD_SHMEM_UNLOCK;
     314           0 :     return 0;
     315           0 :   }
     316             : 
     317           0 :   if( join_info->ref_cnt==-1L ) {
     318           0 :     FD_SHMEM_UNLOCK;
     319           0 :     FD_LOG_WARNING(( "join/leave circular dependency detected for %s", join_info->name ));
     320           0 :     return 1;
     321           0 :   }
     322             : 
     323           0 :   if( FD_UNLIKELY( join_info->ref_cnt!=1L ) ) /* Should be impossible */
     324           0 :     FD_LOG_WARNING(( "unexpected ref count for %s; attempting to continue", join_info->name ));
     325             : 
     326           0 :   char const * name     = join_info->name;     /* Just in case leave_func clobbers */
     327           0 :   void *       shmem    = join_info->shmem;    /* " */
     328           0 :   ulong        page_sz  = join_info->page_sz;  /* " */
     329           0 :   ulong        page_cnt = join_info->page_cnt; /* " */
     330             : 
     331           0 :   if( leave_func ) {
     332           0 :     join_info->ref_cnt = -1L; /* Mark join/leave is in progress so we can detect join/leave circular dependencies */
     333           0 :     leave_func( context, join_info );
     334           0 :   }
     335             : 
     336           0 :   int error = 0;
     337           0 :   ulong sz = page_sz*page_cnt;
     338           0 :   if( FD_UNLIKELY( munmap( shmem, sz ) ) ) {
     339           0 :     FD_LOG_WARNING(( "munmap(\"%s\",%lu KiB) failed (%i-%s); attempting to continue",
     340           0 :                      name, sz>>10, errno, fd_io_strerror( errno ) ));
     341           0 :     error = 1;
     342           0 :   }
     343             : 
     344           0 :   fd_shmem_private_map_remove( fd_shmem_private_map, join_info );
     345           0 :   fd_shmem_private_map_cnt--;
     346           0 :   FD_SHMEM_UNLOCK;
     347           0 :   return error;
     348           0 : }
     349             : 
     350             : int
     351             : fd_shmem_join_query_by_name( char const *           name,
     352           0 :                              fd_shmem_join_info_t * opt_info ) {
     353           0 :   fd_shmem_private_key_t key;
     354           0 :   if( FD_UNLIKELY( !fd_shmem_private_key( &key, name ) ) ) return EINVAL;
     355             : 
     356           0 :   FD_SHMEM_LOCK;
     357             : 
     358           0 :   if( !fd_shmem_private_map_cnt ) { FD_SHMEM_UNLOCK; return ENOENT; }
     359           0 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query( fd_shmem_private_map, key, NULL );
     360           0 :   if( !join_info ) { FD_SHMEM_UNLOCK; return ENOENT; }
     361           0 :   if( opt_info ) *opt_info = *join_info;
     362             : 
     363           0 :   FD_SHMEM_UNLOCK;
     364           0 :   return 0;
     365           0 : }
     366             : 
     367             : int
     368             : fd_shmem_join_query_by_join( void const *           join,
     369           0 :                              fd_shmem_join_info_t * opt_info ) {
     370           0 :   if( FD_UNLIKELY( !join ) ) return EINVAL;
     371             : 
     372           0 :   FD_SHMEM_LOCK;
     373             : 
     374           0 :   if( !fd_shmem_private_map_cnt ) { FD_SHMEM_UNLOCK; return ENOENT; }
     375           0 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query_by_join( fd_shmem_private_map, join, NULL );
     376           0 :   if( FD_UNLIKELY( !join_info ) ) { FD_SHMEM_UNLOCK; return ENOENT; }
     377           0 :   if( opt_info ) *opt_info = *join_info;
     378             : 
     379           0 :   FD_SHMEM_UNLOCK;
     380           0 :   return 0;
     381           0 : }
     382             : 
     383             : int
     384             : fd_shmem_join_query_by_addr( void const *           addr,
     385             :                              ulong                  sz,
     386         221 :                              fd_shmem_join_info_t * opt_info ) {
     387         221 :   if( FD_UNLIKELY( !sz ) ) return ENOENT; /* empty range */
     388         221 :   ulong a0 = (ulong)addr;
     389         221 :   ulong a1 = a0+sz-1UL;
     390         221 :   if( FD_UNLIKELY( a1<a0 ) ) return EINVAL; /* cyclic wrap range */
     391             : 
     392         221 :   FD_SHMEM_LOCK;
     393             : 
     394         221 :   if( !fd_shmem_private_map_cnt ) { FD_SHMEM_UNLOCK; return ENOENT; }
     395         221 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query_by_addr( fd_shmem_private_map, a0, a1, NULL );
     396         221 :   if( FD_UNLIKELY( !join_info ) ) { FD_SHMEM_UNLOCK; return ENOENT; }
     397         221 :   if( opt_info ) *opt_info = *join_info;
     398             : 
     399         221 :   FD_SHMEM_UNLOCK;
     400         221 :   return 0;
     401         221 : }
     402             : 
     403             : int
     404             : fd_shmem_join_anonymous( char const * name,
     405             :                          int          mode,
     406             :                          void *       join,
     407             :                          void *       mem,
     408             :                          ulong        page_sz,
     409           1 :                          ulong        page_cnt ) {
     410             : 
     411             :   /* Check input args */
     412             : 
     413           1 :   fd_shmem_private_key_t key;
     414           1 :   if( FD_UNLIKELY( !fd_shmem_private_key( &key, name ) ) ) {
     415           0 :     FD_LOG_WARNING(( "bad name (%s)", name ? name : "NULL" ));
     416           0 :     return EINVAL;
     417           0 :   }
     418             : 
     419           1 :   if( FD_UNLIKELY( !( (mode==FD_SHMEM_JOIN_MODE_READ_ONLY) | (mode==FD_SHMEM_JOIN_MODE_READ_WRITE) ) ) ) {
     420           0 :     FD_LOG_WARNING(( "unsupported join mode (%i) for %s", mode, name ));
     421           0 :     return EINVAL;
     422           0 :   }
     423             : 
     424           1 :   if( FD_UNLIKELY( !join ) ) {
     425           0 :     FD_LOG_WARNING(( "NULL join" ));
     426           0 :     return EINVAL;
     427           0 :   }
     428             : 
     429           1 :   if( FD_UNLIKELY( !mem ) ) {
     430           0 :     FD_LOG_WARNING(( "NULL mem" ));
     431           0 :     return EINVAL;
     432           0 :   }
     433             : 
     434           1 :   if( FD_UNLIKELY( !fd_shmem_is_page_sz( page_sz ) ) ) {
     435           0 :     FD_LOG_WARNING(( "unsupported page_sz (%lu)", page_sz ));
     436           0 :     return EINVAL;
     437           0 :   }
     438             : 
     439           1 :   if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, page_sz ) ) ) {
     440           0 :     FD_LOG_WARNING(( "misaligned mem" ));
     441           0 :     return EINVAL;
     442           0 :   }
     443             : 
     444           1 :   if( FD_UNLIKELY( !page_cnt ) ) {
     445           0 :     FD_LOG_WARNING(( "unsupported page_sz (%lu)", page_sz ));
     446           0 :     return EINVAL;
     447           0 :   }
     448             : 
     449           1 :   if( FD_UNLIKELY( page_cnt > (ULONG_MAX/page_sz) ) ) {
     450           0 :     FD_LOG_WARNING(( "too large page cnt (%lu)", page_cnt ));
     451           0 :     return EINVAL;
     452           0 :   }
     453             : 
     454           1 :   ulong sz = page_cnt*page_sz;
     455           1 :   ulong a0 = (ulong)mem;
     456           1 :   ulong a1 = a0 + sz-1UL;
     457           1 :   if( FD_UNLIKELY( a1<a0 ) ) {
     458           0 :     FD_LOG_WARNING(( "bad mem range" ));
     459           0 :     return EINVAL;
     460           0 :   }
     461             : 
     462           1 :   FD_SHMEM_LOCK;
     463             : 
     464             :   /* Query for an existing mapping */
     465             : 
     466           1 :   fd_shmem_join_info_t * join_info;
     467             : 
     468           1 :   join_info = fd_shmem_private_map_query( fd_shmem_private_map, key, NULL );
     469           1 :   if( FD_UNLIKELY( join_info ) ) {
     470           0 :     FD_SHMEM_UNLOCK;
     471           0 :     FD_LOG_WARNING(( "%s already joined", name ));
     472           0 :     return EINVAL;
     473           0 :   }
     474             : 
     475           1 :   join_info = fd_shmem_private_map_query_by_join( fd_shmem_private_map, join, NULL );
     476           1 :   if( FD_UNLIKELY( join_info ) ) {
     477           0 :     FD_SHMEM_UNLOCK;
     478           0 :     FD_LOG_WARNING(( "%s join handle already in use", name ));
     479           0 :     return EINVAL;
     480           0 :   }
     481             : 
     482           1 :   join_info = fd_shmem_private_map_query_by_addr( fd_shmem_private_map, a0, a1, NULL );
     483           1 :   if( FD_UNLIKELY( join_info ) ) {
     484           0 :     FD_SHMEM_UNLOCK;
     485           0 :     FD_LOG_WARNING(( "%s join memory already mapped", name ));
     486           0 :     return EINVAL;
     487           0 :   }
     488             : 
     489             :   /* Not currently mapped.  See if we have enough room.  */
     490             : 
     491           1 :   if( FD_UNLIKELY( fd_shmem_private_map_cnt>=FD_SHMEM_JOIN_MAX ) ) {
     492           0 :     FD_SHMEM_UNLOCK;
     493           0 :     FD_LOG_WARNING(( "too many concurrent joins for %s", name ));
     494           0 :     return EINVAL;
     495           0 :   }
     496             : 
     497             :   /* We have enough room for it.  Try to "map" the memory. */
     498             : 
     499           1 :   fd_shmem_info_t shmem_info[1];
     500           1 :   if( FD_UNLIKELY( !fd_shmem_info( name, 0UL, shmem_info ) ) )
     501           0 :     FD_LOG_WARNING(( "anonymous join to %s will shadow an existing shared memory region in this thread group; "
     502           1 :                      "attempting to continue", name ));
     503             : 
     504           1 :   join_info = fd_shmem_private_map_insert( fd_shmem_private_map, key );
     505           1 :   if( FD_UNLIKELY( !join_info ) ) /* should be impossible */
     506           0 :     FD_LOG_ERR(( "unable to insert region \"%s\" (internal error)", name ));
     507           1 :   fd_shmem_private_map_cnt++;
     508             : 
     509           1 :   join_info->ref_cnt  = 1L;
     510           1 :   join_info->join     = join;
     511           1 :   join_info->shmem    = mem;
     512           1 :   join_info->page_sz  = page_sz;
     513           1 :   join_info->page_cnt = page_cnt;
     514           1 :   join_info->mode     = mode;
     515             :   /* join_info->hash handled by insert */
     516             :   /* join_info->name "                 */
     517             :   /* join_info->key  "                 */
     518             : 
     519           1 :   FD_SHMEM_UNLOCK;
     520           1 :   return 0;
     521           1 : }
     522             : 
     523             : int
     524             : fd_shmem_leave_anonymous( void *                 join,
     525           1 :                           fd_shmem_join_info_t * opt_info ) {
     526             : 
     527           1 :   if( FD_UNLIKELY( !join ) ) {
     528           0 :     FD_LOG_WARNING(( "NULL join" ));
     529           0 :     return EINVAL;
     530           0 :   }
     531             : 
     532           1 :   FD_SHMEM_LOCK;
     533             : 
     534           1 :   if( FD_UNLIKELY( !fd_shmem_private_map_cnt ) ) {
     535           0 :     FD_SHMEM_UNLOCK;
     536           0 :     FD_LOG_WARNING(( "join is not a current join" ));
     537           0 :     return EINVAL;
     538           0 :   }
     539             : 
     540           1 :   fd_shmem_join_info_t * join_info = fd_shmem_private_map_query_by_join( fd_shmem_private_map, join, NULL );
     541           1 :   if( FD_UNLIKELY( !join_info ) ) {
     542           0 :     FD_SHMEM_UNLOCK;
     543           0 :     FD_LOG_WARNING(( "join is not a current join" ));
     544           0 :     return EINVAL;
     545           0 :   }
     546             : 
     547           1 :   if( FD_UNLIKELY( join_info->ref_cnt!=1L ) ) {
     548           0 :     FD_SHMEM_UNLOCK;
     549           0 :     FD_LOG_WARNING(( "join ref_cnt is not 1" ));
     550           0 :     return EINVAL;
     551           0 :   }
     552             : 
     553           1 :   if( opt_info ) {
     554           0 :     *opt_info = *join_info;
     555           0 :     opt_info->ref_cnt = 0L;
     556           0 :   }
     557             : 
     558           1 :   fd_shmem_private_map_remove( fd_shmem_private_map, join_info );
     559           1 :   fd_shmem_private_map_cnt--;
     560           1 :   FD_SHMEM_UNLOCK;
     561           1 :   return 0;
     562           1 : }
     563             : 
     564             : fd_shmem_join_info_t const *
     565           0 : fd_shmem_iter_begin( void ) {
     566           0 :   fd_shmem_join_info_t const * map = fd_shmem_private_map;
     567           0 :   for( ulong slot_idx=0UL; slot_idx<FD_SHMEM_PRIVATE_MAP_SLOT_CNT; slot_idx++ ) {
     568           0 :     if( !fd_shmem_private_map_key_inval( map[slot_idx].key ) ) return &map[slot_idx];
     569           0 :   }
     570           0 :   return NULL;
     571           0 : }
     572             : 
     573             : fd_shmem_join_info_t const *
     574           0 : fd_shmem_iter_next( fd_shmem_join_info_t const * iter ) {
     575           0 :   fd_shmem_join_info_t const * map = fd_shmem_private_map;
     576           0 :   for( ulong slot_idx=(ulong)(iter-map) + 1UL; slot_idx<FD_SHMEM_PRIVATE_MAP_SLOT_CNT; slot_idx++ ) {
     577           0 :     if( !fd_shmem_private_map_key_inval( map[slot_idx].key ) ) return &map[slot_idx];
     578           0 :   }
     579           0 :   return NULL;
     580           0 : }
     581             : 
     582             : #endif

Generated by: LCOV version 1.14