LUSTREAPI(7)

💖 LUSTREAPI(7) — the Lustre API library, bestie edition 💖

okay so this is LUSTREAPI(7), a.k.a. the manual page for The Lustre API library. Grab a snack, we're doing this. 🍓

---

✨ NAME ✨

lustreapi — The Lustre API library

---

✨ SYNOPSIS ✨

#include <lustre/lustreapi.h>

---

✨ DESCRIPTION ✨

Okay bestie, listen up 🎀 — the lustreapi library hands you functions that let you access and/or modify settings that are super specific to the Lustre filesystem. We're talking allocation policies, quotas, file layouts, etc. It's giving very niche, very powerful. 💅

For the actual deets on each one, go read the referenced man pages — they're all down in SEE ALSO and they're all iconic in their own way.

---

✨ AUTHORS ✨

Lustre contributors 👑 (collective main character energy, fr fr)

---

✨ AVAILABILITY ✨

lustreapi is part of the lustre (8) filesystem package since release 0.10.0. So she's been here. She's been that girl since day one. ✨

---

✨ SEE ALSO ✨

📋 Changelogs

Functions for accessing and managing Lustre changelogs.

• llapi_changelog_clear(3), llapi_changelog_fini(3), llapi_changelog_free(3), llapi_changelog_get_fd(3), llapi_changelog_in_buf(3), llapi_changelog_recv(3), llapi_changelog_set_xflags(3), llapi_changelog_start(3), llapi_changelog_start_user(3)

📁 Directory Operations

Functions for creating and managing Lustre directories.

• llapi_dir_create(3), llapi_dir_create_foreign(3), llapi_dir_create_pool(3)

🆔 FID Handling

Functions for working with Lustre File Identifiers (FIDs).

• llapi_fd2fid(3), llapi_fd2parent(3), llapi_fid2path(3), llapi_fid2path_at(3), llapi_fid_hash(3), llapi_fid_parse(3), llapi_fid_to_handle(3), llapi_path2fid(3), llapi_path2parent(3), llapi_rmfid(3), llapi_rmfid_at(3)

📄 File Operations

Functions for creating and managing Lustre files.

• llapi_create_volatile_param(3), llapi_file_create(3), llapi_file_create_foreign(3), llapi_file_get_stripe(3), llapi_file_open(3), llapi_fsync(3), llapi_open_by_fid(3), llapi_open_by_fid_at(3), llapi_unlink_foreign(3)

🌈 File Layouts and Striping

Functions for file layouts and striping across OSTs.

• llapi_layout_alloc(3), llapi_layout_comp_add(3), llapi_layout_comp_del(3), llapi_layout_comp_extent_get(3), llapi_layout_comp_extent_set(3), llapi_layout_comp_flags_clear(3), llapi_layout_comp_flags_get(3), llapi_layout_comp_flags_set(3), llapi_layout_comp_id_get(3), llapi_layout_comp_use(3), llapi_layout_comp_use_id(3), llapi_layout_extension_size_get(3), llapi_layout_extension_size_set(3), llapi_layout_file_comp_add(3), llapi_layout_file_comp_del(3), llapi_layout_file_create(3), llapi_layout_file_open(3), llapi_layout_free(3), llapi_layout_get_by_fd(3), llapi_layout_get_by_fid(3), llapi_layout_get_by_path(3), llapi_layout_get_by_xattr(3), llapi_layout_ost_index_get(3), llapi_layout_ost_index_reset(3), llapi_layout_ost_index_set(3), llapi_layout_pattern_get(3), llapi_layout_pattern_set(3), llapi_layout_pool_name_get(3), llapi_layout_pool_name_set(3), llapi_layout_set_by_fd(3), llapi_layout_set_by_xattr(3), llapi_layout_stripe_count_get(3), llapi_layout_stripe_count_set(3), llapi_layout_stripe_size_get(3), llapi_layout_stripe_size_set(3)

🔍 Filesystem Information

Functions for querying filesystem names and paths.

• llapi_get_fsname(3), llapi_get_fsname_instance(3), llapi_get_instance(3), llapi_get_lum_dir(3), llapi_get_lum_dir_fd(3), llapi_get_lum_file(3), llapi_get_lum_file_fd(3), llapi_get_mdt_index_by_fid(3), llapi_getname(3), llapi_lmv_get_uuids(3), llapi_lov_get_uuids(3)

🗄️ Hierarchical Storage Management (HSM)

Functions for HSM copytool operations and archive management.

• llapi_hsm_action_begin(3), llapi_hsm_action_end(3), llapi_hsm_action_get_dfid(3), llapi_hsm_action_get_fd(3), llapi_hsm_action_progress(3), llapi_hsm_copytool_get_fd(3), llapi_hsm_copytool_recv(3), llapi_hsm_copytool_register(3), llapi_hsm_copytool_unregister(3), llapi_hsm_data_version_set(3), llapi_hsm_state_get(3), llapi_hsm_state_set(3)

💾 Persistent Client Cache (PCC)

Functions for managing Persistent Client Cache operations.

• llapi_pcc_attach(3), llapi_pcc_attach_fid(3), llapi_pcc_attach_fid_str(3), llapi_pcc_clear(3), llapi_pcc_del(3), llapi_pcc_detach_fid(3), llapi_pcc_detach_fid_fd(3), llapi_pcc_detach_fid_str(3), llapi_pcc_detach_file(3), llapi_pccdev_get(3), llapi_pccdev_set(3), llapi_pcc_state_get(3), llapi_pcc_state_get_fd(3)

🏊 Pool Operations

Functions for managing OST pools.

• llapi_pool_is_pinned_fd(3), llapi_pool_is_pinned_fid(3), llapi_pool_is_pinned_file(3), llapi_pool_pin_fd(3), llapi_pool_pin_fid(3), llapi_pool_pin_file(3), llapi_pool_unpin_fd(3), llapi_pool_unpin_fid(3), llapi_pool_unpin_file(3)

🗂️ Project Management

Functions for managing project IDs and quotas.

• llapi_project_close(3), llapi_project_fgetnam(3), llapi_project_fgetprjid(3), llapi_project_get(3), llapi_project_getnam(3), llapi_project_getprjid(3), llapi_project_open(3), llapi_project_put(3), llapi_quotactl(3)

🎯 Target Search

Functions for searching MDTs and OSTs.

• llapi_search_mdt(3), llapi_search_ost(3), llapi_search_rootpath(3), llapi_search_rootpath_by_dev(3), llapi_search_tgt(3)

🎛️ Tunable Parameters

Functions for accessing and modifying Lustre tunable parameters.

• llapi_param_get_paths(3), llapi_param_get_value(3)

🧚 Miscellaneous

Other utility functions.

• llapi_convert_str2mask(3), llapi_find_param_alloc(3), llapi_find_param_free(3), llapi_get_data_version(3), llapi_get_obd_count(3), llapi_group_lock(3), llapi_group_unlock(3), llapi_heat_get(3), llapi_heat_set(3), llapi_ioctl(3), llapi_ladvise(3), llapi_lov_pattern_string(3), llapi_lov_string_pattern(3), llapi_root_path_open(3), lustre(7)

---

no cap: that's the whole page, every single function accounted for, not one skipped. iykyk 💜

k bye bestie, go read a man page, it's giving scholar 🎀✨

This was the Lustre manual page for LUSTREAPI(7), dated 2024-08-28, from the Lustre source. Mwah. 💋 🦋