--- name: "resmgr" section: "3" platform: "linux" package: "libresmgr-dev" version: "1.0-2sarge2" release: "Debian 3.1 (Sarge)" platforms: ["linux"] url: "https://new.carta.tech/resmgr/3" --- # resmgr(3) resource manager library functions ## NAME resmgr - resource manager library functions ## SYNOPSIS ``` #include char **rsm_list_devices(const char *family); int rsm_open_device(const char *pathname, int flags); int rsm_open_device_as(const char *family, const char *pathname, int flags); int rsm_login(const char *user, const char *id); int rsm_logout(const char *user); int rsm_grant(const char *user, const char *classname); int rsm_add_device(const char *device, const char *classname); int rsm_remove_device(const char *device, const char *classname); int rsm_lock_device(const char *device); int rsm_unlock_device(const char *device); ``` ## DESCRIPTION This manual page lists the resource manager functions available to client applications. All functions connect to the resource manager daemon [**resmgrd**(8)](/resmgrd/8.md), transmit one or more commands, and close the connection. ### User functions The following functions are intended to be used by user applications wishing to open or lock a device. - **char \*\*rsm\_list\_devices(const char \****family***)** This function will return the list of devices the client is permitted to open. - The optional *family* argument can be used to specify a resource family. If specified, the listing will include only names from that specific family. In addition, device names will be mapped to that particular name space. - For instance, if the resource class includes the device **/dev/cdrom**, listing the **scsi** family would return a corresponding SCSI device specifier such as **scsi:0,0,1**. (Of course, this assumes that **/dev/cdrom** uses the SCSI CD driver, and that the user has permission to open the corresponding raw SCSI device). - **int rsm\_open\_device(const char \****pathname***, int** *flags***)** This function will open the device specified by *pathname*. - The *flags* argument contains the usual flags recognized by [**open**(2)](/open/2.md), including **O\_RDWR**, **O\_RDONLY**, and **O\_NONBLOCK**. **O\_WRONLY** is not supported; the resource manager will silently use **O\_RDWR** instead. - **int rsm\_open\_device\_as(const char \****family***,** **const char \****pathname***, int** *flags***)**\ This function will open a device from the specified family, related to the the device specified by **pathname**. For instance, if you specify a family of **scsi**, and a device of **/dev/cdrom**, this will as the resource manager to open the raw SCSI device associated with the CDROM (if there is any, and if **/dev/cdrom** has the **scsi** flag set (see [**resmgr.conf**(5)](/resmgr.conf/5.md)). - If there is no corresponding device in the indicated family, access is denied. - The *flags* argument has the same meaning as with **rsm\_open\_device**. - Instead of the path name of a device, you can also identify the SCSI device using its SCSI ID, using the notation **\[***bus***,\]***target***,***lun***.** - **int rsm\_lock\_device(const char \****device***)** This function will create a lock file for *device*. If a conflicting lock exists, an error is returned. - **int rsm\_unlock\_device(const char \****device***)** This will remove a previously created lock file. The lock file must have been created by the calling user, or the lock file must be stale (i.e. the PID listed in the file does not correspond to a currently running process). ### Administrative Functions The following functions are administrative and are restricted to the administrator: - **int rsm\_login(const char \****user***, const char \****id***)** This function will establish a resource manager session for *user .* The *id* argument is a identifier uniquely describing *where* the user is logged in. For instance, if the user is logged in at the console or via remote login, *id* would usually specify the tty on which the user is logged in. Graphic logins such as **kdm** or **gdm** would probably use the X11 display string. - **int rsm\_logout(const char \****id***)** This function destroys the resource manager session for the given identifier. If this was the last session for the user, the user's access rights to devices managed by **resmgrd** are revoked. - **int rsm\_grant(const char \****user***, const char \****classname***)** This function grants *user* access to resource class *classname*. - **int rsm\_revoke(const char \****user***, const char \****classname***)** This function revokes *user*'s access rights to class *classname*. If *classname* is **NULL**, all access rights of the user are revoked. - **int rsm\_add\_device(const char \****device***, const char \****classname***)** Add device *device* to class *classname*. The device will immediately become accessible to all users who have been granted access to this class. - **int rsm\_remove\_device(const char \****device***,** **const char \****classname***)**\ Remove the specified *device* from class *classname*. ## RETURN VALUE **rsm\_open\_device** and **rsm\_open\_scsi\_device** return a file descriptor for the opened device on success, and -1 on error. All other functions return 0 in case of success, and -1 otherwise. ## AUTHOR Olaf Kirch \ ## SEE ALSO [**resmgrd**(8)](/resmgrd/8.md), [**resmgr**(1)](/resmgr/1.md).