1rsm_create_localmemorRye_mhoatnedlSeh(a3rReSdM)Memory Librrsamr_ycrFeuantcet_ilooncsalmemory_handle(3RSM)
2
3
4

NAME

6       rsm_create_localmemory_handle,  rsm_free_localmemory_handle - create or
7       free local memory handle
8

SYNOPSIS

10       cc [ flag... ] file... -lrsm [ library... ]
11       #include <rsmapi.h>
12
13       int rsm_create_localmemory_handle(
14            rsmapi_controller_handle_t handle,
15            rsm_localmemory_handle_t *l_handle,
16            caddr_t local_vaddr, size_t length);
17
18
19       int rsm_free_localmemory_handle(
20            rsmapi_controller_handle_t handle,
21            rsm_localmemory_handle_t l_handle);
22
23

DESCRIPTION

25       The  rsm_create_localmemory_handle() and  rsm_free_localmemory_handle()
26       functions are supporting functions for rsm_memseg_import_putv(3RSM) and
27       rsm_memseg_import_getv(3RSM).
28
29
30       The rsm_create_localmemory_handle() function  creates  a  local  memory
31       handle  to be used in the I/O vector component of a scatter-gather list
32       of  subsequent  rsm_memseg_import_putv()  and  rsm_memseg_import_getv()
33       calls.  The  handle  argument  specifies the controller handle obtained
34       from rsm_get_controller(3RSM). The l_handle argument is  a  pointer  to
35       the  location  for  the function to return the local memory handle. The
36       local_vaddr argument specifies the local virtual address; it should  be
37       aligned at a page boundary. The length argument specifies the length of
38       memory spanned by the handle.
39
40
41       The rsm_free_localmemory_handle() function unlocks the memory range for
42       the local handle specified by l_handle and releases the associated sys‐
43       tem resources. The handle argument  specifies  the  controller  handle.
44       All  handles created by a process are freed when the process exits, but
45       the process should call rsm_free_localmemory_handle() as soon as possi‐
46       ble to free the system resources.
47

RETURN VALUES

49       Upon  successful  completion,  these  functions return 0. Otherwise, an
50       error value is returned to indicate the error.
51

ERRORS

53       The rsm_create_localmemory_handle()  and  rsm_free_localmemory_handle()
54       functions can return the following errors:
55
56       RSMERR_BAD_CTLR_HNDL         Invalid controller handle.
57
58
59       RSMERR_BAD_LOCALMEM_HNDL     Invalid local memory handle.
60
61
62
63       The   rsm_create_localmemory_handle() function can return the following
64       errors:
65
66       RSMERR_BAD_LENGTH           Invalid length.
67
68
69       RSMERR_BAD_ADDRESS          Invalid address.
70
71
72       RSMERR_INSUFFICIENT_MEM     Insufficient memory.
73
74

ATTRIBUTES

76       See attributes(5) for descriptions of the following attributes:
77
78
79
80
81       ┌─────────────────────────────┬─────────────────────────────┐
82       │ATTRIBUTE TYPE               │ATTRIBUTE VALUE              │
83       ├─────────────────────────────┼─────────────────────────────┤
84       │Interface Stability          │Evolving                     │
85       ├─────────────────────────────┼─────────────────────────────┤
86       │MT-Level                     │MT-Safe                      │
87       └─────────────────────────────┴─────────────────────────────┘
88

SEE ALSO

90       rsm_memseg_import_putv(3RSM), attributes(5)
91
92
93
94SunOS 5.11                        8 Jun 2001rsm_create_localmemory_handle(3RSM)
Impressum