Manual Pages for UNIX Operating System command usage for man rsm_memseg_import_map

Remote Shared Memory Library Functions
                                      rsm_memseg_import_map(3RSM)



NAME
     rsm_memseg_import_map,  rsm_memseg_import_unmap  -  map   or
     unmap imported segment

SYNOPSIS
     cc [ flag... ] file... -lrsm [ library... ]
     #include 

     int rsm_memseg_import_map(rsm_memseg_import_handle_t im_memseg,
          void **address, rsm_attribute_t attr,
          rsm_permission_t perm, off_t offset, size_t length);


     int rsm_memseg_import_unmap(rsm_memseg_import_handle_t im_memseg);


DESCRIPTION
     The  rsm_memseg_import_map()  and  rsm_memseg_import_unmap()
     functions  provide  for  mapping and unmapping operations on
     imported segments. The mapping operations are only available
     for native architecture interconnects such as Dolphin-SCI or
     Sun Fire Link. Mapping a segment allows that segment  to  be
     accessed  by  CPU  memory operations, saving the overhead of
     calling  the  memory  access  primitives  described  on  the
     rsm_memseg_import_get(3RSM)  and rsm_memseg_import_put(3RSM)
     manual pages.


     The rsm_memseg_import_map() function maps an import  segment
     into  caller's  address space for the segment to be accessed
     by CPU memory operations.  The im_memseg argument represents
     the  import segment that is being mapped. The location where
     the process's address space is  mapped  to  the  segment  is
     pointed  to  by the  address argument. The attr argiment can
     be one fo the following:

     RSM_MAP_NONE      The system will choose  available  virtual
                       address to map and return its value in the
                       address argument.


     RSM_MAP_FIXED     The import segment should be mapped at the
                       requested virtual address specified in the
                       address argument.



     The perm argument determines whether read, write or a combi-
     nation  of  accesses are permitted to the data being mapped.
     It  can  be   either   RSM_PERM_READ,   RSM_PERM_WRITE,   or
     RSM_PERM_RDWR.



SunOS 5.11          Last change: 13 Nov 2002                    1






Remote Shared Memory Library Functions
                                      rsm_memseg_import_map(3RSM)



     The offset argument is the byte  offset  location  from  the
     base  of  the  segment  being  mapped to address. The length
     argument indicates the number of bytes  from  offset  to  be
     mapped.


     The rsm_memseg_import_unmap() function unmaps  a  previously
     mapped import segment.

RETURN VALUES
     Upon successful completion, these functions return 0. Other-
     wise, an error value is returned to indicate the error.

ERRORS
     The  rsm_memseg_import_map()  and  rsm_memseg_import_unmap()
     functions can return the following errors:

     RSMERR_BAD_SEG_HNDL     Invalid segment handle.



     The rsm_memseg_import_map() function can return the  follow-
     ing errors:

     RSMERR_BAD_ADDR               Invalid address.


     RSMERR_BAD_LENGTH             Invalid length.


     RSMERR_BAD_MEM_ALIGNMENT      The address is not aligned  on
                                   a page boundary.


     RSMERR_BAD_OFFSET             Invalid offset.


     RSMERR_BAD_PERMS              Invalid permissions.


     RSMERR_CONN_ABORTED           Connection aborted.


     RSMERR_MAP_FAILED             Map failure.


     RSMERR_SEG_ALREADY_MAPPED     Segment already mapped.


     RSMERR_SEG_NOT_CONNECTED      Segment not connected.




SunOS 5.11          Last change: 13 Nov 2002                    2






Remote Shared Memory Library Functions
                                      rsm_memseg_import_map(3RSM)



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     ____________________________________________________________
    | ATTRIBUTE TYPE              | ATTRIBUTE VALUE             |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     rsm_memseg_import_connect(3RSM),
     rsm_memseg_import_get(3RSM),    rsm_memseg_import_put(3RSM),
     rsm_memseg_get_pollfd(3RSM), attributes(5)



































SunOS 5.11          Last change: 13 Nov 2002                    3






Remote Shared Memory Library Functions
                                      rsm_memseg_import_map(3RSM)






















































SunOS 5.11          Last change: 13 Nov 2002                    4