From 5b3868d9202440d734885f5d06dc7e52e23d7118 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Tue, 24 Mar 2026 13:08:29 +0100 Subject: [PATCH 01/15] Add author bio block to blog posts Display author avatar, bio and GitHub link at the bottom of each post. Author data is looked up from _data/authors.yml based on the post's front matter author field. The block is gracefully hidden for authors not listed in the data file. Co-Authored-By: Claude Opus 4.6 --- _data/authors.yml | 14 ++++++++++++++ _includes/author-bio.html | 13 +++++++++++++ _layouts/post.html | 29 +++++++++++++++++++++++++++++ _sass/author-bio.scss | 29 +++++++++++++++++++++++++++++ assets/main.scss | 6 ++++++ 5 files changed, 91 insertions(+) create mode 100644 _data/authors.yml create mode 100644 _includes/author-bio.html create mode 100644 _layouts/post.html create mode 100644 _sass/author-bio.scss create mode 100644 assets/main.scss diff --git a/_data/authors.yml b/_data/authors.yml new file mode 100644 index 0000000..73558e9 --- /dev/null +++ b/_data/authors.yml @@ -0,0 +1,14 @@ +Vojtech Trefny: + name: Vojtech Trefny + bio: Software engineer working on storage management tools for Linux. + github: vojtechtrefny + +Tomáš Bžatek: + name: Tomáš Bžatek + bio: Software engineer working on storage management tools for Linux. + github: tbzatek + +Jan Pokorny: + name: Jan Pokorny + bio: Software engineer working on storage management tools for Linux. + github: japokorn diff --git a/_includes/author-bio.html b/_includes/author-bio.html new file mode 100644 index 0000000..79e18b7 --- /dev/null +++ b/_includes/author-bio.html @@ -0,0 +1,13 @@ +{% if page.author %} + {% assign author = site.data.authors[page.author] %} + {% if author %} +
+ {{ author.name }} +
+ {{ author.name }} +

{{ author.bio }}

+ GitHub +
+
+ {% endif %} +{% endif %} diff --git a/_layouts/post.html b/_layouts/post.html new file mode 100644 index 0000000..f70b376 --- /dev/null +++ b/_layouts/post.html @@ -0,0 +1,29 @@ +--- +layout: default +--- +
+ +
+

{{ page.title | escape }}

+

+ + {%- if page.author -%} + • + {%- endif -%}

+
+ +
+ {{ content }} +
+ + {%- include author-bio.html -%} + + {%- if site.disqus.shortname -%} + {%- include disqus_comments.html -%} + {%- endif -%} + + +
diff --git a/_sass/author-bio.scss b/_sass/author-bio.scss new file mode 100644 index 0000000..48dce72 --- /dev/null +++ b/_sass/author-bio.scss @@ -0,0 +1,29 @@ +.author-bio { + display: flex; + align-items: flex-start; + gap: 15px; + margin-top: $spacing-unit; + padding: $spacing-unit / 2; + border-top: 1px solid $grey-color-light; +} + +.author-bio-avatar { + width: 80px; + height: 80px; + border-radius: 50%; + flex-shrink: 0; +} + +.author-bio-text { + font-size: $small-font-size; + color: $grey-color-dark; + + strong { + font-size: $base-font-size; + color: $text-color; + } + + p { + margin: 4px 0 8px; + } +} diff --git a/assets/main.scss b/assets/main.scss new file mode 100644 index 0000000..0b0e69a --- /dev/null +++ b/assets/main.scss @@ -0,0 +1,6 @@ +--- +# Only the main Sass file needs front matter (the dashes are enough) +--- + +@import "minima"; +@import "author-bio"; From 368a0f6d47a268a02c3bcfe75f5dacf53a2202ce Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 12:46:13 +0100 Subject: [PATCH 02/15] Add GoatCounter web analytics --- _config.yml | 1 + _includes/goatcounter.html | 4 ++++ _layouts/default.html | 22 ++++++++++++++++++++++ 3 files changed, 27 insertions(+) create mode 100644 _includes/goatcounter.html create mode 100644 _layouts/default.html diff --git a/_config.yml b/_config.yml index 9d51e4f..476535b 100644 --- a/_config.yml +++ b/_config.yml @@ -11,6 +11,7 @@ show_excerpts: true github_username: storaged-project rss: rss +goatcounter: storaged header_pages: - blivet/blivet.md diff --git a/_includes/goatcounter.html b/_includes/goatcounter.html new file mode 100644 index 0000000..ccb35cc --- /dev/null +++ b/_includes/goatcounter.html @@ -0,0 +1,4 @@ +{%- if site.goatcounter -%} + +{%- endif -%} diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 0000000..5a4967d --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,22 @@ + + + + {%- include head.html -%} + + + + {%- include header.html -%} + +
+
+ {{ content }} +
+
+ + {%- include footer.html -%} + + {%- include goatcounter.html -%} + + + + From b8cc5b8243b2a46466919c2437b359afd83fa74d Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 13:07:39 +0100 Subject: [PATCH 03/15] Add simple "about" paragraph on top of the main page Just so there is something other than the blog posts. --- index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/index.md b/index.md index 0671507..06c8df7 100644 --- a/index.md +++ b/index.md @@ -4,3 +4,5 @@ layout: home --- + +Storaged Project is a collection of open-source storage management tools, libraries and APIs used for creating, managing and monitoring storage devices across the GNU/Linux ecosystem. Our projects include [blivet](/blivet/), [blivet-gui](/blivet-gui/), [libblockdev](/libblockdev/), [libbytesize](/libbytesize/) and [UDisks](/udisks/). All our projects are hosted on [GitHub](https://github.com/storaged-project). From 3ca0ab9fea558de487e31e8a69be7a9848acbf1f Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 13:26:19 +0100 Subject: [PATCH 04/15] Add some more "real" author bios --- _data/authors.yml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/_data/authors.yml b/_data/authors.yml index 73558e9..838d2f5 100644 --- a/_data/authors.yml +++ b/_data/authors.yml @@ -1,14 +1,11 @@ Vojtech Trefny: name: Vojtech Trefny - bio: Software engineer working on storage management tools for Linux. + bio: Senior Software Engineer at Red Hat working on blivet, libblockdev, + storage role and other storaged projects. github: vojtechtrefny Tomáš Bžatek: name: Tomáš Bžatek - bio: Software engineer working on storage management tools for Linux. + bio: Senior Software Engineer at Red Hat working on UDisks, NVMe and other + storage tools and technologies. github: tbzatek - -Jan Pokorny: - name: Jan Pokorny - bio: Software engineer working on storage management tools for Linux. - github: japokorn From 6d2ae420dbe91a7a79557c8cfc15a99a852fb4ad Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:00:46 +0100 Subject: [PATCH 05/15] Add collapsible Projects dropdown menu in the header Replace the flat list of project links in the navigation bar with a single "Projects" dropdown that reveals the links on hover/focus. On mobile, the projects are shown expanded inside the hamburger menu. Co-Authored-By: Claude Opus 4.6 --- _includes/header.html | 38 +++++++++++++++ _sass/projects-dropdown.scss | 90 ++++++++++++++++++++++++++++++++++++ assets/main.scss | 1 + 3 files changed, 129 insertions(+) create mode 100644 _includes/header.html create mode 100644 _sass/projects-dropdown.scss diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 0000000..6a5def8 --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,38 @@ + diff --git a/_sass/projects-dropdown.scss b/_sass/projects-dropdown.scss new file mode 100644 index 0000000..a47e16d --- /dev/null +++ b/_sass/projects-dropdown.scss @@ -0,0 +1,90 @@ +.dropdown { + position: relative; + display: inline-block; +} + +.dropdown-toggle { + background: none; + border: none; + cursor: pointer; + font: inherit; + padding: 0; +} + +.dropdown-caret { + font-size: 0.7em; + vertical-align: middle; +} + +.dropdown-menu { + display: none; + position: absolute; + right: 0; + top: 100%; + margin: 0; + padding: 5px 0; + list-style: none; + background-color: $background-color; + border: 1px solid $grey-color-light; + border-radius: 5px; + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1); + min-width: 160px; + z-index: 1000; + + li { + margin: 0; + } + + .page-link { + display: block; + padding: 6px 16px; + white-space: nowrap; + + &:hover { + background-color: lighten($grey-color-light, 5%); + } + } +} + +// Desktop: show dropdown on hover or focus-within +.dropdown:hover > .dropdown-menu, +.dropdown:focus-within > .dropdown-menu { + display: block; +} + +// Mobile: integrate with the hamburger menu +@include media-query($on-palm) { + .dropdown { + display: block; + width: 100%; + } + + .dropdown-toggle { + display: block; + padding: 5px 10px; + margin-left: 20px; + text-align: right; + } + + .dropdown-menu { + position: static; + border: none; + box-shadow: none; + padding: 0; + min-width: 0; + + .page-link { + padding: 5px 10px; + margin-left: 20px; + + &:hover { + background-color: transparent; + } + } + } + + // Always show the dropdown contents inside the hamburger menu + .dropdown > .dropdown-menu { + display: block; + } +} diff --git a/assets/main.scss b/assets/main.scss index 0b0e69a..3d4520e 100644 --- a/assets/main.scss +++ b/assets/main.scss @@ -4,3 +4,4 @@ @import "minima"; @import "author-bio"; +@import "projects-dropdown"; From d5a8f3a89e00832a0c1186aee7d0e68c3208849b Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:01:28 +0100 Subject: [PATCH 06/15] Add About page with project relationships graph Add a new About page with descriptions of all sub-projects and an inline SVG diagram showing dependencies between Storaged projects and notable external consumers (Anaconda, Storage Role, Cockpit, GNOME Disks). Co-Authored-By: Claude Opus 4.6 --- _includes/projects-graph.svg | 70 ++++++++++++++++++++++++++++++++++++ about.md | 21 +++++++++++ 2 files changed, 91 insertions(+) create mode 100644 _includes/projects-graph.svg create mode 100644 about.md diff --git a/_includes/projects-graph.svg b/_includes/projects-graph.svg new file mode 100644 index 0000000..f5376f7 --- /dev/null +++ b/_includes/projects-graph.svg @@ -0,0 +1,70 @@ + + Storaged Project relationships + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Anaconda + + + Storage Role + + + Cockpit + + + GNOME Disks + + + + + + blivet-gui + + + blivet + + + UDisks + + + libblockdev + + + libbytesize + + + + + + Storaged projects + + External projects + + diff --git a/about.md b/about.md new file mode 100644 index 0000000..a620434 --- /dev/null +++ b/about.md @@ -0,0 +1,21 @@ +--- +layout: page +title: "About" +permalink: /about/ +--- + +Storaged Project is a collection of open-source storage management tools, libraries and APIs used for creating, managing and monitoring storage devices across the GNU/Linux ecosystem. + +### Projects + +- **[blivet](/blivet/)** — A Python library for storage management, originally written as the storage backend for the Anaconda installer. +- **[blivet-gui](/blivet-gui/)** — A graphical frontend for blivet, providing a user-friendly interface for managing storage devices. +- **[libblockdev](/libblockdev/)** — A C library for working with block devices, offering a plugin-based approach to storage technologies. +- **[libbytesize](/libbytesize/)** — A library for working with sizes in bytes. +- **[UDisks](/udisks/)** — A D-Bus service for accessing and manipulating storage devices. + +The diagram below shows how our projects relate to each other and to some notable external projects that use our APIs. Arrows indicate a "uses" relationship. + +{% include projects-graph.svg %} + +All our projects are hosted on [GitHub](https://github.com/storaged-project). From 783c1906ad3c1954a6128900fc9f99a9c7fbe0c2 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:26:23 +0100 Subject: [PATCH 07/15] Add README with instruction for developers/authors --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ _config.yml | 3 +++ 2 files changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a532024 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Storaged Project Website + +Source for [storaged.org](https://storaged.org) website. + +## Local Development + +```bash +bundle install # Install dependencies +bundle exec jekyll serve # Dev server at http://localhost:4000 +bundle exec jekyll build # Build static site to _site/ +``` + +## Contributing + +Blog posts go in `_posts/` as `YYYY-MM-DD-Title.md`. + +Each blogpost starts with a metadata block: + +```yaml +--- +layout: post +title: "Post Title" +date: 2026-01-01 10:00:00 +0100 +categories: category +author: Author Name +--- +``` + +Note: Jekyll will exclude posts with a future date from the build so don't forget to adjust the date before merging PR with the new post. + +New authors need to be added to `_data/authors.yml` with their name, short bio, and GitHub username: + +```yaml +Author Name: + name: Author Name + bio: Short description of the author. + github: github-username +``` diff --git a/_config.yml b/_config.yml index 476535b..23c0286 100644 --- a/_config.yml +++ b/_config.yml @@ -25,3 +25,6 @@ markdown: kramdown include: - _static - _*.html + +exclude: + - README.md From 73cf5f47758c84f35b42afd6c78e11abc06eaf10 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:27:17 +0100 Subject: [PATCH 08/15] udisks: Fix typo in udisk*s*ctl --- udisks/udisks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/udisks/udisks.md b/udisks/udisks.md index 441a193..4415a88 100644 --- a/udisks/udisks.md +++ b/udisks/udisks.md @@ -18,7 +18,7 @@ UDisks provides multiple tools and libraries for storage configuration and manip A wrapper around UDisks DBus API allowing to use UDisks functionality directly from C or Python. libudisks is used for example by GNOME Disks. - * **udiskctl** + * **udisksctl** A command line tool for storage manipulation. Allows for example (un)mounting of filesystems, (un)locking of encrypted devices, monitoring of storage events etc. From 2b8045aa6cea648cb84ab28c3f640be5ac8bc027 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:40:03 +0100 Subject: [PATCH 09/15] blivet-gui: Add a screenshot to the page --- blivet-gui/blivet-gui.md | 2 ++ blivet-gui/blivet-gui.png | Bin 0 -> 49119 bytes 2 files changed, 2 insertions(+) create mode 100644 blivet-gui/blivet-gui.png diff --git a/blivet-gui/blivet-gui.md b/blivet-gui/blivet-gui.md index 9085b29..56c443b 100644 --- a/blivet-gui/blivet-gui.md +++ b/blivet-gui/blivet-gui.md @@ -7,3 +7,5 @@ permalink: /blivet-gui/ [Source code](https://github.com/storaged-project/blivet-gui) | [Developer Guide](https://github.com/storaged-project/blivet-gui/blob/main/CONTRIBUTING.md) Blivet-gui is a graphical tool for storage management that uses Blivet library. It provides an easy way to create, modify or delete various storage devices. Currently available features includes LVM storage management (including support for LVM cache, LVM RAID or Thin LVM), Btrfs (including support for Btrfs RAID, subvolumes and snapshots), MD RAID, encrypted devices using LUKS and of course support for managing standard disk partitions and filesystems. + +![blivet-gui main window](/blivet-gui/blivet-gui.png) diff --git a/blivet-gui/blivet-gui.png b/blivet-gui/blivet-gui.png new file mode 100644 index 0000000000000000000000000000000000000000..b0eb7e05fa9058518d79121129ce0fc28e27033f GIT binary patch literal 49119 zcmZ^~1yqz>)HVzTDj-TXC?H68mq>SagMdhPhag>&Lw89^H%JaJgfuvWwB$%Pd0``XvOPMDH{5z~fcs@k|-#}UF zzkoMnCl$%}$a4b>e&E9+3lVt{B&4bsv}@zX;PWd}DHVAnBu{E2B!6)8CHTt!4-%3K z3lh?{5fTz#G7=KLeR{L90Jwl+A}c8d-ofiawB`P3&+MhNosf_)dhY*_6X`LC!Iw{* zrRBw+Y(FG?{)V=Ol3p7$f+Q^_qUQcs8B&i{H|1f3px4SG=CvSJ=H#s!Gp9)e>n_ecAhyKQxF;29-AL18nH}_9;WyGg8q6 z1bn7-emBAAaMwB+A!LRQueT{_+W$2c`tLPaRFvsk-#6M9oz1rK%j)A)$(w~1H_A7> z;+$_N?q4S+BlArRI<3j?wEbzae9bMC2%Q!>{`HPQ5UklwFvrm^B zj>anr20na6&mLc)&sXaD@A}%;zdb!HAO60=!ootb$6K=_^xCb0j=$wpucQ3eNJ!+w zR?nX6(Ga`hYFF@X+0eqi5@yKpDS^qEd4sLzxwJ;jE4T?o3wO~r-?fJ z-%qP&Qn@T2aH;Eecnd8tao5_U<;K~}7Jlwt?%E3N+&cX2=;hGV)~HXWS3y9cfX{^? z2YW?=T2oj2)lmK|^?#4hefI1CsqwVdSlWY7p*v`g#h#CphXez?`?K-xQ#K7l7)W#zU= zZ<%Li=y3gt$zxp1`xkGcNI@%`|HL{4({v1MJsbtMTX`zi1S!eJ6wZ}oiOEWtTqsS2 zMNNXCs-yEhJD0@JI{lN*e@!tK?|ynKo!y$Q#Pj}r964ymn5VuWZ`WG7ijf#r%|hzG zjMUxN6$Yy>E=I?CTls3FG@F7V1meWplwLN3PUiP<-k`i=xt@PuWN2-g7|L>4R`HW4o*s*rL!C#0H^90*6+nb2&eK9Hc9)Ag9C_ z5xUzMw0ZmN&X$^M4qy28nqBy|HC6Qq#>c;AxR|k*E}iR|dk$&bhQ7D{(SoN*thJvO zm@cnhz#uHARWxT8vrH|Q^Ia~F5~ZjDU|SS4G$GUFzgR3rNUY&~d#?|k!05_>tGg>=Y>LP| zj6cbycWl%|GOm-7Ctul4nXjhJW~*8fW9S%BCGESvNgQz`@ZbHL*V6T@&hSbWxB`TD8`M5mBR=jdwKjmQ0O>W+Imolaw zxnv`|xKV(nL&ohfYETSf-v z>e0Gm*T&wAgab*6OHU4k@Aa)a#-=AX!Vi-%RqYBxrAS||FG^;G-g++?R>TOkpN$2R zYHZgSVB`y(^6Ws23Dgoa|H5KQoBjqwT-;tEzLk|xb&`*oLG&cNy{Dd&K0znwR}{Ya zviyBkLr-i3Q~uy;m6oo5CWV0_q+lgZg#p%A&loN%dumx&)($;g3(_=LT|y|LWE&z3 z#$3Xl9jK|HG@TB@jII(6CJ)MIF&gyzY@%GA9r(%&4t{4q^B=EHeGOf21Bh4K=Z!R@U@h#3c7-u!w6mxrw?L>QD@5L>V?^dGM{Kh-cpNp-1 z?I8^`pQdDozaRDpCBmzUdem#nzpkuMpclojUY^jfz7Ct5Fr&th+b4+Vvv^TQZnjLMnr`3p4O%i_GoKl8#>%&WS5 zZXaVTQ;!AfKMf6HY-aeN1S*jAmt^^FEJ&*+ci3Y-^YwGSNhx~XwHg+N(REjMbmxq> z2d_0BxxQ%BQ%L<_Hm&7%5sD^ll`u#%Aq1^A{yRXkJ&c3-jq>faS64)x&eLey38Cib zha{5KEd{U1TPpt63q!do+BQCU4b{y|HXZKRnH!mm6)D;oWU$2cZ4tT)8qm?xch-j{ zN!mM5lrE;79Vyk*Q_pA(GoQPBN&3s>gZaJ* zA2q(JieAr;&ooXe{>V5s^eYj}9Y(($Xo?HP#fZLYE_tVg55BVe_U-x@#tio8c#ST; zdSqxQ$6MgiY;+sUrb@^!M)?uSE`CzE@eGi@+FYkB?DM}n1qtOTK~7Et4A>zPon`Zg zkBeoz(9=KCrAdtHFbaz2Ql2_QszNC;$_}gsF(HeB&FqIOXlkq!6o*&O=rBS$Q;M<- ztnmCpEe|RyxmdSgy|pq7%kBJ3(0Usgn9POolniRUZ2^Unf{Y_7Mu=z~m<#`O&+)Ky z&$zw}Fbm!FP#j|d6c8Kjd2%D*>pi5i?@Aj5M)u+805N4yy`ir9c>4fE(ir18j$zvp zBD{Z?2jf%3;C>gZpWSo1sX{Y`tVI3a*UQ{C%K!esR95=${V}fk=YOD-gQKD+|3fOL zo$~6yEKk-aiTuo=G|s?jQs)9 z7|mfSS;M1+7H59u0t7@s;YdJBKPRy~&8ViPW~6Q2)>_!TOvS|&olx6%j*X>0;>l2C z1D~yz*S2I8ztH_ww(00;x+-Ox5G*WYoYfs35Ptu3V+ubfGB_$)|EFK*hTaqkMKuNn zGaT{{3VPRUv=q(6A4iR|tBrWR-HiSk*YPH%I?jYGjRW)#x2V*Y!k;iqskPicYG+zS z8#7yZb;t*m9+mFCZzLFuw7odEct5LM`1L9-+a5WCnWQRsxv6M0b@;~J)YNSbE8CGQ z-BChUMW$X^Lq)EXi?qrnLW$>Tj?A{DKkDtdShOwtGkFqY&rVcCl9OFmxcLnhm?mCy z9NPss*9r3zUuFFa*g8e2G&^d8tupUUPI|qKs+!U}30I6*sbm1cZ02UUPHMEcVx_)F zQN0IWi$A`&;^2}1K~hX?jYUaW`LnRl!BkPr@ptRjQ7}t@SIv~Ql@;{#NKORd zGnFtb;!R2|%pcWdZA=jXgCf&8qEB?{J_VU+?+#l(4K`NN&?pSY#>9+WN-#^|*|tP~ z?DePq!~O=J^t!-bM~$p?Shbw>!yiKV5yt-7jQP9rT4Mybr#=`TD`#XC6fi6@J*eFl zJ!lRN4#r%%LtfAjps(1!efV!_ax8RD5r?;osB~9xiM2Oa8Go5U<_l$$4{mV%i&yD{%fhaJPhi=KA7jYpFvR zG{j*$pKRP6e9-+uc+z86`0iqqAhTr(vtFEc++B6>HSphEA89u^zPY(NqrpLCwfR*`q~GiMB@JTen*t^GOOGby zXLDE)L+_p~^|_yK3`wi$a?{I5yQc{d#G%e!W4lkk~4fANDn?EO?0FT^loMq4gQk#K}oMQyc)hnY@*UVm%liD5i+y0u+BB3??&o(1z-9& zQ$gAt{5(Qv@io9UvP?~1?0JU3C?#vmhfh5XfuY5AtG`m>e1n+M)Vpn=brLswljY5Y z3xN%66=i6|R9fFL#Z+cHBH=M;A-#hoF}gJk-<&Ne-re4K{Ox>_!eNP(<#)^5)YMdK zIf3F2;Hk1QCQ^*R;ZuAA_t(B1ewC;9xf5?fK<6uRA1>UYiB7^3&*fo61+f-rirn}5 zS&+DRenG($A_8F+oy@%hzqwj?U`8aj^ws)TZJ5`7(-VI*=2m+Me0_bL)#wLO`}qo* zZSxj2mB0()QW8I5jo@;iYj}09_M(#FJ4NocDqY_B6DUn2Vc#@OI(^RfEdVtF*t1u<>cpoL4Js0 zKg>C^>v&ZtpEh1+rCD85lfqlG{ZOUN3;$iIM!Ea-0W^inhG8%CG%g$SZHS=} zoQo#QokBY$Mc`~4=CXgLOX$5#J0@~WJ1~Gw%EqIU<%06<(6MmzJeYH5`e3gN!E5>B z*@?!qN6o1niDGsc&htY2d+YWzPQ}x0uwCzt5zfi2j=K(c(0+c{p_L>)qmc2@XJ{;> z)*E`VhuwCjr;i#D-rp}}@#l9ZIw?nJ*^nHVE)B$bL0`XiYF6z?)jamP-?>%upvw?$Cq!szB>`J=XjI1%_rp!5Lk`6{;h$WmkaKeQQobU}Lt zJ?gF&|6tAyK#2duR!M_nQepzQnK7y+_2uT#syz?UA^|STDQo_$R-rn3zM9uA3;K_b z{u3Q@m$GlcoIO{`J4SDQZOXgFa zv&lT`n%!c5GpDd|ig{bY#Ip0s8FYfG=w>rf=WYB)7g&GVMrL!{^43%U5qsn$acrp~wyFa=!(y0eI8o{S+n?1B!Y{b8j>41=SdwxlnAD8lHElD+w;NTEX!x}Yy z#pxxYoahUis}|dZ8FgTv9mTZG-#@(HI8Pbr8qP=Ok(_28JrlRC5N3_-z>weAwcy%e zE&zrQIw`B=z(b;Lcsg?=sP6hGkrcV0v%WYX2@ji?I0Uv{qAXq4mvdc$+gow!%|k+M zlIp(deKMV^f>%q6s+B%A2c>71ol`MUA^0v8>GG2k+RZy^Lyc1f+PW2NiBynx8@W|d zF=jo24*nUv(^u}i5WL|*|2`=zR}XLIRZM&ZW+kM&_IOB?SnYl1s~n@RYY8~$-BoRA zkS4eCw;JkJ5wP_|#J8w3P0NB_ab`PXF*{*9y|Lt=o%fM<)yV`F>Po-#s%x?gPoPNp zsUD4u4OvN13q2m_B*CAN2~a-r{L37khPZmJkje|Hb9=IWXNZuZQmIQ;k7zOtn`~1H zO6~XMBqc2_FQE3z(ipN-w5I47T01yWp+#2>ZW1YI@5`bpMSWZn27FY z%>IxJw%XTlj0*%48WH z_svi|x0q%&wZN|sj1-@nK#D%BR>8uGFRrvT)NF088*%aIr8ZqGnakLTa3Ic&SsGzn z-J7o_+PM;{Rkp~yw9?6!lE9+3%|2u5j1!~phxZ|IBNF}L<~m_qwl!|!%%45j>Fq}Qc^c8 z)F3xvH4==Xf9YCiXu#m-CyCY7NMtemd|z*8-1;JuF=b?BzcZqBFxyrl>hE_P1qDbM zh}DbVGDFvor%>NcX?qc*RR=~re_MRt-_Y!zXX0OIY-e?^hpY{!=Y zGCFyE1bv@7KA3%v(-az{_t(HGC+l{Q%#YTD9d@wa2O_9)x{5*loZVOvUipRDh*-_N@SzAn$ zAEgwa>g7E@4vr++VcuTfY({?OQcI=Y7CqB;s0ZECnhvxq&{ z%{$7}T~FfpjL6S`j#VLOXsL814r{*=@%d)aZ)#MS{dgXY)y+Y4W@+2yK2H%bYvA^F zZkg}7SUI!u4ztv;9)kB^N|F!?8u(Zyt*lfzsd!wZsYtX|2Ps#svlr_#KpPGp{G=Ej z-VS(5X)xCns#$M8K(9;tVy@PD*W5?>OJq+*_h*v@6bqMws`7agZG+@`ZB~W_f{FuA zn;H|X>eqUuB#h(pWsH$Zgo|@Q6{e~$U?qE5@!PrJzi+-4Q8&~0DUt4GX!vclL7#0* zEaP!SBRIHsP)i4WI?;4z^{gGQzDbYyxYq4=2O)PA4l^QfzSm8z1%D1>&?5fOL$Awo z)-)`q^D>mobd@XKsApr|R>-sd?;+$42aChrUur0Nf%PyNSbB4Y3%6Qx1iL=1QpXj8u`m+FC zzyoE5ec%=|z8Kl^g)MzMJm?=Gq}|o68Ke4M?;jwB(O&Lw;p-t zBaHv?7YbBb75ESA%cEXR!x_(8Sf#nW%H68E$iH3Fp|4bBLkzD6(SeGJdfCxStId-! z=V!%3Su?XYW(CMtadEuW>au`{F0?dBHE(;2TM5tBL}SikrmrN-q!4Q{svCB6(xYdt z)JyH7hZM%9{E0LuW;P%Xw}p^w{%%aFx^8?!@*LTwW_}Fm(N{b~4~vo2H*Jf*gp)$i z12bkU7tQEG%|d}){)Ep_fb;w_Khzz9_5cS(Zai<@UNTT-6pu{h1|!J^eT)mHPr0V{ z#o9yZs%Lx~9{j zS)TiK$|mycch;CIGS39riuR;sh`~Tq!%{D(nz(5f-rhu;EnGgot~R$hZX)-)4SMe3 zL9$e-SUyu;T>Lw1(_pO&R=INjH?V1#Tg}!lxJtINba(N}GZJE$(NDM;^XlbOv5sS& zoi16c)@b0R?9UYxTRkSs@t6&QjS0{NwjLp|v9U=jj%GJD5?DtJ4x$1E^l8Flz$XBd zWciCBq>nes>Py_HPzGwS$erh95+`M+v}J+#E3G36ewwM?V4K*FubTFwu0NK(KS4Xe zFN7#zR)@I|>n&E6m=($=rLDu6k994ktuZYdBBm2aMb^hP>%VGROF+Y&t@gtz$k|_g zZg7GXKZUPBv_HJz)7B)&vC%*$P3^IlwiE7HlWaUFe?Zs81uWIwLcwSgG1=dnq!RzV zsmO)1dup-(*Lv3c9;@(1%?n(ZIn)}M->ONMjEWqo;nQ;koqV%GA|t)yprw^=J-t?a zBx=0x^#^m&^UQ~d4?%)-dvRQoUr_k>GGbIkS$QBZ=EeyE_1q0B3Ol>VZzQ$y(fAO*u1ltWhAfUw`5g zY<8u7y*Rp2uKUUQZnP-t;qQVXsHxH42FcrzQoD9}hyv+Ah9G3wj}P15&dFk;Oq#1^ zbGXQ_qn$y!KH%J)Tyl+LA`Bp!039^~?tNoEXKR>0c1-2eILPJ2R2)$WQ|35?S0c_L zJO5V;@b*_dLMkS+ZEL#i$=23ZosL3qI#;qtpu$F*+fpT@T9@lwAet!e)4W39s;)=M zt>_yvh=@*WjfPZM1Z(IS->jZVoF++*mD3AG;+AtnIO;F+-tP>|awSXBv$a-VvdM-8 z*KV=O)T0R?BCGBe9QjBj8O!Dur(Y);3LqHr0_k&e(6t@5k4sd+kz)AZ+3`5|lm?4~ z=gi@><+WOxIGw9({W6XRN7EV0%ezcMg^Y|#d(EWCAG8gIe^z}E4TayT_FL|i>Zl7a z1xAX|jQXf|fPrlI(AoX1NIPc6qi-87qFaMr3SQvn}K8F8t zDg7l)Lo#~To)TuMom@C@oU-IN{_MueMpH$nuWZh#X)WL=^u+VPQxKiln{L9wS9T_v zRQtA@4)9CDH?2hQ;CMxW&j`m&Bo@B|tY+6g+1MgtVvp*Ik^c5QAwL?h$Z{MUDEcW- z#B1fN9nrn@W4TxdbO(K|uWxh;zo=V8yg1HH=sGf5Pm1JfRR$~a6X*{15u0tEr&8 zZ|RnVsNcYcQ@i?4mzIW07}cTY9~>TQl0n|RFQfb=FVFL##uYiA>Wz4oRYEF}%`@6x z8js%Tx);}`%ikCO60H#@O-7Dkiy7PY2R^NSZ zxZzn)H-lbnvePJ^C`|xxdjT?u=G|l_C;9MXR#OzT&GPKp{A>Sc$b3F;d%NE^NHzRN zIRek|>Ngb=FIVOlttaF|Xn$8C<375T<&DqZ12H5JjW$oT&1wgnC0p!m=vXg|Rg*zF z#$mUXn>~~(pytwfdXC>K;Hp698`D|u7~xffGv&d$L`@%@nAXjSGT!iU&3t`>CGZzi z8Lu{_+Q>q)ye^2^C;IRwxJ7)YbPzLgc1TNoz>;)@#fFDss<)JKf(1QruH#YD_KCL) zJ>#zry^~ENdtaW6%Ji;t5d0d0u02MsApI)U!oZ#L6z7rLewqpnBO-ckXfObeT|?c` zvxvvwu0k%WRkZlv6iG!%OUhM)8c7%JP+GRsQ;3$8mFRsn+c@%DTH0?%TGG$dC-m$V zn-k6DQ^m4gJbEzCzi%vI;Emj{=uTQyRmGrN6$jsM@@p`2;vq@5*CQ_+y~cx86WHq+ zl0^S{-Z2ms1_*EVJ9nyI0jiXLop*oa7RaVF7-4D}a0S##MD-61t+gO5YFuwnK;f_G zexHbm6v&vAB0IOboQ|MH1=`Cg3TjL$>UQg0Y-^zZ4w4<$(k1Ae&wR6Z-5$x^QR#DV zb6J)#+Loc)2X9grt{jQ6-#<#r+o2wQ!D8ua6l3OY;i_HEWJx1XkLe$SpLleTo4Rbb zJ?>b@R8IQz?o?U%*g=1NaRKp&Wn=i7NLW~D&%HxP!sX0QD_>Dh5G|xDc_ah>(iRc{ z1Qwnre@6VM<(E_GC9%+h&(CW{x0WhjC~<1!`=m{`9^Fz^v^i1%F#>Itx5gPh%7ApO zl@B_iRX7Fc1F#@4@x_hdMt$3^Wfn=YSW#|jyLAn6=Q7AHd*sLwl5%!?vr((BxnDNmZr++Adb&)6=;6`&eLNz zu5ItIP*Q{1^Y37*ij_fG$-jSA6|swpU-450#^M|PNWVZk)7mJMukIfl3Kd#ROsgOs zF15Q(v$AVWRN{$bW{RFr5KN(TOdYEd^&-36j8Av&IvB%CF<59h+-N~KjQw?THUS&- z8iN4P%OO5z`fgM1hv$B_s>7j^@tX?QDH2;L&zmEGTw?ii2>EIoH}#+A_m!bQrajG> z_b(!eHT?ib*N=c!GdwEkOY>$~7v-z9Dh3E#V}F~r_0vK6$NFbrD=n^ zMXtD@ESKT2B?RC)C@98?TJ+P>uz~=uh6w;`7x`^)40s1G5~&E8ef_x-!dOo>yXn!A zNB^Ff`|lb^2mi14|H_9TWEaxl@y=gw4Qr`)y*|xCqf>hZ?(^%(R?$`#5$VLEh<%C? z5;)7VPyEkKiCx%f&7ozL)<<_Z-5OCrLZIa znfyknJtu#{bYF7_eOtUsKEZL&+q-Pv_}9Jls^$xh z3dSLZ)qV<2_!L7Lj7;#nBJO$j&lKt>R7#j@%^gCWl86rZv0&Wf97pv*#20qz=!C*@ zLdQP)%uD#mxrrcWyEF1rlt6*2-I~^ujWh<`_VjnJvOyg%wmV>SGtUNI|E~l=CP)+m zt%2`YXo|M_SF)#H)78!=1B%!dddW z6C@-g)bqVquk%Gb!=|>syE(&t`iOwf`K_YR1r;da@#z*MiPO)F-{rray|rdTnHN!T zl_X(xC`n#=Mz5wYcllWE@?4y{_B zhDIn$5f_jxAwln6{Wz;JKZxI zr@vzqiy_sO+BLzfrhP1K`+CjJTU{H&X>;{9#7Gc5$7d-iDc19ivEY$}7U{~RJHJZQ zOV2MhvuJ5)jr+g8o(E;NNOEBVi_%FY9fN@bn#}OZ6Q$})!%EZ(QpcX2*qmQwEy1XGgcIb(TiRrGtUXBQE>g~7gFj2&^Bw0?+O)`R24Y_t3_ZRZHviH8b zjr95rl$E4|ZZ+nZEfLz@q$h-GGO`h@@--Tts%?lTIKspz#D+e}=6_->Wy~=O9W;7r zmtMK3qlSfzZ8_h_%G`cVu`^Ri1IkKyF+!;U0S|7^I_?}m6$_LkrRC++Yhs z7ehhq`OTZ4G~4E|vn4-6i;_vl8$reQ-q=A2!l7li+(u9{mW{GJ>D7eu_Y&S`DPe{I_BDw#t zHq5>Bi9n>61)T)riII`EMs4p0$(M7Oa;~^~CCxtKxzLhPR=T;lIk1A6E<4k)iHW_x zI|HQ^6`vSQ6v~h7p`xOG+S3(Gwx0d|St5#PYd1j$b*AzMWI-AC;K>SX|K0Ls;%xnJ zwHfTscvCzbpjLHf$cfqTxMq8hTz zS*%qU7S_g|oLnaw4qNa0@q>eMw>>dWg}+Ij3nKhRs#ZL$IJ{L%#D)F;WF3jUB&JmIUGbp1eF2E>Ti8h=y&I;wlw8Gz|6|kPi2u{13Nz8@lb`X|ic6Iw*uY zuQbDa-%HHLiGeTG#)&xlSTL^N&<7^=TwMQ8v_hqOLZ&8Q!2C>l;0X?k+yoT?`szvF zw3m{0t2?V`FnSKCUe?+zwf994%TG}8@}}4>G>?_*ayPpn6f7-if#~DjwRYTI5EgXSXWz15)kAn^U+|VrMl2kb}`OGsg(IE%}@s{CN0ca@KaTSowH= zp+({%E-vnV0f0-t7h9C5@1O3$oo+8SYs_Ftf)!p{1rUI5(!CD{?p+>OIHx{Bi=Uty z(YzZ3WWMLiM9|{m;?P@zK$Pbc1nAon|ETTfl%S&Y8NNrF8Gk)r7^wSd8V0 zlX$GfmTA{edzJyOdo(Jnm?sf+-)*2jIQ}!1*SF&XV#qPLUxPP^NnZxk=R+glymLRe zm%K&K_80PmEA^V7Qb8XMUPEV^U=)V@d8=Px#~Bd`fm)H zKqd%_LI)Dj6?5vYmFX=vaz%sZmpD^EZ$XE1CR@C<|%$U+5iy7)8!FDXTVcu0A))oU>+PD9W!!1 z0C!Q>h4urCdkfxR7nKx;=(uZ_P-C-6`>$VTQ4kV+UQRvg4KySYeUJ(FTXjuLQ6;Bm+BvWh4vv@KH)e zQ-Qb!L^ji?bii3t0-Glj^!%EZrc1eYe&Y-Hw0mAxPg77z-)pZfl1wmF)4-!Z!^7`# zi)O$5$`&+>^_=V80a0*#*$U&f`!%%E3j;grGff84I|&Kutt~N{GqcB^ ztC2n*I+9?}$fvFUgl|=&A zGgfP<3Wj*TbaxBQ6_4NnxHGRD7j&d+^oE;zWjxcBA__9wMx zD=_*b;70r!c3dBQ-Cjn`wiwN91!A05uxpU+duKjOMCSe*8ASMAu&WCc|0M)Jvvt%8 zeGUk-yiaM1(!EiKolI67OG+zDKobn<4FThEhY$G{S#6>}%m=O(R~~SZd;dk& zH1y#FxZ!0`P>`O>l={3EqV1i!TUl=ezGREzbD%rwxL#)-$`s`P6+{otnSdD@t27i& z0vZ}~b86oXVZO%ONcIsxlqZ7)I=I}aobg~42HS+sZC~!>TQ~%SfX$H%kDHSjX*szy zuP)>FzDjHCT!7h(%w;C{mME?~)XKfXaMtE*+-SH60Fm@k`&Y`40n)EK}PhkmxRu zYk?HO^rqA3)G!SoGH?_j;mM%deMFrCxB*CA#XYk7j{arZrfRn=10yW%ms>>_M_G46 zmnY4||8UXr+5E{)Oui{JdTn#Fl;R(7InNmVuLKGzT>re=|0`que_a0G+yD1+b(Y@A z$@@fHTpS$h*H~e|>_elD_GTRD1|Nc~7vv3`b*ziCT5S>k8Uw}JqVM+f0OEn;03Gch zJ;rC5XW|Ay{!zASQS=8h?x~i4s4t+|cMtzx8V$~`{8&BMKf0|qGq$yhI=ET^xwUa> zEQ)3hh|rxZ=oGP`BTOI={mt||^%!aU_=tPK6>5M`RnqGJ%|0UZ!R+?X&v0hPx1&H* zA3{+q{upc>uTg_Wy%8U@xAjqGAUoGS@q_33gw#J06`@%Ez9<5ij2ks&<<2LnLTeqW z!kz2Rm>40amrKswEEv)$z;}(dpJUNv+IzR{YLd@LhLkXg7lVU?1pNE2=>kQVnoMx;v;4?tGJj^d>~R0}ixHBrv?L^}3~8}#Nd%Nkm3J>H znfDq37$XSPTB};RM@JsVS*vr&kdV(JP>ekSr{Ry_dFQYUzxCNn!DQYYuZqSslkst) zgHf8SLN)?`z1S`XVOuksvpVZ7?rVwjo<~u&c5pm@$=eGa`RZz|R%cp|G%km&;!@sv zO=gLx*4pXzooTxd^OP@Cm6gHqwPhgdtJ#Kd)me%{^b&JS;vh37aTMS13I*+B&p%vNU?2B9D$QbRT7s;Whxq)_>7EU;2cVC zpO))Fvqb`>q@{D@)404(rZhQEVIbA%3B?5R&seb4fbz1WMgd4@c{_wNI~E;?4}68~ z6wdK!o(o|5Uy*x<>fU-kyvsZ%fA^H_{WoOu<+PD?RDH(wIga27pX9w6FTVP)`!sm-8 z?NutL6#=_B`n@-ng)mt!wx)pahipIa2J$r}WdOh#fZ5U=`Up8s+x~W;flL@ct0~~L zx$G9p?&pXIiJxzp9S8M+x_)O8li^5X2zmLhuG;U<0bNt3+whrep&1MH@s`_eRV&v) z)E^<)B*xV_np;A_kvWUZkv+GC?u+ix&OJv~>;6|=@EJz^`p9S4OWBS2k0v;1nV2eS zoQpC!zM?U;MG{xG1cTFF1vY71fRI#D($dNsav^lwrk(e`(w}!dTe#keWZ#<2AvH5I ztMi?C$mqsGum<6@+8QfITUPoCj+h+{ewjIKVG>_^iIO-zZUQRn_Dy=T^=&}Ivm>l;1kD+i|aKV>P<#-L2?td7HDwAH+Rs&{m2#naa@v~j~1&TkAQM1_m z;?OA92^!VpBz1Citsen+#WH!Uw}OcIpb|e5#5DU}cy1aqUM2d3Yu(1A2Um0Y#?J1&065*TaWy|D zcXKTpj6tZk`pekOF_m*Q&~0%AjxawsMq?h|NY;pK{2P#p|L#f7e7((Tu?FE(N900Q zGY%$({!FD3i_}3q1q1AZ1vfLclb2?NPK0)y8sc`{vFYIAx~FjgKxB}JC3D-6v9hv) z)F5m^Q8)tx`dA3$$-9X{{vs(`z*ij~05LLB|KQ+w3Ux@iT1Wh-?a=&D12smVu7bjc zUs>$xmJ}gUdg+j9D9NzjqF0vvTdB7=A9ki0LAa`}sZQqiLq=+H+K@N{C&>U883lBz zL_YgBFQ^^#vV7YSFnOjdb*CGe|YJi05x85i%c5aeL=NOA*2XvcamG zv?r#UJPDsnm0cgj>pzB+Xe3D;Yn|{)yy53hJ6MI**e>u@S634N1iA&kO5A@+h4lFG z<1r|}j{ou!z6mkc?k#^BW+^k>prDPsm%O!P1pGJ=-+3GA-ZrZY7ThVxo#ngE0C}H5k zcdk;|!E(#Mst#Y1|CoI&A-Onae z72fNxy{hi_FnYw^X+k>8T@Qtw^tW*j?RjKSSY%~au1lFaX`FUQcWl`0^p zfO#CgOHpvQv}aduHWdK;A7`dh(*gmUpFRcdB?Qhm>M^+;^A=4=za^M&ih&JB+YwpA zD6pQ*cz74Vg1~X|`c5`Vo{WlxXzs8B_bRz~DJs2Hz8}lZMkyLmn|YN$(&^khJEm+6 zg=BOrB8(EeB->_Z@3}bT83Xc+6Dz-Ml{I_p%_DFy8+ZM4s)*lw<0a|6%JOKw71I0FHTA_MBv3$x6-mmU zWI0hNe&%zv*FXroH=qZ_C@^oc+W2E4N*3>UZu!`Mpr-{?hZ57}=H}wfeE;>oT7Zv@ zMe9?g-%>QrHkj>7wLbxhn(pW><_sJI~K7}|`D;4C#D5I)}5)F?x!-m~^ z*;O$|Q=dLv8pZtC+ zT;#M@TC&Z1)Ie z$0eKuD+d1bo84MONMQb}pz}a}!--0(Cd8Ee(jPC6zn`z(G2ewx88_%3|M~DfRA(~9 zK%H|YjCg90bW1%_f?F=rz}?fsv<5!vB@jO#8W8?+CZz*{EFUr)GU#rnE_CxNnYLyp zf3tKR=hK61FIjdAzF~R-oFGx{bp)c5v^D=_&`X!p629-+Fv*i@co~+;m+a{2V*lXn zpCbz|#Ah;Y6s)=U$@cd*zwL9%C}FPf5x-m>5M1znTbI-kb9Z9(8i_q=oz)|h+*O_C zG#j@x?>Z1(vCR<5xF#Hf60e(E%}|x_K7#r&?U$GDLwAVP!Xso^Qsy&Aw?=QLJ9GHJ zky5c44)4}BCbsLRuPY#khQz-&^>K7C>=-zKAR^)DY?KR!&(Gl8ixtg}*_Br!DBa|w zkMKbD>FX~qC&LO2vyEsO1qEaCJV#2D!p=W)Vm`GES7OPNIP zAM@5vc6xyn@*V%WZ`nB$LBRHb1sNGxOv3fU-)v!34fFM7XdkP0zs<W0)Ox^kWR1pKg{#N57{uGwo+_1$r}GLld@)*(KV>S#?`qfEQIJ4W8#cE_G4 z9g1>p-3hUtRTIkiaj0H;aa~$j>N67VL+0(A&W;}CbNvj=nxf#9K$hPL=b7*!0Zg;p zeEN#q9`W$S!H(SyvR0ir){egGcOB zWk^8yfOTPJ)*bF+banMAoxSAYOinU2SH$8lAZ`7?CJIVQFcJfkW~N;1n8}1ighnVW>MO(Bw5h#4Ori2R6^0 zIpW-Zem%Fdfx-8-{n#hzSda!L?uu#;+hbwfaz-XzF0{4M$T|y&DJgI}oLwhk}D;Y%(>+$lk!jT6JujQ z6=&t>DAvyg_!)7}rSg=EE{QGwd60Ez&}?O9;uAV&=2n@s60>G3{@C3+U>raV0LVA@ zQwTsfyZq5jzqdoLe9@NuP#79o^V&B{Qcy&WU}AD&d*`4w?}9ofCoCaMydzSlYku$> zNEcb(|GuH+zOMupE+ZAzR1o1FJ$Zuh0pL3*&0oKM{g9H<>*&bI&D|Y(?*1_`B8+G885U3b$~8teu>=Zr;54_{o#L8fRM&a?VU3HCCa8pu@+< z=l}V0GBlo04d=b}@hD&4>(H}shAbz()d*nugoFe@gJL0-*@nbe=XvzPBn`~$NLZ@z zPZR45V+98X+;DA=V8aBruPv0pU2Y!aT(4udtT;4PL4Gl`%4Xpa0B( zz;0*vmVeONpGILnqy8#(QjQjz;Xk}AaS099lb@u6YIM1`u}_m!G(6c``BVa=&lU0M% zSyIu@KSJ`YATK|cSLqLOBYJu)G(0>!At51D`;mz$1hyiQ-32;AYJd_~6(l-pE}~tv zTKID(Ch;OQj}{Augw2ZI5`cD8^%6+L`~((Q$>`HfK1$!L`KRgnUFtr2LD*XEx){vT z9tm4RI!xzs;a?S&Mv`A(q+an$b!$1&XHe zLyi1GLUMAt=21VjIczW~DVkaRXlFD$1XJVXiG?_a->{iqEF=wo zs2H}w&c0_Ioq$%mN7b~Q!ZC7Uiojw8|6{@G+EjHE?wva$>m20nN0j{0=af_y6o2DP zX1A?F-yg7r{cy+R=H@02vKZLik3b##bXiMPAqA_jdshYzn-G()OjhK~%4{(s!RjU; zP$CP7lu?bf3KFHt$w|pE2}Xx%S6;b5qb*A=RU3uWLB@Ie{{3a_D}3`@Z!!(sN<$Dc;M-jFW!vgq_FJmB^4 zW+fX|Sn4TYZ1TfhMCvnqKRPs|rDM_=`O4NDan5^q}kd~I#Q>V%M zY0`mI5>9}5nHPvTYJvWGZSBAA+th{i$M@i*NOph4i!5Tej)`9Evd*({+@UQ?kb{b2 zk9Zvx#wqFy|AK=;z1E8{v7Zc{(29J6nWy(?tnA7Rgkbyua zQ?p~-RuuW_r8ZMvAV`g=<;ot5x{v)dJ~}#*m6!juT3C-#ZTp9YI$}h?=@s?Ts$h(O zwonfGmo#i_1hktB#SZK0$P-XUdu1lLU_l6jE%sVknwpO<4o+CWcRHbW0S&`<$2*Ho zuC8~9h+3iV7I&Hn;|lE&I3$@W3ZPBVWe>5C8E$3H3zPgIFf^d+Gk&~D0qhy5RZz14 z6{GX;;DG=Z#>aZRyw)UKE$kCy^j{wYX~naBT+fMMtmR`|t>Ct%m7e1c>8Xj)W>U1+ z9M*LtpL_`!Q>&ZJOZQKX2R6}EP%MNk%CNtm*6!!twxN=?zPBFy9;Z1@OR5NM}NXOgJ|55g-h5I4G|X& z683)kdzYK_OEFqn;~>Zk)!f!FD2YbYp9f6ph$$$M9GxmT!#W}mnVr^l^U5%#rR93y zfV5q$YB8kfZm}r2#xu=yMiPsVkbQ@in8;6~*$>Hz+unt1*U(z7@}&f9D^x6~dJ;a0 zC1>c}9(2FN={Tb8ItGS~gLGhG;xsjx>BzcpFI$9&wr7(s%@d7XTTWtZ0>TK#t=t<@ z9I?UBB!=E|K=b=qXxb!WT9=q2^5@TXrX*(HN*u4J2flo-SD;r zd~aytHZ^!%%Pw$OhF|RZa`lI9E3V-mwJJNhSWe5oTeD4WaQf;Q8iq$keuAq59c5u* zVG9D`HVPl8vNwHt@0M7|gJkzp*1^AtZaX(&fowVtD_#H6PKkk9!)IGfc-X`&A7G`B z1~v<+tCK*F2SxONpjs^v9GImUgmGkKCtQ}U#$EkuXS8wun4|7{g!sJ#64k`s7j8$7 z%KRtrgSP{V>FE2HNG%M;$S(LQW;%^H%YU-p)#z4T-z8LM8@ui*JKg`XaryqrTQ)o4 z{5_Gh!Q@?asj2A02&H*1^hF;YJ7bHvkK-$nsEXtUo~iUWhq){nE*zzJU*@s~I>#+a zD)Ua?9he$G*1x8T~;od~r@(tz;<6 z-EeX^jh@ClTUI6@P#mOWzD>CzFRNB+fL@=c+BGBSV|-`K`zMvyGh!TK>_xoP#t)6} z_;#!1tdDDVnv7W96-5+ToR5**q@SIgy^e{wJE)?)4K5TqC8H>j|9v*2+j4SpC{qGl zG9JZIW=NT0E$At3@w2gg`+S$C*r@lBou(n=I(F-0gd%c~E-t`y`uh3ZrJ#_Jl9Gy$ zt3h+vm{41Ec32x}1hzsiTQHHfTNrTNe2a8juP&x~rDtRmn~!q<_V3%K_a2aOsTj7; zd3jHPiy@|`_gFObPW5CLl>d^@w<6^*dk1cSNDY-cFX@GVlMu=J0jMDnW#%2Zv*q9p z1)Z;F#Ml#_m*-OPJQ2|SH)Lg(JIx}I(){Wt>?1enMvr)VT@E3|cUZp@6Uy$|(bP^< zB$6jx#8ocYt+Kt#b5|nfxcXUDHJ(D$!uCFupkjOlp@(!COO_AKr6g@)^2I@y*3)Ut zcHQ$8Zd0v`Q&rhg)}hlF!VqM(&8%+)uAQc^y@pzTV~OV_Z-C&HZ#%e~_BHo}6c#tb zZreZ4>Wt@&g0)v9(>RrdJL8r@XGBm z)50r@h$5&!*3H`4O$KNaTsOGq=I7(3D};oFKL-S)08a*b4tMeKy}Os+_@j~^AOoZU z{qVyFw0le%s_O_hH#a`bDm&}@Ib4vvGHF)*u$mQGfvN|{AanRXfQ(24S6rT~=0t;R z6B~Mv%=KsZoSdAHh%N)uBqrmT)y&JGLhVo}dVr!hSWq%*7DU311v3M)*$7!zG;ky! zM{YLb=+Ba)syo|}L>?=jodVsi8#ZyYfG0mNbZTmLO^U)l(&M;mn7(xD#CQ-BGAO4t z7^ak`{8sXLO$iah!MFNyX$!1E>_cR5y7Nfa?r1Grk*^9+ggtLk6B8^Aws*2lFLL>` zkGe@=+~Xtg_lx!RlbfwoI=1QcO)BUzvy2kDEfjZ3e%4Hsxx}29ppfdF8CCub8+n2u zo(UrrM9LX*x>>J{^-7~?{Vhjdsi8K3Nb>mJeCb?VS3&a@JE_0(qwfN>Z!cV}UQi`Y z5H)C0B-(ATX4TRh+U?G6i;Rva#;f?9-gW&Eq#e#UI253$bujq-C4`jJqC`@6_1I%L zFg!zX=F0G%Yn1Vxa*19Gs;uPe=^U3;CB1xi`%;26PnqFK_~*W_@0}ZO0VWXP3La(xE^qJ_hZ0%7<*3CiVXE4SS_S74 zW~Suqv49up6H{%HOkbgh_hLIgXZ_)Zi0vizo;7d;47O-`7iE2<1HDRFO;BP%zY+E5Mlf{eLRQl1#jZp@fdC= ziI`9n;(@Q|d)xChMIPPEei)9^k8$Zxc ztuNX+MFRa@Q`qC^<@?X>AGt_5x4M;73#o_rlzW7E&p6L_J<~PX_TwCIqZ{e5fww1c|(DzHyBi}3$n}9+3R5N{oEWQ(^$d2c^ z!kLF}m!s@!N}^sIx`%XBjr0G>D%N~cBvDxY<_|jl97b9Wz0Actca?}(YTO{F-O3)P zv*q7dD5Mf9cagh@%Q|H8>BZmT%OPL$n#)D)De({LH5#b%-#rh{0qhya9v$d#+49FJ)@qpp2&(mN7Mkq1sl0D(YRs-<(xc+q^6uN z6Duk!dovwnYHBsbPWst!MC3FMJoSFPVv`nAQsQ?q%;-3%(ACRWBsyod??Ft-j4=E$oB}nmc0X?)VIPZCPSx0joW_baiZrjyW=!_ zN;}7VONh=%p5yBmE(7;pDYiBT^H&^{@B5ZpFrqX5&kZy`)oh79*;84Z^) zR{b3#(tmmRcH7F)@T9Z6NcHJ=gaMmU>f1eOr4SWGjZWdvV9W+}Wl8gf;V|rf=M0F5S0F85lg=+r%*feW@ArFaS&9B}=d(#f|2d$8 z)w|zuNZB6h?26j0OL;~HnCGlgQT$7snY81GeU&&xdUPAfIXS1 zTJ*m+?V>GF{nN&cBImzjnORT;z) zw)~pO?2P1PlCXH5ccp5u7i`c!{=1tmNj4&Ki}=C;AsHqGl<9rl7$V#+62#V1Xxj<@ z=W_jpl9htPY&d>RUXX!VRq!kNrHWdfK;0k>tg!9F!%Sd-L0&-k0T?3B^#0r?VKaIO zR6DhDi}(%?B6a3}yTEtmgyUSE;96CI^@f4gn6s%|oIoxKI8_}T4dsT}%1BD;LOarI zyet^FN;W$S;yb&$SDe5X3IHBd(-!PxL_;1d7jJ$XLY?mLSqp4s>FDVj`ulG|NR1MY z$k`LlCV0&zEnN6>!lHa$R;g2Kid{KXzTU$f%3Ktbz+AhB4;3Rd7uRP9X0`V7P9;Q4nh_>3S5J(LQ>qa zpL{m6ga`|_iWOaksvOfS9)mJj3kj z)Lo`^zEsz2lBC2#C-CMN$lVl^W{h`U9|MWFN2Ak z-LMBO?x3KY9A#C;?EJcY*sR!p!*0z89mk8)b3C&V0!f(qi2aKTkG<9LC^^T;&%g?u z#HL3zBAO9Pn$$^(8JbC!66j=P|NG>o{9U>;87fe$w_I#n(B08NW6;)3+py$%q3&p^ z7-Z41`{|pcj%?a;)W6+%dl-y%7pbP}*w1kQu*fdehv!K1Hv>D652yDc6Mw4%G<3D1*fEd zQ6Z+5mKNXfLO4_F$d!F{w+8he*PS&gi6O) zDv^Iuzq*y&H3-PLm2ruQi4>@7F7`)Sxi*a2C{4$VDaB7h=t5{YHA9bgw20% z&+bhEU)!HBs?Q-I8Jg7&oiXeki^TT=n~yh1z|~ASS83|_-=4MiEiiTCvAhBpsZLMg z#qU|F?9TYZ%GCzdhLlT>xB6=FH&9sU#@~>r@=g7HW;vzcy&x&|GHhG&!i+V5^Y2iJ zZmr}Ne*N;L0cbO7KaK7Hbpj3i-GGNEC?s?hjv@d%=T}!H-@kvPqoV_4BkoWoz-l0$ zlz90P4L;BB=H}j7SH~#iIGDw~aM{bUAqU0{%FvFvkktnVRq{b)#qBv=Zb<>cOFcck ziZ!Bp_eA09ybfzKP>@ma^Ctk9{;R1;9KiHv&%!__#H#b_I+7o$eh5|f{OqhC@UDYN zIsXD5GaXf?JbwHII8Q)bUEvc2&|!OTPY*c1dFrJBi5@36!`mKjI-$0LKhI`+IQPg;9jMAOIsbrws|`&}KG3`k z2n+<=k&1_B%sDv0^TJsXr#Z}KcA4wvhV564pu{a5KQGhKoxDX4y_HoS3?DC-{c|f@&afC4 zg4p#5FBErpE(L$(`1tP7lLx82{y8~WIqJHC=|6vdi(pWB4s~MGqCv^%=ye8wu>oZ5 z0p!&M5;_x;99w5N0prGjx>TgshX06)DxNZF&Y(^RT1r&~{eZif_;mmJcnhU(VO0N_ zq*h`8Cn>j2BM_~DzI;u$C5RH@QmR;}@=baW8^8s8KurOd9TMLLDot7jh9--0Z7a>l z`RJto!v$D;$PR{)C|K-GOCJXyH9WO?y73+Ow9r^FTT2b9)j-Q)*uUx1mx%z|U z3IBmn={OfZ%3KtXD+2(wfPVVJ z?bxQKwiXr$Dre|AhgO5p*iSlWl@VzS!;B!SU-yo7g z%wHNS&8_M9mjtbRcRxKWIr5xV?!4=rVVZ@D$?LeD(Is=lrQ7mU%R~P;sv)4+4khi+-FMn(Q1oZmECA>D5q|)| z0-PHHEZ}%K<#B2b&>j$=;5d$lLyi>$8T9N-|IW{pgPp@e8c;Z>XeD|~t&?yVsXF?! z=dd#z={MV8;E_lL_S{P&;|^#vYIsNMNsNPmjWHiR9URcH89^cHb0si8$bNNr=(X%k zJUkj$%D_tx@FRD*5sPR6P_YXLo3Ov%Ls121esa499HtX?{nBW@pFW{nPoW{<3w@N4 zA|J^A0AU9n_X94g4_jMSfT4W;{5ku108v9%JZ~;vH~6Fyzi?rT$=C)%W%#g(EDmd` zNp5UE1_l&?@h+PACY~i)Dv0=*HzcMgwH?r#{DXpi8?n7FA9sfC;pgCBeQ+{`WOF@k zmHz5$5&yRKb{h=PAeHlsGgv?l3U8##LR@iqaf;HIfF!8Pz~sL%a#)=%1RWna--??> zZMx+o4m}Vr^-(-35Ho3xE6~zEtxcIPHKk|?;xv?1I5+hGB}hvsMK|CMZ6HvASJoVi znZ9(k&4Xae8*39x!XAK3a1DW;so~uMz;z*wTpBNDh5{Qj9y9av^J^LcHVdyoC3xe; zjd#$$8Jy~D1&2>y@6+Qc#X%bs$myyTR+J#CLxzcwTi;ZzKijzlhb_plNYP|uWIo|h zbb-k%n{g*D=H)PdM1;3Y7t+sG4wM}Q+vTR5^ znf|4{S+%<|?Nfg=M{vH_Z)>8swYL+Q`>T@o&OWqc0f(~&-aDW$3}x;eqE!cLfl#=_ zdT3xRw4C?|o-rUGO@)G4LNXv-3gXuQw`eLUMr!hySDu}wm;yWGgayA}baG9~99N5I zYY!CF*0}fBlSvwX?$}voH5kwcZVwicBS6W%z=(GVtb8H)j}ZD-sov&%s$`#(!(!1F zzOcBcZFQPEsNMWf#B&+N_XpaiFTua$v5_LPzMYY%baHT|@DV$`&;Y(D9y8lpIt)B! zx*$?t6NVNe`pv+<>+90u;y0(J`hF_kpuFCvjSl5|%kVIY%~7i9V{nInVp_abxi+1} z;x;u6zH!e_H-Z{Ke!u)MCoSJwr9r3iy`Az#{zEUw*W3>;rqNGxHG)7yaraIyx$z10 zD@MoD_{-Kd#BSO{i-$D20`no&m!DE-&!#Vf=TburB$MH&PbxT6DH=B$$s3}_t428V zQlif^;axUQUvQ|S?qbrfKj9^vIF0+HpFA<=hrQ{G&&f{%@w8$;q|oy1{80^|5NPRC zD@n70aXy=^Jsx@+2c8bIeyvd1r*gQQ|v3fTvOh7&rWD+rJwu(QfE;XAh zy>@wWe))z9MD+9)Bld-Sl!ZfsD(mb*2>i9wB=!J>_sPhLl z0MalGs(}?WOPRa3raUmFJVdd4NDVKjA;R|>{f3MK1qi}_>R6&MlrKNg+)GjBb>&e0 zmo*9SET{ehUf?GvNM{afsp^fnQM=N3mq>veutDKfC^(MO>1DRtHMbWQpBOB>*`=#D zywZ1U83N=PEP4u&>^!IH1Ch^BYfn(bpEP7pT~yhCCtc)YR;Fdpi7wYUuo@?u9(w_Q32GhH=w_ieU38FoWB6Q=VYXx{?=Q+QMj<~xbZ#5S$W#W* zeZrz`yHJzk!t3 zIgJdq34T*Dnzs|*BR41|39T2J{V;(KQlNGv8N;OInu zNT0(R9LpA-djtH3cSdwWL273r_2e!zgl8gDw8FfzQ;VPX-^9kHWZ}AgoT24-T%Z2) zsA`xbE5~ILKH?pu+0}bJwAabv*A$}JEbgtCkpuNY$XlXRQ3(ZX_%s5w&TW~(H?uyU zl^FZT=`>}PK4;|%gVPwKQM8PVi$~k@@Ya3xo}Q?J8RVX6Rx3$g=Y(Q>%f5MM9T*(B zBnTf1_ZM7N{$b}i9Gs`^M=fbw70B<-w7x#@EjyU3eU4=kikBF`0xX?$YnJ&)- zwzjvE0r<$%td7LvKl%V!ha4adC`B_UCvm?Ge?W0Pp=WUQ>QyITpMavjGH-r#-J$OM z;4N@3f?%^iRgIEGqu;vshoL5&E(gQxHFF?})uA9{R_bHP7IRGLQd7QhT zA|u$R1Fr++D6lqB84d~~Kr)tx3n@bRPiWEL?!j+|89n~oCZ8GMe4^vRwIXOwDq{QuU#s&F%su*6B!Cj76#Hje8e2B^&Ss*lRZEc|? zL1h5Mu|EtNHz;S7;T)s9E}v@Sl_amI_#r1piJv9zT(%3a8D*D|JdXA}WfUfL(P#^p z39{P{kK)P0hcm?{KnL=HBpj+f0KGu74<;9Afz95%Ml}obrAED1p|gLmF}bQy=D4W^ zb>Si*Q`)i$d#LxXs~4yBn{-d`1~LV6_^^ZN5cD?tq%i3Q{8NA!`81DnRAy1j_FtDC>98ru+94B65f#(&mpVZ`J6ghX?J9v_*xZDsI6(t7O zc0Jfg7k+iU*5#lzKG&cyTl{A!!=HIlN>qAuUN|-A!IxY>RdS`$m$jo|sT9XW{m+iLwJn_Z#Oh zAHR@_r!sHEDY>aX>UXGYZM?O_zuhA{HG+yHi(}}7mJ}3GBwquwMY1OfMFthuI2g#I zo)O(rVNy4(cNtgrK&Pju_K!+H=m!E5twgC zZbG@YyPfo6%9lWRdQA~wiVv8X#Rr>=>CfuRvso8%nn+i_rVs}*9?bO&ezn zRGas4UcP=!^|$MSsHpzDorc2w_3Know22ohmJ=SsFXGzU>oPPIyKw0U1x-#m9n~sb z5bT=)VKI@))M<)k?#MTNA>{c*O!UtLE^TL$VL14jaj6c$}1$))e)`HSIA^Q6EUZ?n|oOM=N|2ErkqO?`4n3`h#1; zcZ`nqRA2u);z^KblL*@x>7YYQhXc^*l4*Pny!d;IB$Pb@MS?* z${AxAOo?L;OKtM%eP?(7IKY;pnLf8DNxt_tDD`R8Zrjt;eFqwesaG#F)ug|92ybv6oYqrb(>!%5334$8QmWbTQq z4VRYm(7~uoEDveczut<-6SLw=<(?Oh~J(Iq$|p+uGavEpO1A%-wbT zV37TM4nL+vGcP>zjb=%Pq}P=zX@+`njioxR zwiYXWA6@F|>;i&bVX`TuC;jNTUxulKRrz1E85}2;G^Vo<-P{dHNYBP)x*+AfNiP(a zYmkTU7C=qEO9LmK6;&&J!UgADPUEWI zy`PbYXm`2u&7_)RmFV=n7>!II`7V`7bcV?$G2ICX`qHhB+rh_j| zo_PCQ6`!c}Qy3iuGOYL2t6SUql-&B$gnki{bVPn8$b8O>XXYoddE-CAh_sx82_-$Q z&%m?bQU~5AUoxIMt)~-NXF2@OF1`v6Nu{H!nlm8OA9_y0f&DcJHZOi}8BTThR|sN4 z)n(>JBT0f0$(9Tz@@U`?F;Zb~*Fy0RWU1JsnF=T*vr&3YUP-QAY~ zS3l+CsOCF#8pyx`8+Zf@!Oq|RrIM0|T4g|7KiN_)G~k<Bvp zouMk$#YB7ZV)rRpJQY1%7K;=jfTASI6|Mf}yXRJzIG6tv}g5l^8Ti6ZQ(`+ejVJ8VaEAfY9&Hd&6Rq+~o+ z@eCdjQ@?`TURfaezJ0(8r=zf9W|x%5K{UOs?TC3931e(mJWmnB_K9N#^3f@urV(4E zsm?_!g$`R){J!I~SNhLaQyTxJJ(z@mYcVVO`J|*=o#kt(5{Fy*2?MK!uE zql5R`RnEy$`ugxK?z0W(kDe&i{~-m+#N(`ihR(fAKWcVj zY-niurRN0!_(;Nu+t`$P(jc#_{Hdt`|Mr7dwFdiF;+o>yrM88v+ETp+U#TwlR}%rt zKdi=5pj9R=X=#s-4(J(drhUE+>tkB#wuL3Jgqj~Ra#SS(3NHi-sxq{RmSf^%%-zp5 z1WR(;*=6M7dByKCQ35%^W1}xJHRi$t3QK2=5)GDJnn*qWx`q zmaNY2&jO>gqorn+btJPD`{x`#Pv_xQyVJ&G6fdn>e&70iy)r=P%xh`*xRSYiIZ7in zP=UVj)eXv5(wGrSrpj9#0gKq=Y~SxCGrs1vA@J!%AvY`}*u>Z^to5XXQPT_pK^WKW zy}iFWR2Y%;=r_d%lWKikw|lg7{Q?O@<=drf{|{#0R=a_w#V~)+eao&d476}|0bX-G zqJz_JNfuz?C)7;7FJnB~*mK06#{sVgMN6^T7wszMT?0f!QfHt&L%Z*Hb{XfnypkWb zJ}?vhbnXfH=XQ3KlOJ;fO-o24BjwlC8aKE2QabtEe=vyeZ56?HsZaFcJ0GsMJ1|-v`bY9lKT5ArycA(2qU{xEq4L$*iUn_ zI)Gl@WI(NWksH?R&flfjaLlREulxgZvT`I!B4@iubqj>^1s9R#V~=Xui(~kRMC9J! zAw3LeL9oT1bK|k$r%Fyx>!ET>(3P26zGSfYg@e&#e-op$RD-_#ugi4MaHOfC+>;23 zf1wVtIQGkoxRMwh&CuN}r;QTNdM$S$lO~+w{W?*@%Tww!)PO^0J*(HUy&L!Duy8ZN z$($={jH9OkUV;Ax1>^+Wo}-s|Gr{!nA^e}eK%V~_O@LkG-rBE^s$eCDh>zC#ID~1Y zJxp_3V7I;&`B6iX(xmHvku=QtKgJYHi*G1uW>M4oe>(L4^UY(Zvj6=EzUfM!0MC{Y zeP?iH4oE@KoTC<@ttco*pyheKPtW=~k;lHhG9H*Y-QAmUtwbqL+)?@F?&PK3Uq{M? zbCp~~JZEC%?qA*V@xqRa9g>LQte1b~vTtovtujry?Mi!G92-{IakB=^0@D(^VbXDW zy|}hu6=ezpLWyfzfLtiZ%05J=V>(J!Z!}_?Tb&n%9_$hc;m7LgQzh4gp?vjZlN_lS zN1TH3(G~$7<@U^&ozEL%5lgXELshnj_Vy?1OT7&I<;Bk#V$01a*O%lJmC~U{?ptcs zCaqb0Haq1>ID8rAM_!ZT*;>%Ldf0e+@d;2PG-!Y<{t_86D_cF;tX3}^&E39l&DbRZ z5Ww6odhb8rKNjB+@_<`NULGGDAy8I5Oyigs7{y>jgxu_iV$KAOhy0hhl%FP}Uk#*V zhG+LQ3qIXPCiC=kMJ!u5mC)mhL;t$Kc79RDxi(Rz&SHr=W)KT5|v~#ZeG3(hM$r;0k>8>B?TrX zC*ctTU>oWk1W(i2oDdJSn2Z}=n+kt5m+%6BjJ_W_!Y6xc;#O9-r`<2FRXRIQSf8?x z`1zv!Fj%*Iz-Q;rU+aQDTBKV#ZS^E`jmrAa0v^(}wX>II8b$kPtdw`t_Op#A`4$Zt z#CyNc2Un6b$2m}MhjNRs8IDIofhGI(mp*MxKA4;Jc%V+6aNfO%jSVIH0uN}*hw`Did!3@tVIIwlR zBd}UDiVLVwJ@+afUrHX@+ANi-qo-4sii<)?B^(?_d5})3ftgV-8!Ojr@A+cg1RN8VP&d9n0KWKEKR{0&L+yJS_)DOI8HePfMGyqnz56@2y(miTj(2#Bj zt+NQk6-s`{NU%;ik>JL_ZDQcP*FUAqAjJL^Le)MBE{T4-OW=p zJwxP=XAUJL6mQ$>&LJb&^`pH!$HXhPXu=4PlrS1gdv-7I<31^8vE}6zB!^finISx} z;pp`E&RC6eI*V1@$aMM4=BA&YA13gvo?bZ9RpUF}?O{RVObwf-dGo_~cM}Z)kM&lM zAe6h}^DW=`q#lS%>z}tsqromQj6Gw>zq89T$!FBsrHOjbJjOMM9J_;mKEm@dfjxm% z2L|T;tDecG@;bU}2B1jMWuaY@7T1xHmk*ATndkm>IQxIN04>4X2_6}uiz7wzAP`wA z)*dDzatbXm-ZeNoTLIEYr*FbPzG@pu(N~`&SgEEd6#fb*|AP1r7N*jmV#l%xFHB zd|#dflZJ=Kc3gTKg{8KJ;FI4Ib^FB;Le4ANO+Lx(yh5O_uN=dM3%;GXW5|(`%roK3 zArE&{(TvSS`b=dF#)Tuh-A!HB4B~ukzL(($Ruk>Wtn|5vVb0l5nqjpG> zSO`#*3)cj!zGS_Lx5(PLG(X2Mj6M9J%xFAVOkFKA%{4hz$gGpEZvB`&I3ic2#PrZ& ztc>pRFgr)0KGrhB{Z%#nqVjgk3%DtP=BI-FY#2BXUIzBa_OU)!Ew;O_HafaE4K5Br zayW^|BPvkoic%)Pf$|WnZ-+-mmVejW{JL z6?K!@Y6=e^Wn%2r@8fM>RQIr3dt@Ydc%mkLafN+t-1EbmurPLYepu6gduE$}h&Qvb zA?WZ1x0lo2K0#QYXt%14I3}aFa1-&20}hpD9}Ft7Ek| z?e9WH^>E+;*&RA%+*bh~z>0F009W=^dSaH-11Q}t-qb44UFB#H3S&xn{rQ2!UBQQ6 zd69k8)81P-DYV(p1W-Kb*}OA?siH&pLTBl#5G~0vZqF?t*B@%3+$na6%mnT zMUA+cni>KU5}WPKprnW5@=KMv5G1Ud1}~3eiN$wVW9=moF%ps`5?^a$-aH`rD>}ziU{s zCDF>=H=eifO#%<-sA=v8i++SSx?;-Us-+@&RN2jb8q*!$9U-9IaZ+njIesWshW;>X zX+?l?eX6#43Uq*{s^NWA?%A&n3jukS!SE48J@1pyzXRNQIY++N$@pzv0q}5e zv0k-goQ}8{C|>C1ls}K+Wav9SSN=@1PHp&r=koWtP*>L*q=&$2$}q_Smu~MTM6CUa zVjP55Lao{=sVCvWPE~y-zJ9qbs^1;fL*ziuHAZ+>!9e!dd78huB|-7syLZ{FPbRa5 zwe>?kuTLCXUyz@4SMWoDxUjid7@j$&$3{ZoW#p0OlochZX4@M}eY zN1>v_X~FL@wCjYLqeJ0e>-T`DMwRUpGgm(4A_)v1Wh0|3^>PbM3t8v+V9v*%x9NHo zUzm6Hc4<}zHi><96g*r2hHbvAa`h33I zFX`KWVsmrr_%&$@ivkTzO@_0lS>80Oash#%DxIOOOgtgf@o)I@W5UAVUzl;Zk>1O} zT9*K3NpQKVXU@$jWjZi6H#d*J)hPJcpBY%4%{P*t3mvG4uU}WJ6f|}mJ+!pyG&Gnz zb4C@cx3O~X(WmxiiQlMABo+7Pj3)pY( zu$$2G&vw`H=lCi0CkxlV#_%B#6VpC$USC*9gM>q0&!By}TjsNPTh&B??P7e1{<&5q z$?#-EjmJw_L3E&$WXeZ5F7*haMnhU!38d2P?mIno?ylUtydB`v;dY3XB(b;HjX)^L z+kD;G*&$TUk0BW-G}NA6VD43~wx}H{cxzdIzgWFrsalzl-Ev3~BuZE~IC5@o)&iSv zJC+Zq#rIc4m&Z5jhFcJC?Pg{uf!Vek8N)tUqt=fla4YAX#MEo|)A$nb1}3~c!|Yk# zm$^7uvq(yIviRdoJZYY*$Ab1vrd&&jxDfPka$ew2;HRpzMB&`=O9 z?+?b5?(A>Nxe0lnf0Co$&{|%eP0m|0W4v@r55h=wIdt19=3fmgtos_3nR#}8uK$9Q z(OU1-t87nJ4zsbeU%!N$ot=%58^nG^44i%2+84(}xH5CD0!QyYwx;QkeN+`%(^WA^ zJdJnAU(JLyeQ=@3S4UOjGNPY2969qYJ|M7v%zjn>CRSgOZHc~SPC(aau}7gs@al$y zmcZ>2k7PTJ*!%%c>S_Ye!TvEQF`lY%)~}oH=#Yc~0}omSXtJJ%Dzxo?XkYF~{Qm8+ zHih=2$GCY_eZMwYg7RQc(182lL_V6QXLB>n(n2;@WknTNkUQ6<--O=tY=c*?Dicv^ zg;KL#jSUM6)andF7$i=WJWu?%V`z~}u3S4YL?CX`msW%yj<3%`KoPnmienjYf>%hM z5pp=i0PKc%e~5Frxja8DRSbwK1yY2o%Yeu=41OBlVj?qmE$YuxKI3c{Dext*P*Ev} z_Ag#8=P6W|nbDJXe@RR%bg^Gu={i`Ka5vwn+=vIkFOSV$*7!ri$cK#dCd>Bwofr?{d;6fS3a_M+C2|41)m|#?hzAv+kc+6g#&lq7H&wbP%nlrw% zqb_1=WAk$_H8et7Hc9N1->tXP6j^Wi?oUH&#{)lWs^M;g(;HbLv&%sTsxz&|U{_{E z=CPvE-H2?3i`vX($6sWb3t}`-LT|7NS3(y^L6*zUu#s9__;|YHFH} zcPv?N*40fWa|j8qqM-?*qg}WOWAJOunkGEp@eR0YC9>^`{+{Ip8vMDf_&FAiT1owf4hI%RL7rn9m=kFz+2U3Yv z8M3VPWhonyI3P_KQg>2oh4T03*K^)8VgfjIrsuNOqI znV$JYT0{}-@CX65r}v@}2JT?n9(8sBG>ta+Fu?I=-IQr5f?uy_^J$mK+@W_vB#iJe zPKITd9GB6*m4jx!3!EOMpj1pxOUnWg2j}mbTN~AzIaygtGR)WDH+xFgPLyO-E4Q{c z%I~`zjt5E7kFV(r)b3BPFX38p$6~A43jkfH0JdJK<+Rq5aPcSo>5fXk)KFTPd7G~c zW~&;Z0v8oQqVtK$Es4oFWPv#;T3Lbo!~|(Wmwf3$#fA}okvappcqgmbB5hHng;mT*uwVgej(%_ocSL-5hD%oMnXARi&os<*%#BFuD#>H$Z`{ z#^e$j7%oVffMf5Z-L|`Q=E@mzbMTX)aOvM=+1erAmtj{pk&a?`_5EVZ4*R*!k^C=Z zE8E>Bf=^7T3~`L+bG*za>CZTmf^&H|YkhaDMc-Fx{=fLxL#N}mWzd(yG1I)Y`K+{0RW7h+8(e{ahMjuR5@R-15 zd7nKMhp4?|R9%(RQ%ZeGzTG}$b^rM5(U{EO-00F_m`Z^;V_CObv zkc@mU7_e)QO%dIhN#i`ZzLXnA zImY!w@fHSVuC>!PLfRu)y3j*^aEGGgSlXo#XE|V&a%Henf#H%o#XeP-Jv%UwPXn89 z$h20L$bILVh`CASa)0L26Ps85LhjNh?_|HkNn_-blH~;J3N6lC{1lkPJ+!5FJU^zH z_ef}#+2!OT%_)`fGZ}bMXTx(?U4}ZN;BL=*$xjyO0y%=SGw?9bvpv|Oa^=Mm3NWN= zre#(|{Y)m8WTh*npE?@)SkwU_`9`>mV2>)w?&@B04wTrPC<%t^4PJ2v?Vbqmq~ z^X_B4<)&!8BeH*g_$wQ*{_1C*JBmHfii9aKixNHd;;;&#Y(Sp%o-*6vC@U%`r~yG` z`tDg+TblNcS9gC(Ztbud2~dC+GWE*x=r2n}IJc%BPxXAjBJ#8}Wj|lOlW}#;-1Mw; zZFkOR3!ewnM2gh9HapKNJ@FfSbG$BB`?chU&b%DoKc<{Ot@tKZqi>9=$@MvNc(G+( z=BNI^y(^Ek)e9QWx*0Uir4NqTy#5%xl3C1B_C06mTgsGo@rl8mh>fMTm0wtf`gz6E zUk2@n?K2*r)Yr$UT<<@=s4F4lwd6x{pEWhmxF_GJbBkJ_S}_0Zg$oMKl|`kWe|=b% zc!zYfjPZcY&v2w`Cr?N@3@q6wP3sJB(-ODx2?c)B?{x8sqpaPK+6tb)D4I=nk$szP zXUyW|M2*0^*)H+*UDI`DVx6}$l^*zP9Xt1OD#WmC&TetqXuFXNpF)&Z9vk)r)4u^5?=dpGX_i&I_Uc!iw=QxCn_j6(*B9Gk$xO_t(f!!?ezRR?!+wv_H^0p* z^q&_}pn1pA`=WBpuf)+lKVW$r%(4uR9lEGxit{KpCo9$)oq1zJ$f#}KGpXrM2N+?& zD~+UHm=(0AoBqCs?dlaIw)~?Z=etj|I=7nM(h|yv2LEXD(|5{Gj6{&DVnTTMO4)95O*oOP1=2q2OC32{$n>1k!V@1t8+3;-WMqrjR#VDl za%`*4T%FbNFNH0O$&Y&B-ye7d9GEUlr5m$YO!Smx5V;9D^s_h0Gd zHcv%`ll9mYFP~+&FNFp_aa#sOR4T8y5|XRo@I1`i z2bt}9r%xxLn0hx7v_YAcV_Du#4+5U^+_4kcC*~U@8R^(jIn$Eutc)jZk3={rtV9|h06wlax0#0i-0cU`#c(Qq7sc{3ehr7^^WV6zmfZrF2 zriY?b1qgc=BC76HXVP*`W#QE62I~%o`O+N;zW2ntyhJAMa~|f-X{;@>`*d&ThLT=$ zh^Rq^qu#_&0%@tGh|m01q;ZOKpd8h9oY_`oVjhuT$S+}<3<(9jOWrhb(BZjrDYR_a zddl+D<-`Q57z2j#md=!hf?a%hts6btm9Y@yBb4zJAYL z)9)qaqn`E5i`BwNR|}_@r4(1mC7Tp)R@oJ%E73YS+RW7A3i2uA*&ItslH1Xc;UQ)! zQuK|_HQAap?hkj;_fNY>F}lf(_T$fH>T)|i&m0l^tgJ>;*}OYe+jr(lY-33KiDpr< znaq$fIY4>O(N))Ea};hR&(fy7^dbgp8VzL@b;x21vFhSFHNEeZ`=T>HFvPPq4P*xn zubyn|b=O$O$vJx4#EP`2Hl)6AH(Wm>{N(eCu8)UF`3=R}tR!q`x*a7AHUTn{M`bms zfwi9A_H0_h3K5}vyYam@Hd*yZNm;4O5~jtnocXRDB@Rmh>;FMMC_mFvvh6Cc2 z72J@Wf;xBK7=T!>Ii;Y9qfQA zHKT8HcdWj8w8NEy!~LAU)E6M+Ac6OZ!XR(l1srO$Oh;e^Fhn1}-Rfp>xZNbCTQE1Fw!pHCGB`Xa*D< zu)5zsjp^EC8)*z^fDVUP8d0<&fC@PE2JY^Ktcm`{p8+^s-j?jTsk7KQ5uzIY+C{QS zrLPCN)fyr@!au3|4auUfr23!+8dkChGf{xo>b_P`;) z$#@?QHDfZ`IwBG11Rm)E%46rzI*eZvwdO!~2M=352T+jw0|&<=?R_>2`c3zzk6qm3 z^-&Mbp2yqbBGeV0pgeT$&qY@y25JeLkW|z9;M}pAXV1FG3T{IuJ;u6>p-l+LW5Whx zq}K~*0sykIvJx5Vese-J2nUJLT}+#wop26v^7bxSGVdbruO{Z`&<2rVbH$W__8TZC zsJ$R<4|+5E-m)Sz;Szw8p*g?!sj&?tS2E6hJ@>AI^A*0l4hYTOt0$U~<`A!DLDdgru)rZBj}*T+X#R1`eFGZYlKrUMlSPND!F zz^gFs1@ju9Pni)ZwD#Iy;vttKxw*M(H*SpN4?}lNR0p=9Z2fWPdg2~h*4D$@bLVy5 zZ?Wi|1{&#(nhlhSkhebcj)R+x32LX(=pvf6_4VOx_QrTuXkhs1f`mt;wJDRIn9G$+j&Og&ouM9}CefpouYFw*=`EavI3US{E*cmEyu_a36E?@MN*krIXb`@Xy1a+hr?-cYc~pj+iO- zRPJ(7B&+PaO_7|YUFh86oJ@j9-Ew=})PoPCbD6}`Kt@uCO${_h9m28$cwa`mf|q;+ z%YW;GfBfS+nTtKApuySz`T!ILGnEAMLz5b6pJL=aveIIEI2C*xqC`WGcBZ&OZQM6-U>T($JwerP)no3m&;`rOY|T!MYqZm8}gsu z}tctBcB#yg5Ji_ou;3IdiCeXeI59K6GtM^%kd@CG2Vpc`mu zh2Vt>L5%N#CR_DR$8~f}VAP|yD;sDIbEGAB<;u%R-@Iuoux}F~mWXox!Kv1VPE)5q zDcNuVg`G`_e!3<&F zS5bn}58Uhew;jL`5=6V+QVfKnAsdWr1K(C@m?; zz)et4NEvEOB-@+eagDL)Xjbgpm7eD1>S_QRx~;_J-P-cqzJ7jGa#f(b>-+CGSASW| zbS%a^SjzdiRrHnk)~{Z_Eh#*F^Ab8S$_Fl%+~8GWOvWq!&mq#cLk>6xU1c6rOt=8I z*Rk!gj(3S=!=N4r{Gm6dh#M$~c(YM8m~mdT7KDNKP~&Ze2`-wz4vGL2TkD|D^V8X1 zl;=O}O-)S|2J#ZHz^Y_;klR^Ya2zP^sIGGA%vUe>nlQmmfzy|)6EANEJg}?Wi-zD_ z8yL_xfHh&$oO}mFGj4pZ)dQI>6woLhjEGBE#x@nnF+LBocYdLtovYHkYV0bPa*{f+ z!4J2&(PLlyKSVCKga$<8t&n%TA8bp}Ck2@wI}O27DqOH&QWdy_nqTFy{wgx1(6Lhz zl#a(i#}ZXog%lb{_;zB=A+u}GK0v1dMplQL^+Ptg&4nX(2hrg+EB#vjDElc(M{VVu8&4mRE=d8=(%k%ft)uKH=vQOVjWmJ_r!2`Hj1_l)l7ZgiylgCF2yt74RWtMQ@>*l> zVgFL!AGXqjW-XFf$HmnFG;^17I*fshD$ZCY?BFVt{}JDVO73)gDCzuU>0eMArSQMw zY~teL_B|yJ&?MW0(ZUeTk?bbtZ){Z2mnf}=%T81&MC`Z=ISX=?d#H~i0eIs%bSVk7 ztM=^iTnaou0Zl|z3|{7*hIbBNSr3F}(N`z&m577{acWyuUfuzvnb&GY$_Q{>&O*b1 z|AZ28^AjkM`I!c)e)6yUBLJvb*86ng@+3@!S5D@bP~|;8BArLRQ^gC-sj^PaW+F9k z1fhkl0^6IFb?vDe$GH$EKi*<%i3HEO^67bxP#f#S~&$R7djn*xy8VbD=o z;5kiAPghvKc6Mq?A0c*h2bCTi8WIr`)5eBx0pCv6w9N>Clb{&=J&+TSE)(5|pEy;H z=9a(z_%R#h!WrN~nVy=uZPXK{P66GhWqUEU+cKc!Jbpp#RpjY#&sE|Q!6msK6 zJ6xY!nC4M)KH&X^O%XZI8WV;51ziycAoRI)A{-BFlLld_7@6L4W(SO&8MNTeAO!lF zH7*yHO0hX|69QOf2u!Zx+Xbz zMy!tehaU_W4hSZBI`z{n30)R*&{-U%NT@xvg9(pA5e538=yOK(HU&UE+~;TP0#HY7 zq0PYRC;g8O)D-+l_X4DAB2Vf=@vw6GG6(nF`RJu zr0#0XB&!52ewLBo(%~5=ytq{9oXyEs6xpqj?6Z>x&c1(@nY`p0tN!A8Aq`T1fV@wAvR94UznqSp9!Kqd!6jUmX?D{XgUkq5MoVB8G28 zEI+>;`0IdAR;4uJG~DFRghVuw$IZSI$vB04L=U723(Ly3EB_vVPhC|(Rgm9=1qNo^ z3L>h(Eox#^wg?V&?F2fYJM>jcRr@J9c$FL+xt4l!BSu!&Xq}s4(^C~BJ!Jb$tVJ2f zn>R*qC_;1{uKC`wO59TQ%;1yf<^47vdYz@jGaUcvOVmXh~XA|51x7!uY>1p<-YjT*@xB^MU98RHwJl;TT!71rx*%XR7S>_;yzTr z9Ra7K$Pj?}+KQTQ99-+5iJnq7!fJ;(jRvzPvC+MwtqJcG^!ECto0Z2kdadgCLvQM9 zoU0MzS67!6h(Mj_)DlDJQpNWlh*~{Dh4s$rHu^r_{3> zyQt_7ZU`>{tfPAg3|z*k%P3tpF%mAKhK5Gwm;33p+3Wwrlftt?(8KOywq8M|!H?>c z>l#a1%P5smG_0VzzL; zh-6(vf&q{V63yt7HDZd$oQP5Kdk9O_IEN$yPh&32Srh{u*3-8pDde)FbC5G3pb0ZG z@=J{HHY|%a`08Q2N+kG%loY5x!fU34$Hip>^AUwsLe@Z*d2ud!SDX+d_RJ%hjUoq+ ztUPk`=r2~@Z&wis8(-u5xA?_QvmbOAuI_D$w-K}iQe2h#A&GJNCCx;Dwe4GGyd~M zBzNQ@F5qbgMTb6zfbE)+A0ep+sO8T}r|u;Xq%^ zPa^saSlim3KmsgfW^OosIBL1*h>`{8jKD^q2>3J67JMGo%@+_1ny-kU!%`)Lq-tt@ zNUrKcsza0d7c{CfKb6oJQ1YOpM7DmI;mMQN)%4`pY>GQ{Hv;08FsXgtUfU`SCO{uw zUlD0(Be;-+O^++VtFU+L)~L|HK0GFrZY!*NO@qUSFN44$6H)dN=o3ncDLKFx8NWov zt=vB`pX`r{)yDn5^<1Hv2in-AWt&i8=5wP6P5bHa=Fh#EJ#OymL@L zHbp89BLlWoD->2bvRup|q2^&L0L^yUb?DMzdu1hrZHXaN;W76cU|Oza4p zG-Td5brou={ks0`$<<%%9#`Rz>ypveMTA~NJ-#$(ZV-2!G9ofeY_Lr56;e`w>=4;q zU~Q$mvS}eeAK;Jn=n-SznsFO*4G&%B+_UxAd)mn5ZHJJ`L|$(luTa{_==&ha0sELH zDlZIPn#596%0bpz9s@4K^y=fJq@>-%rbGlQs-Qs17FHb8Q`CU-n1A6r zZ+hUNJp$J6$xZoUeHuj-HO69lXcvpq0X${F{AVRK6OzoS+XM`}ddMTjS{Awu>kw0c zyXfib-v-GnFX8YK$wX*SCF4DL+Rq0;y!I?(Dl&*{Bxav9-cCViivfniW?+H93w@6h zK}+O}@n-@am`AFdG;q*{vv{(eOY8BV1=?{39-p~a9=uP+u*L%xKG=6m;X`L$AGP?8 za>TlwHrj;KPpktcpZ~2|40rj%{52J0ScZTzMNLgj3AqM}N-aV~sjdnV2X6%oq0kWG z(z^-U@W($@_g4jeSdX~yPnm{)VHbRrRsT(5{rh46H27Z(`#&-_z7F`OVZY``ejWTT zte8JN^B=94zZmw9ga5Vg{?}CejbZ;}dHszU{yPizzn$T~v2g#}8U8y9_tg~r>B z`{9oZcRA_E7qj+HkNC&2{^N-Mf4u+S*|>k4iodhN{>H}r)0+K_8UBx+$X^_`BqJT8 z6?!sH9s9Kea6-ek8oA~dWNd%Klex7wTnqmK_kuXNf8H{LzW=L<`@e#uBVuLn#*v3C zF936TK)$Lqlnkwli?W>gFves$XT+z2pIiFx8V`lBna><$9hN^H%&KSkFAtiEh=^q6 zcN5mQQRkM34Lc5wPSUEZin&kUx~Fx~6uR9iR_2&&Y*@i&Tyk(%x(eyhn-w?hhT;w~ zgWPPQ=3)w^skr2Xf@jT(&Q8tv@p9ejgl&8F?Mn|OofBMqC&2Xk{G%8t|0FR z`mydR@`~l<`R-e)JPIRxT@PL2q42BeyKaWHee`i2iK-5cxZ`HhR-H8xUB$KxV>cfk z85xO@@uJfg&IH5UHBN8O(K@MRfQab0Us5^0-CRDGhlqFsJwWhIW{+>qNlX95&b49- z?>CvXG`;|+)?4o0bnEApC4`TfG)h-bJyy)=&T`Cc&+XS6auBSV39+!WV7A%vIdneZ zDx4ioWG2pT4WI8S`RpC9=%K|YVU=XPuD|1L@-ZeWh<%RCZl<<`2M%3VUbyg^iGSfy zB8Q31QeZLn>DJhJ)!+1Gj};eWjph#xLf+8v)bUuIAKLFN7@X@wEhp1%a3oW2y$^9 zL=juB-)!&v*zYcgcnL4nZy#HBxw%?t`7WmT{ph=7WhK9e@*wL755c`^3Z4_~djl3; zz?SRlv+^zR>a@nIjIz2(FJI-9WGi$RwY)T(($ds!<5KV%`AzjIk&29XU(%yTYey^d znWT1>pN|i~&ungTVCvHp{<(!Y;XR6RqQns``>`xg(_qP$>26*Z>FfOVY;Pw$M?5Z5 zi}KCN#gBFSRUd;eO|(D}na~StPR>=r!g6K?E~cWfuhLY5cCZ#gon%pcb!fdj*T%K^ z?5cu-J3wmABe|7AaUK73RjcCRqMn|<*^iGOvzXY<){&bEhJ#3j=Q9J9T#ayu@;ldB zQu*1V5&`-roYfdUC5>b-B2ToV!idZ57i;Sp(wd%n@5rW{2N|a6z_pqJQ?{ zqQA9`jeQfvx~w2TL6ef0Xy(-21E#QH(ItyVFW`*Qj@`)0Z{a$2&^}{!tGEe9K{ZBU zcASgA;5fn|F|x~{edH27q@ELCV7{)Fgy>!=LwpR$vOJN%%d4fM(-h1Xz^}P>{danI zs*a8>T?-|$4AEsE{vS$qT(+ECOM7Bp4ZS|=UdkjHAa60Sub2#E*ww?s_Dn}oP4qkn;>IBEuhW$&1o6?-w&_k4M=H~w6L()Y^7vT$ro_4 z*HV@MD3IxP(~4)h z^^%9!Poo{F^SD||N85Oqw^I7^%eVI3Lo5UGR-Pa3+iEOY-m&sk_woun+!&Ua0m6aW zni_S=Os$Hbu!M@Pr7x?!GM?}C6?Hxl{-^h!^NvuP&ON8P-Aq6Y-+~&`_g=-K|Ep+r zq`XIvUeFjTiQbo|3bFBqc*VmJr_sVJ&S~J6HO52c1B8sGcNfxo#7`Kvag}?H&be$V zwC?3;*pF-9NLEUEWM!S_DY2rzpA7N~GC6BNNf~ev;uAN^0@K4K8^Tk_`lcYTH+v(W z+f)b#*tq6O uSq?7jaQDg*(VVWY&t{VF Date: Wed, 25 Mar 2026 14:41:34 +0100 Subject: [PATCH 10/15] libblockdev: Remove the separate 3.0 documentation Remnant from libblockdev 3.0 development, no longer needed. --- libblockdev/docs/3.0/30-api-changes.html | 77 - libblockdev/docs/3.0/annotation-glossary.html | 71 - libblockdev/docs/3.0/api-index-full.html | 3295 ------- libblockdev/docs/3.0/ch01.html | 82 - libblockdev/docs/3.0/ch02.html | 45 - libblockdev/docs/3.0/ch03.html | 143 - libblockdev/docs/3.0/home.png | Bin 256 -> 0 bytes libblockdev/docs/3.0/index.html | 106 - libblockdev/docs/3.0/left-insensitive.png | Bin 395 -> 0 bytes libblockdev/docs/3.0/left.png | Bin 262 -> 0 bytes libblockdev/docs/3.0/libblockdev-BTRFS.html | 1544 ---- libblockdev/docs/3.0/libblockdev-Crypto.html | 4188 --------- .../docs/3.0/libblockdev-DeviceMapper.html | 813 -- libblockdev/docs/3.0/libblockdev-FS.html | 7884 ----------------- .../3.0/libblockdev-KernelBlockDevices.html | 1381 --- libblockdev/docs/3.0/libblockdev-LVM.html | 6691 -------------- libblockdev/docs/3.0/libblockdev-Loop.html | 672 -- libblockdev/docs/3.0/libblockdev-MD-RAID.html | 1694 ---- libblockdev/docs/3.0/libblockdev-Mpath.html | 464 - libblockdev/docs/3.0/libblockdev-NVDIMM.html | 953 -- libblockdev/docs/3.0/libblockdev-NVMe.html | 3804 -------- libblockdev/docs/3.0/libblockdev-Part.html | 1914 ---- libblockdev/docs/3.0/libblockdev-Plugins.html | 351 - libblockdev/docs/3.0/libblockdev-Swap.html | 556 -- libblockdev/docs/3.0/libblockdev-Utils.html | 2402 ----- .../3.0/libblockdev-blockdev-library.html | 534 -- libblockdev/docs/3.0/libblockdev-s390.html | 821 -- libblockdev/docs/3.0/libblockdev.devhelp2 | 1621 ---- libblockdev/docs/3.0/right-insensitive.png | Bin 373 -> 0 bytes libblockdev/docs/3.0/right.png | Bin 261 -> 0 bytes libblockdev/docs/3.0/style.css | 530 -- libblockdev/docs/3.0/up-insensitive.png | Bin 374 -> 0 bytes libblockdev/docs/3.0/up.png | Bin 260 -> 0 bytes 33 files changed, 42636 deletions(-) delete mode 100644 libblockdev/docs/3.0/30-api-changes.html delete mode 100644 libblockdev/docs/3.0/annotation-glossary.html delete mode 100644 libblockdev/docs/3.0/api-index-full.html delete mode 100644 libblockdev/docs/3.0/ch01.html delete mode 100644 libblockdev/docs/3.0/ch02.html delete mode 100644 libblockdev/docs/3.0/ch03.html delete mode 100644 libblockdev/docs/3.0/home.png delete mode 100644 libblockdev/docs/3.0/index.html delete mode 100644 libblockdev/docs/3.0/left-insensitive.png delete mode 100644 libblockdev/docs/3.0/left.png delete mode 100644 libblockdev/docs/3.0/libblockdev-BTRFS.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Crypto.html delete mode 100644 libblockdev/docs/3.0/libblockdev-DeviceMapper.html delete mode 100644 libblockdev/docs/3.0/libblockdev-FS.html delete mode 100644 libblockdev/docs/3.0/libblockdev-KernelBlockDevices.html delete mode 100644 libblockdev/docs/3.0/libblockdev-LVM.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Loop.html delete mode 100644 libblockdev/docs/3.0/libblockdev-MD-RAID.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Mpath.html delete mode 100644 libblockdev/docs/3.0/libblockdev-NVDIMM.html delete mode 100644 libblockdev/docs/3.0/libblockdev-NVMe.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Part.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Plugins.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Swap.html delete mode 100644 libblockdev/docs/3.0/libblockdev-Utils.html delete mode 100644 libblockdev/docs/3.0/libblockdev-blockdev-library.html delete mode 100644 libblockdev/docs/3.0/libblockdev-s390.html delete mode 100644 libblockdev/docs/3.0/libblockdev.devhelp2 delete mode 100644 libblockdev/docs/3.0/right-insensitive.png delete mode 100644 libblockdev/docs/3.0/right.png delete mode 100644 libblockdev/docs/3.0/style.css delete mode 100644 libblockdev/docs/3.0/up-insensitive.png delete mode 100644 libblockdev/docs/3.0/up.png diff --git a/libblockdev/docs/3.0/30-api-changes.html b/libblockdev/docs/3.0/30-api-changes.html deleted file mode 100644 index 3cc8e96..0000000 --- a/libblockdev/docs/3.0/30-api-changes.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - -API changes in libblockdev 3.0: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-

-API changes in libblockdev 3.0

-

- This is a list of API changes in libblockdev 3.0 with suggested replacements. -

-
-

-LVM plugin

-

- bd_lvm_data_lv_name() has been removed, use data_lv from BDLVMLVdata instead. -

-

- bd_lvm_metadadata_lv_name() has been removed, use metadata_lv from BDLVMLVdata instead. -

-

- BD_LVM_MAX_LV_SIZE constant has been removed, use bd_lvm_get_max_lv_size() instead. -

-
-
-

-VDO plugin

-

- VDO plugin has been removed. -

-
-
-

-NVDIMM plugin

-

- bd_nvdimm_namepace_get_supported_sector_sizes has been removed, use bd_nvdimm_namespace_get_supported_sector_sizes instead. -

-
-
-

-FS plugin

-

- bd_fs_clean and bd_fs_wipe have new parameter force - that allows controlling whether the signatures will be removed from a mounted device or not. Use - TRUE to preserve the original behaviour. -

-

- Following functions have a new parameter fstype that allows to skip scanning the device - for signature. Use NULL to preserve the original behaviour. - Affected functions: bd_fs_resize, bd_fs_repair, bd_fs_check, bd_fs_set_label, bd_fs_set_uuid, bd_fs_get_size and bd_fs_get_free_space -

-

- Type-specific bd_fs_..._wipe functions have been removed. Use bd_fs_wipe or bd_fs_clean instead. - Affected functions: bd_fs_btrfs_wipe, bd_fs_ext2_wipe, bd_fs_ext3_wipe, bd_fs_ext4_wipe, bd_fs_exfat_wipe, bd_fs_f2fs_wipe, bd_fs_nilfs2_wipe, bd_fs_ntfs_wipe, bd_fs_vfat_wipe, bd_fs_udf_wipe, bd_fs_xfs_wipe -

-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/annotation-glossary.html b/libblockdev/docs/3.0/annotation-glossary.html deleted file mode 100644 index 12260b9..0000000 --- a/libblockdev/docs/3.0/annotation-glossary.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - -Annotation Glossary: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - -
-

-Annotation Glossary

-

A

-
allow-none
-

NULL is OK, both for passing and for returning.

-
array
-

Parameter points to an array of items.

-

C

-
constructor
-

This symbol is a constructor, not a static method.

-

E

-
element-type
-

Generics and defining elements of containers and arrays.

-

N

-
nullable
-

NULL may be passed as the value in, out, in-out; or as a return value.

-

O

-
optional
-

NULL may be passed instead of a pointer to a location.

-
out
-

Parameter for returning results. Default is transfer full.

-

S

-
scope notified
-

The callback is valid until the GDestroyNotify argument is called.

-
skip
-

Exposed in C code, not necessarily available in other languages.

-

T

-
transfer container
-

The caller owns the data container, but not the data inside it.

-
transfer full
-

The caller owns the data, and is responsible for free it.

-
transfer none
-

The data is owned by the callee, which is responsible of freeing it.

-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/api-index-full.html b/libblockdev/docs/3.0/api-index-full.html deleted file mode 100644 index 720bd7d..0000000 --- a/libblockdev/docs/3.0/api-index-full.html +++ /dev/null @@ -1,3295 +0,0 @@ - - - - -API Index: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-

-API Index

-

B

-
-BDBtrfsDeviceInfo, struct in BTRFS -
-
-
-BDBtrfsError, enum in BTRFS -
-
-
-BDBtrfsFilesystemInfo, struct in BTRFS -
-
-
-BDBtrfsSubvolumeInfo, struct in BTRFS -
-
-
-BDBtrfsTech, enum in BTRFS -
-
-
-BDBtrfsTechMode, enum in BTRFS -
-
-
-bd_btrfs_add_device, function in BTRFS -
-
-
-bd_btrfs_change_label, function in BTRFS -
-
-
-bd_btrfs_check, function in BTRFS -
-
-
-bd_btrfs_check_deps, function in BTRFS -
-
-
-bd_btrfs_close, function in BTRFS -
-
-
-bd_btrfs_create_snapshot, function in BTRFS -
-
-
-bd_btrfs_create_subvolume, function in BTRFS -
-
-
-bd_btrfs_create_volume, function in BTRFS -
-
-
-bd_btrfs_delete_subvolume, function in BTRFS -
-
-
-bd_btrfs_device_info_copy, function in BTRFS -
-
-
-bd_btrfs_device_info_free, function in BTRFS -
-
-
-BD_BTRFS_ERROR, macro in BTRFS -
-
-
-bd_btrfs_error_quark, function in BTRFS -
-
-
-bd_btrfs_filesystem_info, function in BTRFS -
-
-
-bd_btrfs_filesystem_info_copy, function in BTRFS -
-
-
-bd_btrfs_filesystem_info_free, function in BTRFS -
-
-
-bd_btrfs_get_default_subvolume_id, function in BTRFS -
-
-
-bd_btrfs_init, function in BTRFS -
-
-
-bd_btrfs_is_tech_avail, function in BTRFS -
-
-
-bd_btrfs_list_devices, function in BTRFS -
-
-
-bd_btrfs_list_subvolumes, function in BTRFS -
-
-
-BD_BTRFS_MAIN_VOLUME_ID, macro in BTRFS -
-
-
-BD_BTRFS_MIN_MEMBER_SIZE, macro in BTRFS -
-
-
-bd_btrfs_mkfs, function in BTRFS -
-
-
-bd_btrfs_remove_device, function in BTRFS -
-
-
-bd_btrfs_repair, function in BTRFS -
-
-
-bd_btrfs_resize, function in BTRFS -
-
-
-bd_btrfs_set_default_subvolume, function in BTRFS -
-
-
-bd_btrfs_subvolume_info_copy, function in BTRFS -
-
-
-bd_btrfs_subvolume_info_free, function in BTRFS -
-
-

C

-
-BDCryptoError, enum in Crypto -
-
-
-BDCryptoIntegrityExtra, struct in Crypto -
-
-
-BDCryptoIntegrityInfo, struct in Crypto -
-
-
-BDCryptoIntegrityOpenFlags, enum in Crypto -
-
-
-BDCryptoLUKSExtra, struct in Crypto -
-
-
-BDCryptoLUKSInfo, struct in Crypto -
-
-
-BDCryptoLUKSPBKDF, struct in Crypto -
-
-
-BDCryptoLUKSTokenInfo, struct in Crypto -
-
-
-BDCryptoLUKSVersion, enum in Crypto -
-
-
-BDCryptoTech, enum in Crypto -
-
-
-BDCryptoTechMode, enum in Crypto -
-
-
-BD_CRYPTO_BACKUP_PASSPHRASE_CHARSET, macro in Crypto -
-
-
-BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH, macro in Crypto -
-
-
-bd_crypto_bitlk_close, function in Crypto -
-
-
-bd_crypto_bitlk_open, function in Crypto -
-
-
-bd_crypto_check_deps, function in Crypto -
-
-
-BD_CRYPTO_CHI_SQUARE_BYTES_TO_CHECK, macro in Crypto -
-
-
-BD_CRYPTO_CHI_SQUARE_LOWER_LIMIT, macro in Crypto -
-
-
-BD_CRYPTO_CHI_SQUARE_UPPER_LIMIT, macro in Crypto -
-
-
-bd_crypto_close, function in Crypto -
-
-
-bd_crypto_device_is_luks, function in Crypto -
-
-
-bd_crypto_device_seems_encrypted, function in Crypto -
-
-
-BD_CRYPTO_ERROR, macro in Crypto -
-
-
-bd_crypto_error_quark, function in Crypto -
-
-
-bd_crypto_escrow_device, function in Crypto -
-
-
-bd_crypto_generate_backup_passphrase, function in Crypto -
-
-
-bd_crypto_init, function in Crypto -
-
-
-bd_crypto_integrity_close, function in Crypto -
-
-
-bd_crypto_integrity_extra_copy, function in Crypto -
-
-
-bd_crypto_integrity_extra_free, function in Crypto -
-
-
-bd_crypto_integrity_extra_new, function in Crypto -
-
-
-bd_crypto_integrity_format, function in Crypto -
-
-
-bd_crypto_integrity_info, function in Crypto -
-
-
-bd_crypto_integrity_info_copy, function in Crypto -
-
-
-bd_crypto_integrity_info_free, function in Crypto -
-
-
-bd_crypto_integrity_open, function in Crypto -
-
-
-bd_crypto_is_tech_avail, function in Crypto -
-
-
-bd_crypto_keyring_add_key, function in Crypto -
-
-
-bd_crypto_luks_add_key, function in Crypto -
-
-
-bd_crypto_luks_add_key_blob, function in Crypto -
-
-
-bd_crypto_luks_change_key, function in Crypto -
-
-
-bd_crypto_luks_change_key_blob, function in Crypto -
-
-
-bd_crypto_luks_close, function in Crypto -
-
-
-bd_crypto_luks_extra_copy, function in Crypto -
-
-
-bd_crypto_luks_extra_free, function in Crypto -
-
-
-bd_crypto_luks_extra_new, function in Crypto -
-
-
-bd_crypto_luks_format, function in Crypto -
-
-
-bd_crypto_luks_format_blob, function in Crypto -
-
-
-bd_crypto_luks_format_luks2, function in Crypto -
-
-
-bd_crypto_luks_format_luks2_blob, function in Crypto -
-
-
-bd_crypto_luks_get_metadata_size, function in Crypto -
-
-
-bd_crypto_luks_header_backup, function in Crypto -
-
-
-bd_crypto_luks_header_restore, function in Crypto -
-
-
-bd_crypto_luks_info, function in Crypto -
-
-
-bd_crypto_luks_info_copy, function in Crypto -
-
-
-bd_crypto_luks_info_free, function in Crypto -
-
-
-bd_crypto_luks_kill_slot, function in Crypto -
-
-
-BD_CRYPTO_LUKS_METADATA_SIZE, macro in Crypto -
-
-
-bd_crypto_luks_open, function in Crypto -
-
-
-bd_crypto_luks_open_blob, function in Crypto -
-
-
-bd_crypto_luks_open_keyring, function in Crypto -
-
-
-bd_crypto_luks_pbkdf_copy, function in Crypto -
-
-
-bd_crypto_luks_pbkdf_free, function in Crypto -
-
-
-bd_crypto_luks_pbkdf_new, function in Crypto -
-
-
-bd_crypto_luks_remove_key, function in Crypto -
-
-
-bd_crypto_luks_remove_key_blob, function in Crypto -
-
-
-bd_crypto_luks_resize, function in Crypto -
-
-
-bd_crypto_luks_resize_luks2, function in Crypto -
-
-
-bd_crypto_luks_resize_luks2_blob, function in Crypto -
-
-
-bd_crypto_luks_resume, function in Crypto -
-
-
-bd_crypto_luks_resume_blob, function in Crypto -
-
-
-bd_crypto_luks_set_label, function in Crypto -
-
-
-bd_crypto_luks_set_uuid, function in Crypto -
-
-
-bd_crypto_luks_status, function in Crypto -
-
-
-bd_crypto_luks_suspend, function in Crypto -
-
-
-bd_crypto_luks_token_info, function in Crypto -
-
-
-bd_crypto_luks_token_info_copy, function in Crypto -
-
-
-bd_crypto_luks_token_info_free, function in Crypto -
-
-
-bd_crypto_luks_uuid, function in Crypto -
-
-
-bd_crypto_tc_close, function in Crypto -
-
-
-bd_crypto_tc_open, function in Crypto -
-
-
-bd_crypto_tc_open_full, function in Crypto -
-
-

D

-
-BDDMError, enum in DeviceMapper -
-
-
-BDDMTech, enum in DeviceMapper -
-
-
-BDDMTechMode, enum in DeviceMapper -
-
-
-bd_dm_activate_raid_set, function in DeviceMapper -
-
-
-bd_dm_check_deps, function in DeviceMapper -
-
-
-bd_dm_close, function in DeviceMapper -
-
-
-bd_dm_create_linear, function in DeviceMapper -
-
-
-bd_dm_deactivate_raid_set, function in DeviceMapper -
-
-
-BD_DM_ERROR, macro in DeviceMapper -
-
-
-bd_dm_error_quark, function in DeviceMapper -
-
-
-bd_dm_get_member_raid_sets, function in DeviceMapper -
-
-
-bd_dm_get_raid_set_type, function in DeviceMapper -
-
-
-bd_dm_get_subsystem_from_name, function in DeviceMapper -
-
-
-bd_dm_init, function in DeviceMapper -
-
-
-bd_dm_is_tech_avail, function in DeviceMapper -
-
-
-bd_dm_map_exists, function in DeviceMapper -
-
-
-bd_dm_name_from_node, function in DeviceMapper -
-
-
-bd_dm_node_from_name, function in DeviceMapper -
-
-
-bd_dm_remove, function in DeviceMapper -
-
-

E

-
-EB, macro in Utils -
-
-
-EiB, macro in Utils -
-
-
-bd_ensure_init, function in blockdev library -
-
-
-EXABYTE, macro in Utils -
-
-
-EXBIBYTE, macro in Utils -
-
-
-BDExtraArg, struct in Utils -
-
-
-bd_extra_arg_copy, function in Utils -
-
-
-bd_extra_arg_free, function in Utils -
-
-
-bd_extra_arg_get_type, function in Utils -
-
-
-bd_extra_arg_new, function in Utils -
-
-

F

-
-BDFSBtrfsInfo, struct in FS -
-
-
-BDFSConfigureFlags, enum in FS -
-
-
-BDFsError, enum in FS -
-
-
-BDFSExfatInfo, struct in FS -
-
-
-BDFSExt2Info, typedef in FS -
-
-
-BDFSExt3Info, typedef in FS -
-
-
-BDFSExt4Info, typedef in FS -
-
-
-BDFSF2FSFeature, enum in FS -
-
-
-BDFSF2FSInfo, struct in FS -
-
-
-BDFSFeatureFlags, enum in FS -
-
-
-BDFSFeatures, struct in FS -
-
-
-BDFSFsckFlags, enum in FS -
-
-
-BDFSMkfsOptions, struct in FS -
-
-
-BDFSMkfsOptionsFlags, enum in FS -
-
-
-BDFSNILFS2Info, struct in FS -
-
-
-BDFSNtfsInfo, struct in FS -
-
-
-BDFsResizeFlags, enum in FS -
-
-
-BDFSTech, enum in FS -
-
-
-BDFSTechMode, enum in FS -
-
-
-BDFSUdfInfo, struct in FS -
-
-
-BDFSVfatInfo, struct in FS -
-
-
-BDFSXfsInfo, struct in FS -
-
-
-bd_fs_btrfs_check, function in FS -
-
-
-bd_fs_btrfs_check_label, function in FS -
-
-
-bd_fs_btrfs_check_uuid, function in FS -
-
-
-bd_fs_btrfs_get_info, function in FS -
-
-
-bd_fs_btrfs_info_copy, function in FS -
-
-
-bd_fs_btrfs_info_free, function in FS -
-
-
-bd_fs_btrfs_mkfs, function in FS -
-
-
-bd_fs_btrfs_repair, function in FS -
-
-
-bd_fs_btrfs_resize, function in FS -
-
-
-bd_fs_btrfs_set_label, function in FS -
-
-
-bd_fs_btrfs_set_uuid, function in FS -
-
-
-bd_fs_can_check, function in FS -
-
-
-bd_fs_can_get_free_space, function in FS -
-
-
-bd_fs_can_get_size, function in FS -
-
-
-bd_fs_can_mkfs, function in FS -
-
-
-bd_fs_can_repair, function in FS -
-
-
-bd_fs_can_resize, function in FS -
-
-
-bd_fs_can_set_label, function in FS -
-
-
-bd_fs_can_set_uuid, function in FS -
-
-
-bd_fs_check, function in FS -
-
-
-bd_fs_check_deps, function in FS -
-
-
-bd_fs_check_label, function in FS -
-
-
-bd_fs_check_uuid, function in FS -
-
-
-bd_fs_clean, function in FS -
-
-
-bd_fs_close, function in FS -
-
-
-BD_FS_ERROR, macro in FS -
-
-
-bd_fs_error_quark, function in FS -
-
-
-bd_fs_exfat_check, function in FS -
-
-
-bd_fs_exfat_check_label, function in FS -
-
-
-bd_fs_exfat_get_info, function in FS -
-
-
-bd_fs_exfat_info_copy, function in FS -
-
-
-bd_fs_exfat_info_free, function in FS -
-
-
-bd_fs_exfat_mkfs, function in FS -
-
-
-bd_fs_exfat_repair, function in FS -
-
-
-bd_fs_exfat_set_label, function in FS -
-
-
-bd_fs_ext2_check, function in FS -
-
-
-bd_fs_ext2_check_label, function in FS -
-
-
-bd_fs_ext2_check_uuid, function in FS -
-
-
-bd_fs_ext2_get_info, function in FS -
-
-
-bd_fs_ext2_info_copy, function in FS -
-
-
-bd_fs_ext2_info_free, function in FS -
-
-
-bd_fs_ext2_mkfs, function in FS -
-
-
-bd_fs_ext2_repair, function in FS -
-
-
-bd_fs_ext2_resize, function in FS -
-
-
-bd_fs_ext2_set_label, function in FS -
-
-
-bd_fs_ext2_set_uuid, function in FS -
-
-
-bd_fs_ext3_check, function in FS -
-
-
-bd_fs_ext3_check_label, function in FS -
-
-
-bd_fs_ext3_check_uuid, function in FS -
-
-
-bd_fs_ext3_get_info, function in FS -
-
-
-bd_fs_ext3_info_copy, function in FS -
-
-
-bd_fs_ext3_info_free, function in FS -
-
-
-bd_fs_ext3_mkfs, function in FS -
-
-
-bd_fs_ext3_repair, function in FS -
-
-
-bd_fs_ext3_resize, function in FS -
-
-
-bd_fs_ext3_set_label, function in FS -
-
-
-bd_fs_ext3_set_uuid, function in FS -
-
-
-bd_fs_ext4_check, function in FS -
-
-
-bd_fs_ext4_check_label, function in FS -
-
-
-bd_fs_ext4_check_uuid, function in FS -
-
-
-bd_fs_ext4_get_info, function in FS -
-
-
-bd_fs_ext4_info_copy, function in FS -
-
-
-bd_fs_ext4_info_free, function in FS -
-
-
-bd_fs_ext4_mkfs, function in FS -
-
-
-bd_fs_ext4_repair, function in FS -
-
-
-bd_fs_ext4_resize, function in FS -
-
-
-bd_fs_ext4_set_label, function in FS -
-
-
-bd_fs_ext4_set_uuid, function in FS -
-
-
-bd_fs_f2fs_check, function in FS -
-
-
-bd_fs_f2fs_get_info, function in FS -
-
-
-bd_fs_f2fs_info_copy, function in FS -
-
-
-bd_fs_f2fs_info_free, function in FS -
-
-
-bd_fs_f2fs_mkfs, function in FS -
-
-
-bd_fs_f2fs_repair, function in FS -
-
-
-bd_fs_f2fs_resize, function in FS -
-
-
-bd_fs_features, function in FS -
-
-
-bd_fs_features_copy, function in FS -
-
-
-bd_fs_features_free, function in FS -
-
-
-bd_fs_freeze, function in FS -
-
-
-bd_fs_get_free_space, function in FS -
-
-
-bd_fs_get_fstype, function in FS -
-
-
-bd_fs_get_mountpoint, function in FS -
-
-
-bd_fs_get_size, function in FS -
-
-
-bd_fs_init, function in FS -
-
-
-bd_fs_is_mountpoint, function in FS -
-
-
-bd_fs_is_tech_avail, function in FS -
-
-
-bd_fs_mkfs, function in FS -
-
-
-bd_fs_mkfs_options_copy, function in FS -
-
-
-bd_fs_mkfs_options_free, function in FS -
-
-
-bd_fs_mount, function in FS -
-
-
-bd_fs_nilfs2_check_label, function in FS -
-
-
-bd_fs_nilfs2_check_uuid, function in FS -
-
-
-bd_fs_nilfs2_get_info, function in FS -
-
-
-bd_fs_nilfs2_info_copy, function in FS -
-
-
-bd_fs_nilfs2_info_free, function in FS -
-
-
-bd_fs_nilfs2_mkfs, function in FS -
-
-
-bd_fs_nilfs2_resize, function in FS -
-
-
-bd_fs_nilfs2_set_label, function in FS -
-
-
-bd_fs_nilfs2_set_uuid, function in FS -
-
-
-bd_fs_ntfs_check, function in FS -
-
-
-bd_fs_ntfs_check_label, function in FS -
-
-
-bd_fs_ntfs_check_uuid, function in FS -
-
-
-bd_fs_ntfs_get_info, function in FS -
-
-
-bd_fs_ntfs_info_copy, function in FS -
-
-
-bd_fs_ntfs_info_free, function in FS -
-
-
-bd_fs_ntfs_mkfs, function in FS -
-
-
-bd_fs_ntfs_repair, function in FS -
-
-
-bd_fs_ntfs_resize, function in FS -
-
-
-bd_fs_ntfs_set_label, function in FS -
-
-
-bd_fs_ntfs_set_uuid, function in FS -
-
-
-bd_fs_repair, function in FS -
-
-
-bd_fs_resize, function in FS -
-
-
-bd_fs_set_label, function in FS -
-
-
-bd_fs_set_uuid, function in FS -
-
-
-bd_fs_supported_filesystems, function in FS -
-
-
-bd_fs_udf_check_label, function in FS -
-
-
-bd_fs_udf_check_uuid, function in FS -
-
-
-bd_fs_udf_get_info, function in FS -
-
-
-bd_fs_udf_info_copy, function in FS -
-
-
-bd_fs_udf_info_free, function in FS -
-
-
-bd_fs_udf_mkfs, function in FS -
-
-
-bd_fs_udf_set_label, function in FS -
-
-
-bd_fs_udf_set_uuid, function in FS -
-
-
-bd_fs_unfreeze, function in FS -
-
-
-bd_fs_unmount, function in FS -
-
-
-bd_fs_vfat_check, function in FS -
-
-
-bd_fs_vfat_check_label, function in FS -
-
-
-bd_fs_vfat_get_info, function in FS -
-
-
-bd_fs_vfat_info_copy, function in FS -
-
-
-bd_fs_vfat_info_free, function in FS -
-
-
-bd_fs_vfat_mkfs, function in FS -
-
-
-bd_fs_vfat_repair, function in FS -
-
-
-bd_fs_vfat_resize, function in FS -
-
-
-bd_fs_vfat_set_label, function in FS -
-
-
-bd_fs_wipe, function in FS -
-
-
-bd_fs_xfs_check, function in FS -
-
-
-bd_fs_xfs_check_label, function in FS -
-
-
-bd_fs_xfs_check_uuid, function in FS -
-
-
-bd_fs_xfs_get_info, function in FS -
-
-
-bd_fs_xfs_info_copy, function in FS -
-
-
-bd_fs_xfs_info_free, function in FS -
-
-
-bd_fs_xfs_mkfs, function in FS -
-
-
-bd_fs_xfs_repair, function in FS -
-
-
-bd_fs_xfs_resize, function in FS -
-
-
-bd_fs_xfs_set_label, function in FS -
-
-
-bd_fs_xfs_set_uuid, function in FS -
-
-

G

-
-GB, macro in Utils -
-
-
-bd_get_available_plugin_names, function in Plugins -
-
-
-bd_get_plugin_name, function in Plugins -
-
-
-bd_get_plugin_soname, function in Plugins -
-
-
-GiB, macro in Utils -
-
-
-GIBIBYTE, macro in Utils -
-
-
-GIGABYTE, macro in Utils -
-
-

I

-
-bd_init, function in blockdev library -
-
-
-BDInitError, enum in blockdev library -
-
-
-BD_INIT_ERROR, macro in blockdev library -
-
-
-bd_init_error_quark, function in blockdev library -
-
-
-bd_is_initialized, function in blockdev library -
-
-
-bd_is_plugin_available, function in Plugins -
-
-

K

-
-KB, macro in Utils -
-
-
-BDKBDBcacheMode, enum in KernelBlockDevices -
-
-
-BDKBDBcacheStats, struct in KernelBlockDevices -
-
-
-BDKBDError, enum in KernelBlockDevices -
-
-
-BDKBDTech, enum in KernelBlockDevices -
-
-
-BDKBDTechMode, enum in KernelBlockDevices -
-
-
-BDKBDZramStats, struct in KernelBlockDevices -
-
-
-bd_kbd_bcache_attach, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_create, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_destroy, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_detach, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_get_backing_device, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_get_cache_device, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_get_mode, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_get_mode_from_str, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_get_mode_str, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_set_mode, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_stats_copy, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_stats_free, function in KernelBlockDevices -
-
-
-bd_kbd_bcache_status, function in KernelBlockDevices -
-
-
-bd_kbd_check_deps, function in KernelBlockDevices -
-
-
-bd_kbd_close, function in KernelBlockDevices -
-
-
-BD_KBD_ERROR, macro in KernelBlockDevices -
-
-
-bd_kbd_error_quark, function in KernelBlockDevices -
-
-
-bd_kbd_init, function in KernelBlockDevices -
-
-
-bd_kbd_is_tech_avail, function in KernelBlockDevices -
-
-
-bd_kbd_zram_add_device, function in KernelBlockDevices -
-
-
-bd_kbd_zram_create_devices, function in KernelBlockDevices -
-
-
-bd_kbd_zram_destroy_devices, function in KernelBlockDevices -
-
-
-bd_kbd_zram_get_stats, function in KernelBlockDevices -
-
-
-bd_kbd_zram_remove_device, function in KernelBlockDevices -
-
-
-bd_kbd_zram_stats_copy, function in KernelBlockDevices -
-
-
-bd_kbd_zram_stats_free, function in KernelBlockDevices -
-
-
-KiB, macro in Utils -
-
-
-KIBIBYTE, macro in Utils -
-
-
-KILOBYTE, macro in Utils -
-
-

L

-
-BDLoopError, enum in Loop -
-
-
-BDLoopTech, enum in Loop -
-
-
-BDLoopTechMode, enum in Loop -
-
-
-bd_loop_check_deps, function in Loop -
-
-
-bd_loop_close, function in Loop -
-
-
-BD_LOOP_ERROR, macro in Loop -
-
-
-bd_loop_error_quark, function in Loop -
-
-
-bd_loop_get_autoclear, function in Loop -
-
-
-bd_loop_get_backing_file, function in Loop -
-
-
-bd_loop_get_loop_name, function in Loop -
-
-
-bd_loop_init, function in Loop -
-
-
-bd_loop_is_tech_avail, function in Loop -
-
-
-bd_loop_setup, function in Loop -
-
-
-bd_loop_setup_from_fd, function in Loop -
-
-
-bd_loop_set_autoclear, function in Loop -
-
-
-bd_loop_teardown, function in Loop -
-
-
-BDLVMCacheMode, enum in LVM -
-
-
-BDLVMCachePoolFlags, enum in LVM -
-
-
-BDLVMCacheStats, struct in LVM -
-
-
-BDLVMError, enum in LVM -
-
-
-BDLVMLVdata, struct in LVM -
-
-
-BDLVMPVdata, struct in LVM -
-
-
-BDLVMSEGdata, struct in LVM -
-
-
-BDLVMTech, enum in LVM -
-
-
-BDLVMTechMode, enum in LVM -
-
-
-BDLVMVDOCompressionState, enum in LVM -
-
-
-BDLVMVDOIndexState, enum in LVM -
-
-
-BDLVMVDOOperatingMode, enum in LVM -
-
-
-BDLVMVDOPooldata, struct in LVM -
-
-
-BDLVMVDOStats, struct in LVM -
-
-
-BDLVMVDOWritePolicy, enum in LVM -
-
-
-BDLVMVGdata, struct in LVM -
-
-
-bd_lvm_add_lv_tags, function in LVM -
-
-
-bd_lvm_add_pv_tags, function in LVM -
-
-
-bd_lvm_add_vg_tags, function in LVM -
-
-
-bd_lvm_cache_attach, function in LVM -
-
-
-bd_lvm_cache_create_cached_lv, function in LVM -
-
-
-bd_lvm_cache_create_pool, function in LVM -
-
-
-bd_lvm_cache_detach, function in LVM -
-
-
-bd_lvm_cache_get_default_md_size, function in LVM -
-
-
-bd_lvm_cache_get_mode_from_str, function in LVM -
-
-
-bd_lvm_cache_get_mode_str, function in LVM -
-
-
-bd_lvm_cache_pool_convert, function in LVM -
-
-
-bd_lvm_cache_pool_name, function in LVM -
-
-
-bd_lvm_cache_stats, function in LVM -
-
-
-bd_lvm_cache_stats_copy, function in LVM -
-
-
-bd_lvm_cache_stats_free, function in LVM -
-
-
-bd_lvm_check_deps, function in LVM -
-
-
-bd_lvm_close, function in LVM -
-
-
-BD_LVM_DEFAULT_CHUNK_SIZE, macro in LVM -
-
-
-BD_LVM_DEFAULT_PE_SIZE, macro in LVM -
-
-
-BD_LVM_DEFAULT_PE_START, macro in LVM -
-
-
-bd_lvm_delete_lv_tags, function in LVM -
-
-
-bd_lvm_delete_pv_tags, function in LVM -
-
-
-bd_lvm_delete_vg_tags, function in LVM -
-
-
-bd_lvm_devices_add, function in LVM -
-
-
-bd_lvm_devices_delete, function in LVM -
-
-
-BD_LVM_ERROR, macro in LVM -
-
-
-bd_lvm_error_quark, function in LVM -
-
-
-bd_lvm_get_devices_filter, function in LVM -
-
-
-bd_lvm_get_global_config, function in LVM -
-
-
-bd_lvm_get_lv_physical_size, function in LVM -
-
-
-bd_lvm_get_max_lv_size, function in LVM -
-
-
-bd_lvm_get_supported_pe_sizes, function in LVM -
-
-
-bd_lvm_get_thpool_meta_size, function in LVM -
-
-
-bd_lvm_get_thpool_padding, function in LVM -
-
-
-bd_lvm_get_vdo_compression_state_str, function in LVM -
-
-
-bd_lvm_get_vdo_index_state_str, function in LVM -
-
-
-bd_lvm_get_vdo_operating_mode_str, function in LVM -
-
-
-bd_lvm_get_vdo_write_policy_from_str, function in LVM -
-
-
-bd_lvm_get_vdo_write_policy_str, function in LVM -
-
-
-bd_lvm_init, function in LVM -
-
-
-bd_lvm_is_supported_pe_size, function in LVM -
-
-
-bd_lvm_is_tech_avail, function in LVM -
-
-
-bd_lvm_is_valid_thpool_chunk_size, function in LVM -
-
-
-bd_lvm_is_valid_thpool_md_size, function in LVM -
-
-
-bd_lvm_lvactivate, function in LVM -
-
-
-bd_lvm_lvcreate, function in LVM -
-
-
-bd_lvm_lvdata_copy, function in LVM -
-
-
-bd_lvm_lvdata_free, function in LVM -
-
-
-bd_lvm_lvdeactivate, function in LVM -
-
-
-bd_lvm_lvinfo, function in LVM -
-
-
-bd_lvm_lvinfo_tree, function in LVM -
-
-
-bd_lvm_lvorigin, function in LVM -
-
-
-bd_lvm_lvremove, function in LVM -
-
-
-bd_lvm_lvrename, function in LVM -
-
-
-bd_lvm_lvrepair, function in LVM -
-
-
-bd_lvm_lvresize, function in LVM -
-
-
-bd_lvm_lvs, function in LVM -
-
-
-bd_lvm_lvsnapshotcreate, function in LVM -
-
-
-bd_lvm_lvsnapshotmerge, function in LVM -
-
-
-bd_lvm_lvs_tree, function in LVM -
-
-
-BD_LVM_MAX_PE_SIZE, macro in LVM -
-
-
-BD_LVM_MAX_THPOOL_CHUNK_SIZE, macro in LVM -
-
-
-BD_LVM_MAX_THPOOL_MD_SIZE, macro in LVM -
-
-
-BD_LVM_MIN_CACHE_MD_SIZE, macro in LVM -
-
-
-BD_LVM_MIN_PE_SIZE, macro in LVM -
-
-
-BD_LVM_MIN_THPOOL_CHUNK_SIZE, macro in LVM -
-
-
-BD_LVM_MIN_THPOOL_MD_SIZE, macro in LVM -
-
-
-bd_lvm_pvcreate, function in LVM -
-
-
-bd_lvm_pvdata_copy, function in LVM -
-
-
-bd_lvm_pvdata_free, function in LVM -
-
-
-bd_lvm_pvinfo, function in LVM -
-
-
-bd_lvm_pvmove, function in LVM -
-
-
-bd_lvm_pvremove, function in LVM -
-
-
-bd_lvm_pvresize, function in LVM -
-
-
-bd_lvm_pvs, function in LVM -
-
-
-bd_lvm_pvscan, function in LVM -
-
-
-bd_lvm_round_size_to_pe, function in LVM -
-
-
-bd_lvm_segdata_copy, function in LVM -
-
-
-bd_lvm_segdata_free, function in LVM -
-
-
-bd_lvm_set_devices_filter, function in LVM -
-
-
-bd_lvm_set_global_config, function in LVM -
-
-
-bd_lvm_thlvcreate, function in LVM -
-
-
-bd_lvm_thlvpoolname, function in LVM -
-
-
-bd_lvm_thpoolcreate, function in LVM -
-
-
-bd_lvm_thpool_convert, function in LVM -
-
-
-bd_lvm_thsnapshotcreate, function in LVM -
-
-
-bd_lvm_vdolvpoolname, function in LVM -
-
-
-bd_lvm_vdopooldata_copy, function in LVM -
-
-
-bd_lvm_vdopooldata_free, function in LVM -
-
-
-bd_lvm_vdo_disable_compression, function in LVM -
-
-
-bd_lvm_vdo_disable_deduplication, function in LVM -
-
-
-bd_lvm_vdo_enable_compression, function in LVM -
-
-
-bd_lvm_vdo_enable_deduplication, function in LVM -
-
-
-bd_lvm_vdo_get_stats, function in LVM -
-
-
-bd_lvm_vdo_get_stats_full, function in LVM -
-
-
-bd_lvm_vdo_info, function in LVM -
-
-
-bd_lvm_vdo_pool_convert, function in LVM -
-
-
-bd_lvm_vdo_pool_create, function in LVM -
-
-
-bd_lvm_vdo_pool_resize, function in LVM -
-
-
-bd_lvm_vdo_resize, function in LVM -
-
-
-bd_lvm_vdo_stats_copy, function in LVM -
-
-
-bd_lvm_vdo_stats_free, function in LVM -
-
-
-bd_lvm_vgactivate, function in LVM -
-
-
-bd_lvm_vgcreate, function in LVM -
-
-
-bd_lvm_vgdata_copy, function in LVM -
-
-
-bd_lvm_vgdata_free, function in LVM -
-
-
-bd_lvm_vgdeactivate, function in LVM -
-
-
-bd_lvm_vgextend, function in LVM -
-
-
-bd_lvm_vginfo, function in LVM -
-
-
-bd_lvm_vgreduce, function in LVM -
-
-
-bd_lvm_vgremove, function in LVM -
-
-
-bd_lvm_vgrename, function in LVM -
-
-
-bd_lvm_vgs, function in LVM -
-
-
-bd_lvm_writecache_attach, function in LVM -
-
-
-bd_lvm_writecache_create_cached_lv, function in LVM -
-
-
-bd_lvm_writecache_detach, function in LVM -
-
-

M

-
-MB, macro in Utils -
-
-
-BDMDDetailData, struct in MD RAID -
-
-
-BDMDError, enum in MD RAID -
-
-
-BDMDExamineData, struct in MD RAID -
-
-
-BDMDTech, enum in MD RAID -
-
-
-BDMDTechMode, enum in MD RAID -
-
-
-bd_md_activate, function in MD RAID -
-
-
-bd_md_add, function in MD RAID -
-
-
-bd_md_canonicalize_uuid, function in MD RAID -
-
-
-bd_md_check_deps, function in MD RAID -
-
-
-BD_MD_CHUNK_SIZE, macro in MD RAID -
-
-
-bd_md_close, function in MD RAID -
-
-
-bd_md_create, function in MD RAID -
-
-
-bd_md_deactivate, function in MD RAID -
-
-
-bd_md_denominate, function in MD RAID -
-
-
-bd_md_destroy, function in MD RAID -
-
-
-bd_md_detail, function in MD RAID -
-
-
-bd_md_detail_data_copy, function in MD RAID -
-
-
-bd_md_detail_data_free, function in MD RAID -
-
-
-BD_MD_ERROR, macro in MD RAID -
-
-
-bd_md_error_quark, function in MD RAID -
-
-
-bd_md_examine, function in MD RAID -
-
-
-bd_md_examine_data_copy, function in MD RAID -
-
-
-bd_md_examine_data_free, function in MD RAID -
-
-
-bd_md_get_bitmap_location, function in MD RAID -
-
-
-bd_md_get_md_uuid, function in MD RAID -
-
-
-bd_md_get_status, function in MD RAID -
-
-
-bd_md_get_superblock_size, function in MD RAID -
-
-
-bd_md_init, function in MD RAID -
-
-
-bd_md_is_tech_avail, function in MD RAID -
-
-
-bd_md_name_from_node, function in MD RAID -
-
-
-bd_md_node_from_name, function in MD RAID -
-
-
-bd_md_nominate, function in MD RAID -
-
-
-bd_md_remove, function in MD RAID -
-
-
-bd_md_request_sync_action, function in MD RAID -
-
-
-bd_md_run, function in MD RAID -
-
-
-bd_md_set_bitmap_location, function in MD RAID -
-
-
-BD_MD_SUPERBLOCK_SIZE, macro in MD RAID -
-
-
-MEBIBYTE, macro in Utils -
-
-
-MEGABYTE, macro in Utils -
-
-
-MiB, macro in Utils -
-
-
-BDMpathError, enum in Mpath -
-
-
-BDMpathTech, enum in Mpath -
-
-
-BDMpathTechMode, enum in Mpath -
-
-
-bd_mpath_check_deps, function in Mpath -
-
-
-bd_mpath_close, function in Mpath -
-
-
-BD_MPATH_ERROR, macro in Mpath -
-
-
-bd_mpath_error_quark, function in Mpath -
-
-
-bd_mpath_flush_mpaths, function in Mpath -
-
-
-bd_mpath_get_mpath_members, function in Mpath -
-
-
-bd_mpath_init, function in Mpath -
-
-
-bd_mpath_is_mpath_member, function in Mpath -
-
-
-bd_mpath_is_tech_avail, function in Mpath -
-
-
-bd_mpath_set_friendly_names, function in Mpath -
-
-

N

-
-BDNVDIMMError, enum in NVDIMM -
-
-
-BDNVDIMMNamespaceInfo, struct in NVDIMM -
-
-
-BDNVDIMMNamespaceMode, enum in NVDIMM -
-
-
-BDNVDIMMTech, enum in NVDIMM -
-
-
-BDNVDIMMTechMode, enum in NVDIMM -
-
-
-bd_nvdimm_check_deps, function in NVDIMM -
-
-
-bd_nvdimm_close, function in NVDIMM -
-
-
-BD_NVDIMM_ERROR, macro in NVDIMM -
-
-
-bd_nvdimm_error_quark, function in NVDIMM -
-
-
-bd_nvdimm_init, function in NVDIMM -
-
-
-bd_nvdimm_is_tech_avail, function in NVDIMM -
-
-
-bd_nvdimm_list_namespaces, function in NVDIMM -
-
-
-bd_nvdimm_namespace_disable, function in NVDIMM -
-
-
-bd_nvdimm_namespace_enable, function in NVDIMM -
-
-
-bd_nvdimm_namespace_get_devname, function in NVDIMM -
-
-
-bd_nvdimm_namespace_get_mode_from_str, function in NVDIMM -
-
-
-bd_nvdimm_namespace_get_mode_str, function in NVDIMM -
-
-
-bd_nvdimm_namespace_get_supported_sector_sizes, function in NVDIMM -
-
-
-bd_nvdimm_namespace_info, function in NVDIMM -
-
-
-bd_nvdimm_namespace_info_copy, function in NVDIMM -
-
-
-bd_nvdimm_namespace_info_free, function in NVDIMM -
-
-
-bd_nvdimm_namespace_reconfigure, function in NVDIMM -
-
-
-BDNVMEAddressFamily, enum in NVMe -
-
-
-BDNVMEControllerFeature, enum in NVMe -
-
-
-BDNVMEControllerInfo, struct in NVMe -
-
-
-BDNVMEControllerType, enum in NVMe -
-
-
-BDNVMEDiscoveryLogEntry, struct in NVMe -
-
-
-BDNVMEError, enum in NVMe -
-
-
-BDNVMEErrorLogEntry, struct in NVMe -
-
-
-BDNVMEFormatSecureErase, enum in NVMe -
-
-
-BDNVMELBAFormat, struct in NVMe -
-
-
-BDNVMELBAFormatRelativePerformance, enum in NVMe -
-
-
-BDNVMENamespaceFeature, enum in NVMe -
-
-
-BDNVMENamespaceInfo, struct in NVMe -
-
-
-BDNVMESanitizeAction, enum in NVMe -
-
-
-BDNVMESanitizeLog, struct in NVMe -
-
-
-BDNVMESanitizeStatus, enum in NVMe -
-
-
-BDNVMESelfTestAction, enum in NVMe -
-
-
-BDNVMESelfTestLog, struct in NVMe -
-
-
-BDNVMESelfTestLogEntry, struct in NVMe -
-
-
-BDNVMESelfTestResult, enum in NVMe -
-
-
-BDNVMESmartCriticalWarning, enum in NVMe -
-
-
-BDNVMESmartLog, struct in NVMe -
-
-
-BDNVMETCPSecurity, enum in NVMe -
-
-
-BDNVMETech, enum in NVMe -
-
-
-BDNVMETechMode, enum in NVMe -
-
-
-BDNVMETransportType, enum in NVMe -
-
-
-bd_nvme_check_deps, function in NVMe -
-
-
-bd_nvme_close, function in NVMe -
-
-
-bd_nvme_connect, function in NVMe -
-
-
-bd_nvme_controller_info_copy, function in NVMe -
-
-
-bd_nvme_controller_info_free, function in NVMe -
-
-
-bd_nvme_device_self_test, function in NVMe -
-
-
-bd_nvme_disconnect, function in NVMe -
-
-
-bd_nvme_disconnect_by_path, function in NVMe -
-
-
-bd_nvme_discover, function in NVMe -
-
-
-bd_nvme_discovery_log_entry_copy, function in NVMe -
-
-
-bd_nvme_discovery_log_entry_free, function in NVMe -
-
-
-BD_NVME_ERROR, macro in NVMe -
-
-
-bd_nvme_error_log_entry_copy, function in NVMe -
-
-
-bd_nvme_error_log_entry_free, function in NVMe -
-
-
-bd_nvme_error_quark, function in NVMe -
-
-
-bd_nvme_find_ctrls_for_ns, function in NVMe -
-
-
-bd_nvme_format, function in NVMe -
-
-
-bd_nvme_generate_host_nqn, function in NVMe -
-
-
-bd_nvme_get_controller_info, function in NVMe -
-
-
-bd_nvme_get_error_log_entries, function in NVMe -
-
-
-bd_nvme_get_host_id, function in NVMe -
-
-
-bd_nvme_get_host_nqn, function in NVMe -
-
-
-bd_nvme_get_namespace_info, function in NVMe -
-
-
-bd_nvme_get_sanitize_log, function in NVMe -
-
-
-bd_nvme_get_self_test_log, function in NVMe -
-
-
-bd_nvme_get_smart_log, function in NVMe -
-
-
-bd_nvme_init, function in NVMe -
-
-
-bd_nvme_is_tech_avail, function in NVMe -
-
-
-bd_nvme_lba_format_copy, function in NVMe -
-
-
-bd_nvme_lba_format_free, function in NVMe -
-
-
-bd_nvme_namespace_info_copy, function in NVMe -
-
-
-bd_nvme_namespace_info_free, function in NVMe -
-
-
-bd_nvme_sanitize, function in NVMe -
-
-
-bd_nvme_sanitize_log_copy, function in NVMe -
-
-
-bd_nvme_sanitize_log_free, function in NVMe -
-
-
-bd_nvme_self_test_log_copy, function in NVMe -
-
-
-bd_nvme_self_test_log_entry_copy, function in NVMe -
-
-
-bd_nvme_self_test_log_entry_free, function in NVMe -
-
-
-bd_nvme_self_test_log_free, function in NVMe -
-
-
-bd_nvme_self_test_result_to_string, function in NVMe -
-
-
-bd_nvme_set_host_id, function in NVMe -
-
-
-bd_nvme_set_host_nqn, function in NVMe -
-
-
-bd_nvme_smart_log_copy, function in NVMe -
-
-
-bd_nvme_smart_log_free, function in NVMe -
-
-

P

-
-BDPartAlign, enum in Part -
-
-
-BDPartDiskFlag, enum in Part -
-
-
-BDPartDiskSpec, struct in Part -
-
-
-BDPartError, enum in Part -
-
-
-BDPartFlag, enum in Part -
-
-
-BDPartSpec, struct in Part -
-
-
-BDPartTableType, enum in Part -
-
-
-BDPartTech, enum in Part -
-
-
-BDPartTechMode, enum in Part -
-
-
-BDPartType, enum in Part -
-
-
-BDPartTypeReq, enum in Part -
-
-
-bd_part_check_deps, function in Part -
-
-
-bd_part_close, function in Part -
-
-
-bd_part_create_part, function in Part -
-
-
-bd_part_create_table, function in Part -
-
-
-bd_part_delete_part, function in Part -
-
-
-bd_part_disk_spec_copy, function in Part -
-
-
-bd_part_disk_spec_free, function in Part -
-
-
-BD_PART_ERROR, macro in Part -
-
-
-bd_part_error_quark, function in Part -
-
-
-bd_part_get_best_free_region, function in Part -
-
-
-bd_part_get_disk_free_regions, function in Part -
-
-
-bd_part_get_disk_parts, function in Part -
-
-
-bd_part_get_disk_spec, function in Part -
-
-
-bd_part_get_flag_str, function in Part -
-
-
-bd_part_get_part_by_pos, function in Part -
-
-
-bd_part_get_part_id, function in Part -
-
-
-bd_part_get_part_spec, function in Part -
-
-
-bd_part_get_part_table_type_str, function in Part -
-
-
-bd_part_get_type_str, function in Part -
-
-
-bd_part_init, function in Part -
-
-
-bd_part_is_tech_avail, function in Part -
-
-
-bd_part_resize_part, function in Part -
-
-
-bd_part_set_disk_flag, function in Part -
-
-
-bd_part_set_part_flag, function in Part -
-
-
-bd_part_set_part_flags, function in Part -
-
-
-bd_part_set_part_id, function in Part -
-
-
-bd_part_set_part_name, function in Part -
-
-
-bd_part_set_part_type, function in Part -
-
-
-bd_part_spec_copy, function in Part -
-
-
-bd_part_spec_free, function in Part -
-
-
-bd_part_spec_get_type, function in Part -
-
-
-BD_PART_TYPE_SPEC, macro in Part -
-
-
-PB, macro in Utils -
-
-
-PEBIBYTE, macro in Utils -
-
-
-PETABYTE, macro in Utils -
-
-
-PiB, macro in Utils -
-
-
-BDPlugin, enum in Plugins -
-
-
-bd_plugin_spec_copy, function in Plugins -
-
-
-bd_plugin_spec_free, function in Plugins -
-
-

R

-
-bd_reinit, function in blockdev library -
-
-

S

-
-BDS390Error, enum in s390 -
-
-
-BDS390Tech, enum in s390 -
-
-
-BDS390TechMode, enum in s390 -
-
-
-bd_s390_check_deps, function in s390 -
-
-
-bd_s390_close, function in s390 -
-
-
-bd_s390_dasd_format, function in s390 -
-
-
-bd_s390_dasd_is_fba, function in s390 -
-
-
-bd_s390_dasd_is_ldl, function in s390 -
-
-
-bd_s390_dasd_needs_format, function in s390 -
-
-
-bd_s390_dasd_online, function in s390 -
-
-
-BD_S390_ERROR, macro in s390 -
-
-
-bd_s390_error_quark, function in s390 -
-
-
-bd_s390_init, function in s390 -
-
-
-bd_s390_is_tech_avail, function in s390 -
-
-
-bd_s390_sanitize_dev_input, function in s390 -
-
-
-bd_s390_zfcp_offline, function in s390 -
-
-
-bd_s390_zfcp_online, function in s390 -
-
-
-bd_s390_zfcp_sanitize_lun_input, function in s390 -
-
-
-bd_s390_zfcp_sanitize_wwpn_input, function in s390 -
-
-
-bd_s390_zfcp_scsi_offline, function in s390 -
-
-
-BDSwapError, enum in Swap -
-
-
-BDSwapTech, enum in Swap -
-
-
-BDSwapTechMode, enum in Swap -
-
-
-bd_swap_check_deps, function in Swap -
-
-
-bd_swap_close, function in Swap -
-
-
-BD_SWAP_ERROR, macro in Swap -
-
-
-bd_swap_error_quark, function in Swap -
-
-
-bd_swap_init, function in Swap -
-
-
-bd_swap_is_tech_avail, function in Swap -
-
-
-bd_swap_mkswap, function in Swap -
-
-
-bd_swap_set_label, function in Swap -
-
-
-bd_swap_swapoff, function in Swap -
-
-
-bd_swap_swapon, function in Swap -
-
-
-bd_swap_swapstatus, function in Swap -
-
-
-bd_switch_init_checks, function in blockdev library -
-
-

T

-
-TB, macro in Utils -
-
-
-TEBIBYTE, macro in Utils -
-
-
-TERABYTE, macro in Utils -
-
-
-TiB, macro in Utils -
-
-
-bd_try_init, function in blockdev library -
-
-
-bd_try_reinit, function in blockdev library -
-
-

U

-
-BDUtilsDBusError, enum in Utils -
-
-
-BDUtilsDevUtilsError, enum in Utils -
-
-
-BDUtilsExecError, enum in Utils -
-
-
-BDUtilsLinuxVersion, struct in Utils -
-
-
-BDUtilsLogFunc, user_function in Utils -
-
-
-BDUtilsModuleError, enum in Utils -
-
-
-BDUtilsProgExtract, user_function in Utils -
-
-
-BDUtilsProgFunc, user_function in Utils -
-
-
-BDUtilsProgStatus, enum in Utils -
-
-
-bd_utils_check_linux_version, function in Utils -
-
-
-bd_utils_check_util_version, function in Utils -
-
-
-BD_UTILS_DBUS_ERROR, macro in Utils -
-
-
-bd_utils_dbus_error_quark, function in Utils -
-
-
-bd_utils_dbus_service_available, function in Utils -
-
-
-BD_UTILS_DEV_UTILS_ERROR, macro in Utils -
-
-
-bd_utils_dev_utils_error_quark, function in Utils -
-
-
-bd_utils_echo_str_to_file, function in Utils -
-
-
-bd_utils_exec_and_capture_output, function in Utils -
-
-
-bd_utils_exec_and_report_error, function in Utils -
-
-
-bd_utils_exec_and_report_error_no_progress, function in Utils -
-
-
-bd_utils_exec_and_report_progress, function in Utils -
-
-
-bd_utils_exec_and_report_status_error, function in Utils -
-
-
-BD_UTILS_EXEC_ERROR, macro in Utils -
-
-
-bd_utils_exec_error_quark, function in Utils -
-
-
-bd_utils_exec_with_input, function in Utils -
-
-
-bd_utils_get_device_symlinks, function in Utils -
-
-
-bd_utils_get_linux_version, function in Utils -
-
-
-bd_utils_get_next_task_id, function in Utils -
-
-
-bd_utils_have_kernel_module, function in Utils -
-
-
-bd_utils_init_logging, function in Utils -
-
-
-bd_utils_init_prog_reporting, function in Utils -
-
-
-bd_utils_init_prog_reporting_thread, function in Utils -
-
-
-bd_utils_load_kernel_module, function in Utils -
-
-
-bd_utils_log, function in Utils -
-
-
-BD_UTILS_LOG_ALERT, macro in Utils -
-
-
-BD_UTILS_LOG_CRIT, macro in Utils -
-
-
-BD_UTILS_LOG_DEBUG, macro in Utils -
-
-
-BD_UTILS_LOG_EMERG, macro in Utils -
-
-
-BD_UTILS_LOG_ERR, macro in Utils -
-
-
-bd_utils_log_format, function in Utils -
-
-
-BD_UTILS_LOG_INFO, macro in Utils -
-
-
-BD_UTILS_LOG_NOTICE, macro in Utils -
-
-
-bd_utils_log_stdout, function in Utils -
-
-
-bd_utils_log_task_status, function in Utils -
-
-
-BD_UTILS_LOG_WARNING, macro in Utils -
-
-
-BD_UTILS_MODULE_ERROR, macro in Utils -
-
-
-bd_utils_module_error_quark, function in Utils -
-
-
-bd_utils_mute_prog_reporting_thread, function in Utils -
-
-
-bd_utils_prog_reporting_initialized, function in Utils -
-
-
-bd_utils_report_finished, function in Utils -
-
-
-bd_utils_report_progress, function in Utils -
-
-
-bd_utils_report_started, function in Utils -
-
-
-bd_utils_resolve_device, function in Utils -
-
-
-bd_utils_set_log_level, function in Utils -
-
-
-bd_utils_unload_kernel_module, function in Utils -
-
-
-bd_utils_version_cmp, function in Utils -
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/ch01.html b/libblockdev/docs/3.0/ch01.html deleted file mode 100644 index 21ba53e..0000000 --- a/libblockdev/docs/3.0/ch01.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -libblockdev Reference Manual: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-

-libblockdev Reference Manual

-
-
-blockdev library — a library for doing low-level operations with block devices -
-
-BTRFS — plugin for operations with BTRFS devices -
-
-Crypto — plugin for operations with encrypted devices -
-
-DeviceMapper — plugin for basic operations with device mapper -
-
-FS — plugin for operations with file systems -
-
-Loop — plugin for operations with loop devices -
-
-LVM — plugin for operations with LVM -
-
-MD RAID — plugin for basic operations with MD RAID -
-
-Mpath — plugin for basic operations with multipath devices -
-
-NVDIMM — plugin for operations with nvdimm space -
-
-NVMe — NVMe device reporting and management. -
-
-Plugins — functions related to querying plugins -
-
-Part — plugin for operations with partition tables -
-
-Swap — plugin for operations with swap space -
-
-KernelBlockDevices — plugin for operations with kernel block devices -
-
-s390 — plugin for operations with s390 -
-
-Utils — library providing utility functions used by the blockdev library and its plugins -
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/ch02.html b/libblockdev/docs/3.0/ch02.html deleted file mode 100644 index f4a9ec7..0000000 --- a/libblockdev/docs/3.0/ch02.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - -GI Overrides: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-

-GI Overrides

-

- The libblockdev library supports GObject introspection and thus - can be used from a variety of languages. To make such use even easier and to make - the code using libblockdev from different languages than C feel more natural the - library also provides so-called overrides — pieces of - code that usually wrap the original libblockdev functions with language-native - objects (usually functions) that provide language-specific features like default - values for parameters etc. -

-

- The overrides are not documented here (yet), but it should be easy to directly check - the sources for anybody who understands their language of choice. The overrides are - located in the src/LANG_NAME directory in the - source tree. The only language that libblockdev provides overrides for right now is - Python (under the src/python directory). -

-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/ch03.html b/libblockdev/docs/3.0/ch03.html deleted file mode 100644 index ffc03af..0000000 --- a/libblockdev/docs/3.0/ch03.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - -Testing libblockdev: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-

-Testing libblockdev

-

- libblockdev's test suite is written using the standard unittest.TestCase framework - in Python. Tests are separated in modules, usually one per libblockdev plugin - e.g. - BTRFS, LVM, Crypto. There are one or more base classes in each module used to - setup the environment and perform some testing. More specific test scenarios - inherit from these base classes. -

-

- Before running the tests you have to prepare your system so that libblockdev - can be built from source. -

-

- Install all build requirements. On Fedora this can be done with -

-

-cat dist/libblockdev.spec.in | grep BuildRequires: | cut -f2 -d: | cut -f2 -d' ' | xargs dnf -y install
-
-

- - Configure the build scripts - -

-
./autogen.sh
-./configure
-

-

-

- To execute the Pylint code analysis tool run: - -

-
make check
-

- - The check target is a dependency of all test targets and you don't have to - execute it explicitly when testing. -

-

- To execute the test suite from inside the source directory run one of these - commands: - -

-
make test
-

- - executes all safe tests or - -

-
make fast-test
-

- - executes all fast tests or - -

-
make test-all
-

- - executes all tests, including ones which may result in kernel panic or - take more time to complete or - -

-
make test-plugin-NAME
-

- - executes only tests for given plugin and similarly - -

-
make fast-test-plugin-NAME
-

- - executes only fast tests for given plugin. -

-

- It is also possible to run only subset of available tests or only one test - using the `run_tests.py` script: - -

-
# python3 tests/run_tests.py fs_test.GenericResize
-

- - executes all tests from the GenericResize test class - from filesystem plugin test cases and - -

-
# python3 tests/run_tests.py fs_test.GenericResize.test_ext2_generic_resize
-

- - executes only test_ext2_generic_resize from this class. - - This script also allows skipping slow tests or running potentially dangerous - tests. Use: - -

-
$ python3 tests/run_tests.py --help
-

- - to see all available options. - -

-

- It is also possible to generate test coverage reports using the Python coverage - tool: - -

-
make coverage
-

- - is equivalent to `make test'. - -

-
make coverage-all
-

- - is equivalent to `make test-all'. -

-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/home.png b/libblockdev/docs/3.0/home.png deleted file mode 100644 index 9346b336a784463192c7daab5133a3673dd69845..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 256 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefRMbARQqaxysz9Q}BI-m)~Y zggoA|1V*z2{cQ=d;!=?fvu4~`n82RKrk1UubNXTJj1GP|o-=>$A29f{JgJ9K`^t{Q z-oWs>M&_hvT&MjX@T4-&sBW+1^4oB5G4r2q!qGktZ!n*!)hjrjd0_4L6;4%u<}orJ u%Vo~x?#i!!ww+1OGuHe}T=cKQUzn^_t)8|WlnDbmjKR~@&t;ucLK6T - - - -libblockdev Reference Manual for libblockdev 2.99.: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - -
-
-
-
-
-

-

-

- The latest version of this documentation can be found on-line at - http://storaged.org/libblockdev/. -

-

-

-

- The latest version of the code can be found at - https://github.com/storaged-project/libblockdev -

-

-

-

- Documentation for Python bindings is available here -

-

-

-
-
-
-
-
-
libblockdev Reference Manual
-
-
-blockdev library — a library for doing low-level operations with block devices -
-
-BTRFS — plugin for operations with BTRFS devices -
-
-Crypto — plugin for operations with encrypted devices -
-
-DeviceMapper — plugin for basic operations with device mapper -
-
-FS — plugin for operations with file systems -
-
-Loop — plugin for operations with loop devices -
-
-LVM — plugin for operations with LVM -
-
-MD RAID — plugin for basic operations with MD RAID -
-
-Mpath — plugin for basic operations with multipath devices -
-
-NVDIMM — plugin for operations with nvdimm space -
-
-NVMe — NVMe device reporting and management. -
-
-Plugins — functions related to querying plugins -
-
-Part — plugin for operations with partition tables -
-
-Swap — plugin for operations with swap space -
-
-KernelBlockDevices — plugin for operations with kernel block devices -
-
-s390 — plugin for operations with s390 -
-
-Utils — library providing utility functions used by the blockdev library and its plugins -
-
-
GI Overrides
-
Testing libblockdev
-
API changes in libblockdev 3.0
-
API Index
-
Annotation Glossary
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/left-insensitive.png b/libblockdev/docs/3.0/left-insensitive.png deleted file mode 100644 index 3269393a7f72af744a772c437bd7b3976c23709d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 395 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefH0HbvDJm`3=E7Co-U3d7N^fnTIWJ3j{^~q!iyia4kV=mdU|Jhfgdm;SLIpiYJ7wv^kjFiECCc&8T30!RG0~&BG=X zlu#U4@Z`))V`EG9e^NqDr#{!5k|)wT* zYTNt0`@q%TAD$){%#eQ?;$^ly8}yZCU%T~u0XM^%t?f#e znB*EuLv2rP%K3BMvFO}YmnR}KSgH;`EHL$)^!tH~iBxZ#h^zJi*#P5Xb6B50U@nx2 mU;T=yfcwnSOsS9SKd{M#MlNkCuvG>I8-u5-pUXO@geCx5`k@p6 diff --git a/libblockdev/docs/3.0/left.png b/libblockdev/docs/3.0/left.png deleted file mode 100644 index 2abde032b0c98b756b12d380da4318205cd78470..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 262 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefRMaSLay~*pwMJb7sn8b(^oI8=R24v(*CjE{-BFv z0BhvLm?o9(UC{-Ci?lD?Ve-7-xypA!PTC(0^;>UheG4Altep3@`rO0#Rjs1)RxCLr zE5mee>7m*=%yEk+GVvGkRy0O&*&MTd5SjH(lgq~7r%6oRW$l1p-*S}iC>@fyDsz%y z`UIW8^Ao=maGhj3E8{7Cd_qof`K4oa->23`>&M2+XBtd2J`8jogQu&X%Q~loCIG_? BVG#fT diff --git a/libblockdev/docs/3.0/libblockdev-BTRFS.html b/libblockdev/docs/3.0/libblockdev-BTRFS.html deleted file mode 100644 index 61b5cb7..0000000 --- a/libblockdev/docs/3.0/libblockdev-BTRFS.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - -BTRFS: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

BTRFS

-

BTRFS — plugin for operations with BTRFS devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_btrfs_check_deps () -
-gboolean - -bd_btrfs_init () -
-void - -bd_btrfs_close () -
-GQuark - -bd_btrfs_error_quark () -
-void - -bd_btrfs_device_info_free () -
-BDBtrfsDeviceInfo * - -bd_btrfs_device_info_copy () -
-void - -bd_btrfs_subvolume_info_free () -
-BDBtrfsSubvolumeInfo * - -bd_btrfs_subvolume_info_copy () -
-void - -bd_btrfs_filesystem_info_free () -
-BDBtrfsFilesystemInfo * - -bd_btrfs_filesystem_info_copy () -
-gboolean - -bd_btrfs_create_volume () -
-gboolean - -bd_btrfs_add_device () -
-gboolean - -bd_btrfs_remove_device () -
-gboolean - -bd_btrfs_create_subvolume () -
-gboolean - -bd_btrfs_delete_subvolume () -
-guint64 - -bd_btrfs_get_default_subvolume_id () -
-gboolean - -bd_btrfs_set_default_subvolume () -
-gboolean - -bd_btrfs_create_snapshot () -
-BDBtrfsDeviceInfo ** - -bd_btrfs_list_devices () -
-BDBtrfsSubvolumeInfo ** - -bd_btrfs_list_subvolumes () -
-BDBtrfsFilesystemInfo * - -bd_btrfs_filesystem_info () -
-gboolean - -bd_btrfs_mkfs () -
-gboolean - -bd_btrfs_resize () -
-gboolean - -bd_btrfs_check () -
-gboolean - -bd_btrfs_repair () -
-gboolean - -bd_btrfs_change_label () -
-gboolean - -bd_btrfs_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_BTRFS_MAIN_VOLUME_ID
#defineBD_BTRFS_MIN_MEMBER_SIZE
#defineBD_BTRFS_ERROR
enumBDBtrfsError
 BDBtrfsDeviceInfo
 BDBtrfsSubvolumeInfo
 BDBtrfsFilesystemInfo
enumBDBtrfsTech
enumBDBtrfsTechMode
-
-
-

Includes

-
#include <btrfs.h>
-
-
-
-

Description

-

A plugin for operations with btrfs devices.

-
-
-

Functions

-
-

bd_btrfs_check_deps ()

-
gboolean
-bd_btrfs_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_btrfs_init ()

-
gboolean
-bd_btrfs_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_btrfs_close ()

-
void
-bd_btrfs_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_btrfs_error_quark ()

-
GQuark
-bd_btrfs_error_quark (void);
-

[skip]

-
-
-
-

bd_btrfs_device_info_free ()

-
void
-bd_btrfs_device_info_free (BDBtrfsDeviceInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsDeviceInfo to free.

[nullable]
-
-
-
-
-

bd_btrfs_device_info_copy ()

-
BDBtrfsDeviceInfo *
-bd_btrfs_device_info_copy (BDBtrfsDeviceInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsDeviceInfo to copy.

[nullable]
-
-
-
-
-

bd_btrfs_subvolume_info_free ()

-
void
-bd_btrfs_subvolume_info_free (BDBtrfsSubvolumeInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsSubvolumeInfo to free.

[nullable]
-
-
-
-
-

bd_btrfs_subvolume_info_copy ()

-
BDBtrfsSubvolumeInfo *
-bd_btrfs_subvolume_info_copy (BDBtrfsSubvolumeInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsSubvolumeInfo to copy.

[nullable]
-
-
-
-
-

bd_btrfs_filesystem_info_free ()

-
void
-bd_btrfs_filesystem_info_free (BDBtrfsFilesystemInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsFilesystemInfo to free.

[nullable]
-
-
-
-
-

bd_btrfs_filesystem_info_copy ()

-
BDBtrfsFilesystemInfo *
-bd_btrfs_filesystem_info_copy (BDBtrfsFilesystemInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDBtrfsFilesystemInfo to copy.

[nullable]
-
-
-
-
-

bd_btrfs_create_volume ()

-
gboolean
-bd_btrfs_create_volume (const gchar **devices,
-                        const gchar *label,
-                        const gchar *data_level,
-                        const gchar *md_level,
-                        const BDExtraArg **extra,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

devices

list of devices to create btrfs volume from.

[array zero-terminated=1]

label

label for the volume.

[nullable]

data_level

RAID level for the data or NULL to use the default.

[nullable]

md_level

RAID level for the metadata or NULL to use the default.

[nullable]

extra

extra options for the volume creation (right now -passed to the 'mkfs.btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new btrfs volume was created from devices -or not

-

See mkfs.btrfs(8) for details about data_level -, md_level -and btrfs in general.

-

Tech category: BD_BTRFS_TECH_MULTI_DEV-BD_BTRFS_TECH_MODE_CREATE

-
-
-
-
-

bd_btrfs_add_device ()

-
gboolean
-bd_btrfs_add_device (const gchar *mountpoint,
-                     const gchar *device,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

mountpoint of the btrfs volume to add new device to

 

device

a device to add to the btrfs volume

 

extra

extra options for the addition (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully added to the mountpoint -btrfs volume or not

-

Tech category: BD_BTRFS_TECH_MULTI_DEV-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_remove_device ()

-
gboolean
-bd_btrfs_remove_device (const gchar *mountpoint,
-                        const gchar *device,
-                        const BDExtraArg **extra,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

mountpoint of the btrfs volume to remove device from

 

device

a device to remove from the btrfs volume

 

extra

extra options for the removal (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully removed from the mountpoint -btrfs volume or not

-

Tech category: BD_BTRFS_TECH_MULTI_DEV-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_create_subvolume ()

-
gboolean
-bd_btrfs_create_subvolume (const gchar *mountpoint,
-                           const gchar *name,
-                           const BDExtraArg **extra,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

mountpoint of the btrfs volume to create subvolume under

 

name

name of the subvolume

 

extra

extra options for the subvolume creation (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mountpoint -/name -subvolume was successfully created or not

-

Tech category: BD_BTRFS_TECH_SUBVOL-BD_BTRFS_TECH_MODE_CREATE

-
-
-
-
-

bd_btrfs_delete_subvolume ()

-
gboolean
-bd_btrfs_delete_subvolume (const gchar *mountpoint,
-                           const gchar *name,
-                           const BDExtraArg **extra,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

mountpoint of the btrfs volume to delete subvolume from

 

name

name of the subvolume

 

extra

extra options for the subvolume deletion (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mountpoint -/name -subvolume was successfully deleted or not

-

Tech category: BD_BTRFS_TECH_SUBVOL-BD_BTRFS_TECH_MODE_DELETE

-
-
-
-
-

bd_btrfs_get_default_subvolume_id ()

-
guint64
-bd_btrfs_get_default_subvolume_id (const gchar *mountpoint,
-                                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mountpoint

mountpoint of the volume to get the default subvolume ID of

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

ID of the mountpoint -volume's default subvolume. If 0, -error -) may be set to indicate error

-

Tech category: BD_BTRFS_TECH_SUBVOL-BD_BTRFS_TECH_MODE_QUERY

-
-
-
-
-

bd_btrfs_set_default_subvolume ()

-
gboolean
-bd_btrfs_set_default_subvolume (const gchar *mountpoint,
-                                guint64 subvol_id,
-                                const BDExtraArg **extra,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

mountpoint of the volume to set the default subvolume ID of

 

subvol_id

ID of the subvolume to be set as the default subvolume

 

extra

extra options for the setting (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mountpoint -volume's default subvolume was correctly set -to subvol_id -or not

-

Tech category: BD_BTRFS_TECH_SUBVOL-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_create_snapshot ()

-
gboolean
-bd_btrfs_create_snapshot (const gchar *source,
-                          const gchar *dest,
-                          gboolean ro,
-                          const BDExtraArg **extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

source

path to source subvolume

 

dest

path to new snapshot volume

 

ro

whether the snapshot should be read-only

 

extra

extra options for the snapshot creation (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the dest -snapshot of source -was successfully created or not

-

Tech category: BD_BTRFS_TECH_SNAPSHOT-BD_BTRFS_TECH_MODE_CREATE

-
-
-
-
-

bd_btrfs_list_devices ()

-
BDBtrfsDeviceInfo **
-bd_btrfs_list_devices (const gchar *device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a device that is part of the queried btrfs volume

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the devices that are part of the btrfs volume -containing device -or NULL in case of error

-

Tech category: BD_BTRFS_TECH_MULTI_DEV-BD_BTRFS_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_btrfs_list_subvolumes ()

-
BDBtrfsSubvolumeInfo **
-bd_btrfs_list_subvolumes (const gchar *mountpoint,
-                          gboolean snapshots_only,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

mountpoint

a mountpoint of the queried btrfs volume

 

snapshots_only

whether to list only snapshot subvolumes or not

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the subvolumes that are part of the btrfs volume -mounted at mountpoint -or NULL in case of error

-

The subvolumes are sorted in a way that no child subvolume appears in the -list before its parent (sub)volume.

-

Tech category: BD_BTRFS_TECH_SUBVOL-BD_BTRFS_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_btrfs_filesystem_info ()

-
BDBtrfsFilesystemInfo *
-bd_btrfs_filesystem_info (const gchar *device,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a device that is part of the queried btrfs volume

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the device -'s volume's filesystem or NULL in case of error

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_QUERY

-
-
-
-
-

bd_btrfs_mkfs ()

-
gboolean
-bd_btrfs_mkfs (const gchar **devices,
-               const gchar *label,
-               const gchar *data_level,
-               const gchar *md_level,
-               const BDExtraArg **extra,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

devices

list of devices to create btrfs volume from.

[array zero-terminated=1]

label

label for the volume.

[nullable]

data_level

RAID level for the data or NULL to use the default.

[nullable]

md_level

RAID level for the metadata or NULL to use the default.

[nullable]

extra

extra options for the volume creation (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new btrfs volume was created from devices -or not

-

See mkfs.btrfs(8) for details about data_level -, md_level -and btrfs in general.

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_CREATE

-
-
-
-
-

bd_btrfs_resize ()

-
gboolean
-bd_btrfs_resize (const gchar *mountpoint,
-                 guint64 size,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mountpoint

a mountpoint of the to be resized btrfs filesystem

 

size

requested new size

 

extra

extra options for the volume resize (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mountpoint -filesystem was successfully resized to size -or not

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_check ()

-
gboolean
-bd_btrfs_check (const gchar *device,
-                const BDExtraArg **extra,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

a device that is part of the checked btrfs volume

 

extra

extra options for the check (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the filesystem was successfully checked or not

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_QUERY

-
-
-
-
-

bd_btrfs_repair ()

-
gboolean
-bd_btrfs_repair (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

a device that is part of the to be repaired btrfs volume

 

extra

extra options for the repair (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the filesystem was successfully checked and repaired or not

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_change_label ()

-
gboolean
-bd_btrfs_change_label (const gchar *mountpoint,
-                       const gchar *label,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

mountpoint

a mountpoint of the btrfs filesystem to change label of

 

label

new label for the filesystem

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of the mountpoint -filesystem was successfully set -to label -or not

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_btrfs_is_tech_avail ()

-
gboolean
-bd_btrfs_is_tech_avail (BDBtrfsTech tech,
-                        guint64 mode,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDBtrfsTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_BTRFS_MAIN_VOLUME_ID

-
#define             BD_BTRFS_MAIN_VOLUME_ID
-
-
-
-

BD_BTRFS_MIN_MEMBER_SIZE

-
#define             BD_BTRFS_MIN_MEMBER_SIZE
-
-
-
-

BD_BTRFS_ERROR

-
#define             BD_BTRFS_ERROR
-
-
-
-

enum BDBtrfsError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_BTRFS_ERROR_DEVICE

  

BD_BTRFS_ERROR_PARSE

  

BD_BTRFS_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

BDBtrfsDeviceInfo

-
typedef struct {
-    guint64 id;
-    gchar *path;
-    guint64 size;
-    guint64 used;
-} BDBtrfsDeviceInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

guint64 id;

ID of the device

 

gchar *path;

path of the device

 

guint64 size;

size of the device

 

guint64 used;

size of the used space

 
-
-
-
-
-

BDBtrfsSubvolumeInfo

-
typedef struct {
-    guint64 id;
-    guint64 parent_id;
-    gchar *path;
-} BDBtrfsSubvolumeInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

guint64 id;

ID of the subvolume

 

guint64 parent_id;

ID of the parent (sub)volume

 

gchar *path;

path of the subvolume

 
-
-
-
-
-

BDBtrfsFilesystemInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 num_devices;
-    guint64 used;
-} BDBtrfsFilesystemInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 num_devices;

number of device in the filesystem

 

guint64 used;

size of the used space

 
-
-
-
-
-

enum BDBtrfsTech

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_BTRFS_TECH_FS

  

BD_BTRFS_TECH_MULTI_DEV

  

BD_BTRFS_TECH_SUBVOL

  

BD_BTRFS_TECH_SNAPSHOT

  
-
-
-
-
-

enum BDBtrfsTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_BTRFS_TECH_MODE_CREATE

  

BD_BTRFS_TECH_MODE_DELETE

  

BD_BTRFS_TECH_MODE_MODIFY

  

BD_BTRFS_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Crypto.html b/libblockdev/docs/3.0/libblockdev-Crypto.html deleted file mode 100644 index 2caac90..0000000 --- a/libblockdev/docs/3.0/libblockdev-Crypto.html +++ /dev/null @@ -1,4188 +0,0 @@ - - - - -Crypto: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Crypto

-

Crypto — plugin for operations with encrypted devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_crypto_check_deps () -
-void - -bd_crypto_close () -
-gboolean - -bd_crypto_init () -
-GQuark - -bd_crypto_error_quark () -
-gchar * - -bd_crypto_generate_backup_passphrase () -
-gboolean - -bd_crypto_device_is_luks () -
-gboolean - -bd_crypto_device_seems_encrypted () -
-gchar * - -bd_crypto_luks_uuid () -
-guint64 - -bd_crypto_luks_get_metadata_size () -
-gchar * - -bd_crypto_luks_status () -
-gboolean - -bd_crypto_luks_format () -
-gboolean - -bd_crypto_luks_format_blob () -
-void - -bd_crypto_luks_extra_free () -
-BDCryptoLUKSExtra * - -bd_crypto_luks_extra_copy () -
-BDCryptoLUKSExtra * - -bd_crypto_luks_extra_new () -
-void - -bd_crypto_luks_pbkdf_free () -
-BDCryptoLUKSPBKDF * - -bd_crypto_luks_pbkdf_copy () -
-BDCryptoLUKSPBKDF * - -bd_crypto_luks_pbkdf_new () -
-gboolean - -bd_crypto_luks_format_luks2 () -
-gboolean - -bd_crypto_luks_format_luks2_blob () -
-gboolean - -bd_crypto_luks_open () -
-gboolean - -bd_crypto_luks_open_blob () -
-gboolean - -bd_crypto_luks_close () -
-gboolean - -bd_crypto_luks_add_key () -
-gboolean - -bd_crypto_luks_add_key_blob () -
-gboolean - -bd_crypto_luks_remove_key () -
-gboolean - -bd_crypto_luks_remove_key_blob () -
-gboolean - -bd_crypto_luks_change_key () -
-gboolean - -bd_crypto_luks_change_key_blob () -
-gboolean - -bd_crypto_luks_resize () -
-gboolean - -bd_crypto_luks_resize_luks2 () -
-gboolean - -bd_crypto_luks_resize_luks2_blob () -
-gboolean - -bd_crypto_luks_suspend () -
-gboolean - -bd_crypto_luks_resume_blob () -
-gboolean - -bd_crypto_luks_resume () -
-gboolean - -bd_crypto_luks_kill_slot () -
-gboolean - -bd_crypto_luks_header_backup () -
-gboolean - -bd_crypto_luks_header_restore () -
-gboolean - -bd_crypto_luks_set_label () -
-gboolean - -bd_crypto_luks_set_uuid () -
-void - -bd_crypto_luks_info_free () -
-BDCryptoLUKSInfo * - -bd_crypto_luks_info_copy () -
-BDCryptoLUKSInfo * - -bd_crypto_luks_info () -
-void - -bd_crypto_integrity_info_free () -
-BDCryptoIntegrityInfo * - -bd_crypto_integrity_info_copy () -
-BDCryptoIntegrityInfo * - -bd_crypto_integrity_info () -
-BDCryptoIntegrityExtra * - -bd_crypto_integrity_extra_copy () -
-void - -bd_crypto_integrity_extra_free () -
-BDCryptoIntegrityExtra * - -bd_crypto_integrity_extra_new () -
-gboolean - -bd_crypto_integrity_format () -
-gboolean - -bd_crypto_integrity_open () -
-gboolean - -bd_crypto_integrity_close () -
-void - -bd_crypto_luks_token_info_free () -
-BDCryptoLUKSTokenInfo * - -bd_crypto_luks_token_info_copy () -
-BDCryptoLUKSTokenInfo ** - -bd_crypto_luks_token_info () -
-gboolean - -bd_crypto_keyring_add_key () -
-gboolean - -bd_crypto_luks_open_keyring () -
-gboolean - -bd_crypto_tc_open () -
-gboolean - -bd_crypto_tc_open_full () -
-gboolean - -bd_crypto_tc_close () -
-gboolean - -bd_crypto_escrow_device () -
-gboolean - -bd_crypto_bitlk_open () -
-gboolean - -bd_crypto_bitlk_close () -
-gboolean - -bd_crypto_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_CRYPTO_LUKS_METADATA_SIZE
#defineBD_CRYPTO_ERROR
enumBDCryptoError
#defineBD_CRYPTO_BACKUP_PASSPHRASE_CHARSET
#defineBD_CRYPTO_BACKUP_PASSPHRASE_LENGTH
#defineBD_CRYPTO_CHI_SQUARE_BYTES_TO_CHECK
#defineBD_CRYPTO_CHI_SQUARE_LOWER_LIMIT
#defineBD_CRYPTO_CHI_SQUARE_UPPER_LIMIT
 BDCryptoLUKSExtra
 BDCryptoLUKSPBKDF
enumBDCryptoLUKSVersion
 BDCryptoLUKSInfo
 BDCryptoIntegrityInfo
 BDCryptoIntegrityExtra
enumBDCryptoIntegrityOpenFlags
 BDCryptoLUKSTokenInfo
enumBDCryptoTech
enumBDCryptoTechMode
-
-
-

Includes

-
#include <crypto.h>
-
-
-
-

Description

-

A plugin for operations with encrypted devices. For now, only -LUKS devices are supported.

-

Functions taking a parameter called "device" require the backing device to be -passed. On the other hand functions taking the "luks_device" parameter -require the LUKS device (/dev/mapper/SOMETHING").

-

Sizes are given in bytes unless stated otherwise.

-
-
-

Functions

-
-

bd_crypto_check_deps ()

-
gboolean
-bd_crypto_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_crypto_close ()

-
void
-bd_crypto_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_crypto_init ()

-
gboolean
-bd_crypto_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_crypto_error_quark ()

-
GQuark
-bd_crypto_error_quark (void);
-

[skip]

-
-
-
-

bd_crypto_generate_backup_passphrase ()

-
gchar *
-bd_crypto_generate_backup_passphrase (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

A newly generated BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH-long passphrase.

-

See BD_CRYPTO_BACKUP_PASSPHRASE_CHARSET for the definition of the charset used for the passphrase.

-

Tech category: always available

-
-
-
-
-

bd_crypto_device_is_luks ()

-
gboolean
-bd_crypto_device_is_luks (const gchar *device,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the queried device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

TRUE if the given device -is a LUKS device or FALSE if not or -failed to determine (the error -) is populated with the error in such -cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_device_seems_encrypted ()

-
gboolean
-bd_crypto_device_seems_encrypted (const gchar *device,
-                                  GError **error);
-

Determines whether a block device seems to be encrypted.

-

TCRYPT volumes are not easily identifiable, because they have no -cleartext header, but are completely encrypted. This function is -used to determine whether a block device is a candidate for being -TCRYPT encrypted.

-

To achieve this, we calculate the chi square value of the first -512 Bytes and treat devices with a chi square value between 136 -and 426 as candidates for being encrypted. -For the reasoning, see: https://tails.boum.org/blueprint/veracrypt/

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the queried device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

TRUE if the given device -seems to be encrypted or FALSE if not or -failed to determine (the error -) is populated with the error in such -cases)

-

Tech category: BD_CRYPTO_TECH_TRUECRYPT-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_luks_uuid ()

-
gchar *
-bd_crypto_luks_uuid (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the queried device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

UUID of the device -or NULL if failed to determine (error -is populated with the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_luks_get_metadata_size ()

-
guint64
-bd_crypto_luks_get_metadata_size (const gchar *device,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the queried device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

luks device metadata size of the device -or 0 if failed to determine (error -is populated -with the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_luks_status ()

-
gchar *
-bd_crypto_luks_status (const gchar *luks_device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

luks_device

the queried LUKS device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

one of "invalid", "inactive", "active" or "busy" or -NULL if failed to determine (error -is populated with the error in -such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY.

-

[transfer none]

-
-
-
-
-

bd_crypto_luks_format ()

-
gboolean
-bd_crypto_luks_format (const gchar *device,
-                       const gchar *cipher,
-                       guint64 key_size,
-                       const gchar *passphrase,
-                       const gchar *key_file,
-                       guint64 min_entropy,
-                       GError **error);
-

Formats the given device - as LUKS according to the other parameters given. If -min_entropy - is specified (greater than 0), the function waits for enough -entropy to be available in the random data pool (WHICH MAY POTENTIALLY TAKE -FOREVER).

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

a device to format as LUKS

 

cipher

cipher specification (type-mode, e.g. "aes-xts-plain64") or NULL to use the default.

[nullable]

key_size

size of the volume key in bits or 0 to use the default

 

passphrase

a passphrase for the new LUKS device or NULL if not requested.

[nullable]

key_file

a key file for the new LUKS device or NULL if not requested.

[nullable]

min_entropy

minimum random data entropy (in bits) required to format device -as LUKS

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -was successfully formatted as LUKS or not -(the error -) contains the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_luks_format_blob ()

-
gboolean
-bd_crypto_luks_format_blob (const gchar *device,
-                            const gchar *cipher,
-                            guint64 key_size,
-                            const guint8 *pass_data,
-                            gsize data_len,
-                            guint64 min_entropy,
-                            GError **error);
-

Formats the given device - as LUKS according to the other parameters given. If -min_entropy - is specified (greater than 0), the function waits for enough -entropy to be available in the random data pool (WHICH MAY POTENTIALLY TAKE -FOREVER).

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

a device to format as LUKS

 

cipher

cipher specification (type-mode, e.g. "aes-xts-plain64") or NULL to use the default.

[nullable]

key_size

size of the volume key in bits or 0 to use the default

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

min_entropy

minimum random data entropy (in bits) required to format device -as LUKS

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -was successfully formatted as LUKS or not -(the error -) contains the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_luks_extra_free ()

-
void
-bd_crypto_luks_extra_free (BDCryptoLUKSExtra *extra);
-

Frees extra -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

extra

BDCryptoLUKSExtra to free.

[nullable]
-
-
-
-
-

bd_crypto_luks_extra_copy ()

-
BDCryptoLUKSExtra *
-bd_crypto_luks_extra_copy (BDCryptoLUKSExtra *extra);
-

Creates a new copy of extra -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

extra

BDCryptoLUKSExtra to copy.

[nullable]
-
-
-
-
-

bd_crypto_luks_extra_new ()

-
BDCryptoLUKSExtra *
-bd_crypto_luks_extra_new (guint64 data_alignment,
-                          const gchar *data_device,
-                          const gchar *integrity,
-                          guint64 sector_size,
-                          const gchar *label,
-                          const gchar *subsystem,
-                          BDCryptoLUKSPBKDF *pbkdf);
-

[constructor]

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

data_alignment

data alignment in sectors, 0 for default/auto detection

 

data_device

detached encrypted data device or NULL.

[nullable]

integrity

integrity algorithm (e.g. "hmac-sha256") or NULL for no integrity support.

[nullable]

sector_size

encryption sector size, 0 for default (512)

 

label

LUKS header label or NULL.

[nullable]

subsystem

LUKS header subsystem or NULL.

[nullable]

pbkdf

key derivation function specification or NULL for default.

[nullable]
-
-
-

Returns

-

a new LUKS extra argument.

-

[transfer full]

-
-
-
-
-

bd_crypto_luks_pbkdf_free ()

-
void
-bd_crypto_luks_pbkdf_free (BDCryptoLUKSPBKDF *pbkdf);
-

Frees pbkdf -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

pbkdf

BDCryptoLUKSPBKDF to free.

[nullable]
-
-
-
-
-

bd_crypto_luks_pbkdf_copy ()

-
BDCryptoLUKSPBKDF *
-bd_crypto_luks_pbkdf_copy (BDCryptoLUKSPBKDF *pbkdf);
-

Creates a new copy of pbkdf -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

pbkdf

BDCryptoLUKSPBKDF to copy.

[nullable]
-
-
-
-
-

bd_crypto_luks_pbkdf_new ()

-
BDCryptoLUKSPBKDF *
-bd_crypto_luks_pbkdf_new (const gchar *type,
-                          const gchar *hash,
-                          guint32 max_memory_kb,
-                          guint32 iterations,
-                          guint32 time_ms,
-                          guint32 parallel_threads);
-

[constructor]

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

type

PBKDF algorithm.

[nullable]

hash

hash for LUKS header or NULL for default.

[nullable]

max_memory_kb

requested memory cost (in KiB) or 0 for default (benchmark)

 

iterations

requested iterations or 0 for default (benchmark)

 

time_ms

requested time cost or 0 for default (benchmark)

 

parallel_threads

requested parallel cost (threads) or 0 for default (benchmark)

 
-
-
-

Returns

-

a new pbkdf argument.

-

[transfer full]

-
-
-
-
-

bd_crypto_luks_format_luks2 ()

-
gboolean
-bd_crypto_luks_format_luks2 (const gchar *device,
-                             const gchar *cipher,
-                             guint64 key_size,
-                             const gchar *passphrase,
-                             const gchar *key_file,
-                             guint64 min_entropy,
-                             BDCryptoLUKSVersion luks_version,
-                             BDCryptoLUKSExtra *extra,
-                             GError **error);
-

Formats the given device - as LUKS according to the other parameters given. If -min_entropy - is specified (greater than 0), the function waits for enough -entropy to be available in the random data pool (WHICH MAY POTENTIALLY TAKE -FOREVER).

-

Either passphrase - or key_file - has to be != NULL.

-

Using this function with luks_version - set to BD_CRYPTO_LUKS_VERSION_LUKS1 and -extra - to NULL is the same as calling bd_crypto_luks_format.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

a device to format as LUKS

 

cipher

cipher specification (type-mode, e.g. "aes-xts-plain64") or NULL to use the default.

[nullable]

key_size

size of the volume key in bits or 0 to use the default

 

passphrase

a passphrase for the new LUKS device or NULL if not requested.

[nullable]

key_file

a key file for the new LUKS device or NULL if not requested.

[nullable]

min_entropy

minimum random data entropy (in bits) required to format device -as LUKS

 

luks_version

whether to use LUKS v1 or LUKS v2

 

extra

extra arguments for LUKS format creation.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -was successfully formatted as LUKS or not -(the error -) contains the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS2-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_luks_format_luks2_blob ()

-
gboolean
-bd_crypto_luks_format_luks2_blob (const gchar *device,
-                                  const gchar *cipher,
-                                  guint64 key_size,
-                                  const guint8 *pass_data,
-                                  gsize data_len,
-                                  guint64 min_entropy,
-                                  BDCryptoLUKSVersion luks_version,
-                                  BDCryptoLUKSExtra *extra,
-                                  GError **error);
-

Formats the given device - as LUKS according to the other parameters given. If -min_entropy - is specified (greater than 0), the function waits for enough -entropy to be available in the random data pool (WHICH MAY POTENTIALLY TAKE -FOREVER).

-

Using this function with luks_version - set to BD_CRYPTO_LUKS_VERSION_LUKS1 and -extra - to NULL is the same as calling bd_crypto_luks_format_blob.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

a device to format as LUKS

 

cipher

cipher specification (type-mode, e.g. "aes-xts-plain64") or NULL to use the default.

[nullable]

key_size

size of the volume key in bits or 0 to use the default

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

min_entropy

minimum random data entropy (in bits) required to format device -as LUKS

 

luks_version

whether to use LUKS v1 or LUKS v2

 

extra

extra arguments for LUKS format creation.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -was successfully formatted as LUKS or not -(the error -) contains the error in such cases)

-

Tech category: BD_CRYPTO_TECH_LUKS2-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_luks_open ()

-
gboolean
-bd_crypto_luks_open (const gchar *device,
-                     const gchar *name,
-                     const gchar *passphrase,
-                     const gchar *key_file,
-                     gboolean read_only,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the LUKS device

 

passphrase

passphrase to open the device -or NULL.

[nullable]

key_file

key file path to use for opening the device -or NULL.

[nullable]

read_only

whether to open as read-only or not (meaning read-write)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

One of passphrase -, key_file -has to be != NULL.

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_luks_open_blob ()

-
gboolean
-bd_crypto_luks_open_blob (const gchar *device,
-                          const gchar *name,
-                          const guint8 *pass_data,
-                          gsize data_len,
-                          gboolean read_only,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the LUKS device

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

read_only

whether to open as read-only or not (meaning read-write)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_luks_close ()

-
gboolean
-bd_crypto_luks_close (const gchar *luks_device,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

luks_device

LUKS device to close

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given luks_device -was successfully closed or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_luks_add_key ()

-
gboolean
-bd_crypto_luks_add_key (const gchar *device,
-                        const gchar *pass,
-                        const gchar *key_file,
-                        const gchar *npass,
-                        const gchar *nkey_file,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

device to add new key to

 

pass

passphrase for the device -or NULL.

[nullable]

key_file

key file for the device -or NULL.

[nullable]

npass

passphrase to add to device -or NULL.

[nullable]

nkey_file

key file to add to device -or NULL.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the npass -or nkey_file -was successfully added to device -or not

-

One of pass -, key_file -has to be != NULL and the same applies to npass -, -nkey_file -.

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_ADD_KEY

-
-
-
-
-

bd_crypto_luks_add_key_blob ()

-
gboolean
-bd_crypto_luks_add_key_blob (const gchar *device,
-                             const guint8 *pass_data,
-                             gsize data_len,
-                             const guint8 *npass_data,
-                             gsize ndata_len,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

device to add new key to

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

npass_data

a new passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=ndata_len]

ndata_len

length of the npass_data -buffer

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the npass_data -was successfully added to device -or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_ADD_KEY

-
-
-
-
-

bd_crypto_luks_remove_key ()

-
gboolean
-bd_crypto_luks_remove_key (const gchar *device,
-                           const gchar *pass,
-                           const gchar *key_file,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device to add new key to

 

pass

passphrase for the device -or NULL.

[nullable]

key_file

key file for the device -or NULL.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the key was successfully removed or not

-

Either pass -or key_file -has to be != NULL.

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_REMOVE_KEY

-
-
-
-
-

bd_crypto_luks_remove_key_blob ()

-
gboolean
-bd_crypto_luks_remove_key_blob (const gchar *device,
-                                const guint8 *pass_data,
-                                gsize data_len,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device to add new key to

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data) to remove.

[array length=data_len]

data_len

length of the pass_data -buffer

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the key was successfully removed or not

-

Either pass -or key_file -has to be != NULL.

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_REMOVE_KEY

-
-
-
-
-

bd_crypto_luks_change_key ()

-
gboolean
-bd_crypto_luks_change_key (const gchar *device,
-                           const gchar *pass,
-                           const gchar *npass,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device to change key of

 

pass

old passphrase

 

npass

new passphrase

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the key was successfully changed or not

-

No support for changing key files (yet).

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_ADD_KEY&BD_CRYPTO_TECH_MODE_REMOVE_KEY

-
-
-
-
-

bd_crypto_luks_change_key_blob ()

-
gboolean
-bd_crypto_luks_change_key_blob (const gchar *device,
-                                const guint8 *pass_data,
-                                gsize data_len,
-                                const guint8 *npass_data,
-                                gsize ndata_len,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

device to change key of

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

npass_data

a new passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=ndata_len]

ndata_len

length of the npass_data -buffer

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the key was successfully changed or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_ADD_KEY&BD_CRYPTO_TECH_MODE_REMOVE_KEY

-
-
-
-
-

bd_crypto_luks_resize ()

-
gboolean
-bd_crypto_luks_resize (const gchar *luks_device,
-                       guint64 size,
-                       GError **error);
-

You need to specify passphrase when resizing LUKS 2 devices that don't have -verified key loaded in kernel. If you don't specify a passphrase, resize -will fail with BD_CRYPTO_ERROR_RESIZE_PERM. Use bd_crypto_luks_resize_luks2 -or bd_crypto_luks_resize_luks2_blob for these devices.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

luks_device

opened LUKS device to resize

 

size

requested size in sectors or 0 to adapt to the backing device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the luks_device -was successfully resized or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_RESIZE

-
-
-
-
-

bd_crypto_luks_resize_luks2 ()

-
gboolean
-bd_crypto_luks_resize_luks2 (const gchar *luks_device,
-                             guint64 size,
-                             const gchar *passphrase,
-                             const gchar *key_file,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

luks_device

opened LUKS device to resize

 

passphrase

passphrase to resize the luks_device -or NULL.

[nullable]

key_file

key file path to use for resizing the luks_device -or NULL.

[nullable]

size

requested size in sectors or 0 to adapt to the backing device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the luks_device -was successfully resized or not

-

You need to specify either passphrase -or keyfile -for LUKS 2 devices that -don't have verified key loaded in kernel. -For LUKS 1 devices you can set both passphrase -and keyfile -to NULL to -achieve the same as calling bd_crypto_luks_resize.

-

Tech category: BD_CRYPTO_TECH_LUKS2-BD_CRYPTO_TECH_MODE_RESIZE

-
-
-
-
-

bd_crypto_luks_resize_luks2_blob ()

-
gboolean
-bd_crypto_luks_resize_luks2_blob (const gchar *luks_device,
-                                  guint64 size,
-                                  const guint8 *pass_data,
-                                  gsize data_len,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

luks_device

opened LUKS device to resize

 

pass_data

a passphrase for the new LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

size

requested size in sectors or 0 to adapt to the backing device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the luks_device -was successfully resized or not

-

You need to specify pass_data -for LUKS 2 devices that don't have -verified key loaded in kernel.

-

Tech category: BD_CRYPTO_TECH_LUKS2-BD_CRYPTO_TECH_MODE_RESIZE

-
-
-
-
-

bd_crypto_luks_suspend ()

-
gboolean
-bd_crypto_luks_suspend (const gchar *luks_device,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

luks_device

LUKS device to suspend

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given luks_device -was successfully suspended or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_SUSPEND_RESUME

-
-
-
-
-

bd_crypto_luks_resume_blob ()

-
gboolean
-bd_crypto_luks_resume_blob (const gchar *luks_device,
-                            const guint8 *pass_data,
-                            gsize data_len,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

luks_device

LUKS device to resume

 

pass_data

a passphrase for the LUKS device (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given luks_device -was successfully resumed or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_SUSPEND_RESUME

-
-
-
-
-

bd_crypto_luks_resume ()

-
gboolean
-bd_crypto_luks_resume (const gchar *luks_device,
-                       const gchar *passphrase,
-                       const gchar *key_file,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

luks_device

LUKS device to resume

 

passphrase

passphrase to resume the device -or NULL.

[nullable]

key_file

key file path to use for resuming the device -or NULL.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given luks_device -was successfully resumed or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_SUSPEND_RESUME

-
-
-
-
-

bd_crypto_luks_kill_slot ()

-
gboolean
-bd_crypto_luks_kill_slot (const gchar *device,
-                          gint slot,
-                          GError **error);
-

Note: This can destroy last remaining keyslot without confirmation making - the LUKS device permanently inaccessible.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

device to kill slot on

 

slot

keyslot to destroy

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given slot -was successfully destroyed or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_REMOVE_KEY

-
-
-
-
-

bd_crypto_luks_header_backup ()

-
gboolean
-bd_crypto_luks_header_backup (const gchar *device,
-                              const gchar *backup_file,
-                              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

device to backup the LUKS header

 

backup_file

file to save the header backup to

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given backup of device -was successfully written to -backup_file -or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_BACKUP_RESTORE

-
-
-
-
-

bd_crypto_luks_header_restore ()

-
gboolean
-bd_crypto_luks_header_restore (const gchar *device,
-                               const gchar *backup_file,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

device to restore the LUKS header to

 

backup_file

existing file with a LUKS header backup

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -LUKS header was successfully restored -from backup_file -

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_BACKUP_RESTORE

-
-
-
-
-

bd_crypto_luks_set_label ()

-
gboolean
-bd_crypto_luks_set_label (const gchar *device,
-                          const gchar *label,
-                          const gchar *subsystem,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device to set label on

 

label

label to set.

[nullable]

subsystem

subsystem to set.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given label -and subsystem -were successfully set or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_MODIFY

-
-
-
-
-

bd_crypto_luks_set_uuid ()

-
gboolean
-bd_crypto_luks_set_uuid (const gchar *device,
-                         const gchar *uuid,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

device to set UUID on

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given uuid -was successfully set or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_MODIFY

-
-
-
-
-

bd_crypto_luks_info_free ()

-
void
-bd_crypto_luks_info_free (BDCryptoLUKSInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoLUKSInfo to free.

[nullable]
-
-
-
-
-

bd_crypto_luks_info_copy ()

-
BDCryptoLUKSInfo *
-bd_crypto_luks_info_copy (BDCryptoLUKSInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoLUKSInfo to copy.

[nullable]
-
-
-
-
-

bd_crypto_luks_info ()

-
BDCryptoLUKSInfo *
-bd_crypto_luks_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a device to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the device -or NULL in case of error

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_integrity_info_free ()

-
void
-bd_crypto_integrity_info_free (BDCryptoIntegrityInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoIntegrityInfo to free.

[nullable]
-
-
-
-
-

bd_crypto_integrity_info_copy ()

-
BDCryptoIntegrityInfo *
-bd_crypto_integrity_info_copy (BDCryptoIntegrityInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoIntegrityInfo to copy.

[nullable]
-
-
-
-
-

bd_crypto_integrity_info ()

-
BDCryptoIntegrityInfo *
-bd_crypto_integrity_info (const gchar *device,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a device to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the device -or NULL in case of error

-

Tech category: BD_CRYPTO_TECH_INTEGRITY-BD_CRYPTO_TECH_MODE_QUERY

-
-
-
-
-

bd_crypto_integrity_extra_copy ()

-
BDCryptoIntegrityExtra *
-bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra);
-

Creates a new copy of extra -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

extra

BDCryptoIntegrityExtra to copy.

[nullable]
-
-
-
-
-

bd_crypto_integrity_extra_free ()

-
void
-bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra);
-

Frees extra -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

extra

BDCryptoIntegrityExtra to free.

[nullable]
-
-
-
-
-

bd_crypto_integrity_extra_new ()

-
BDCryptoIntegrityExtra *
-bd_crypto_integrity_extra_new (guint64 sector_size,
-                               guint64 journal_size,
-                               guint journal_watermark,
-                               guint journal_commit_time,
-                               guint64 interleave_sectors,
-                               guint64 tag_size,
-                               guint64 buffer_sectors);
-

[constructor]

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

sector_size

integrity sector size, 0 for default (512)

 

journal_size

size of journal in bytes

 

journal_watermark

journal flush watermark in percents; in bitmap mode sectors-per-bit

 

journal_commit_time

journal commit time (or bitmap flush time) in ms

 

interleave_sectors

number of interleave sectors (power of two)

 

tag_size

tag size per-sector in bytes

 

buffer_sectors

number of sectors in one buffer

 
-
-
-

Returns

-

a new Integrity extra argument.

-

[transfer full]

-
-
-
-
-

bd_crypto_integrity_format ()

-
gboolean
-bd_crypto_integrity_format (const gchar *device,
-                            const gchar *algorithm,
-                            gboolean wipe,
-                            const guint8 *key_data,
-                            gsize key_size,
-                            BDCryptoIntegrityExtra *extra,
-                            GError **error);
-

Formats the given device - as integrity according to the other parameters given.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

a device to format as integrity

 

algorithm

integrity algorithm specification (e.g. "crc32c" or "sha256") or NULL to use the default

 

wipe

whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums

 

key_data

integrity key or NULL if not needed.

[nullable][array length=key_size]

key_size

size the integrity key and key_data -

 

extra

extra arguments for integrity format creation.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given device -was successfully formatted as integrity or not -(the error -) contains the error in such cases)

-

Tech category: BD_CRYPTO_TECH_INTEGRITY-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_integrity_open ()

-
gboolean
-bd_crypto_integrity_open (const gchar *device,
-                          const gchar *name,
-                          const gchar *algorithm,
-                          const guint8 *key_data,
-                          gsize key_size,
-                          BDCryptoIntegrityOpenFlags flags,
-                          BDCryptoIntegrityExtra *extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

integrity device to open

 

name

name for the opened device -

 

algorithm

integrity algorithm specification (e.g. "crc32c" or "sha256") or NULL to use the default.

[nullable]

key_data

integrity key or NULL if not needed.

[nullable][array length=key_size]

key_size

size the integrity key and key_data -

 

flags

flags for the integrity device activation

 

extra

extra arguments for integrity open.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_INTEGRITY-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_integrity_close ()

-
gboolean
-bd_crypto_integrity_close (const gchar *integrity_device,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

integrity_device

integrity device to close

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given integrity_device -was successfully closed or not

-

Tech category: BD_CRYPTO_TECH_INTEGRITY-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_luks_token_info_free ()

-
void
-bd_crypto_luks_token_info_free (BDCryptoLUKSTokenInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoLUKSTokenInfo to free.

[nullable]
-
-
-
-
-

bd_crypto_luks_token_info_copy ()

-
BDCryptoLUKSTokenInfo *
-bd_crypto_luks_token_info_copy (BDCryptoLUKSTokenInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDCryptoLUKSTokenInfo to copy.

[nullable]
-
-
-
-
-

bd_crypto_luks_token_info ()

-
BDCryptoLUKSTokenInfo **
-bd_crypto_luks_token_info (const gchar *device,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a device to get LUKS2 token information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about tokens on device -

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_crypto_keyring_add_key ()

-
gboolean
-bd_crypto_keyring_add_key (const gchar *key_desc,
-                           const guint8 *key_data,
-                           gsize data_len,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

key_desc

kernel keyring key description

 

key_data

a key to add to kernel keyring (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the key_data -buffer

 

error

place to store error (if any) -*.

[out][optional]
-
-
-

Returns

-

whether the given key was successfully saved to kernel keyring or not

-

Tech category: BD_CRYPTO_TECH_KEYRING-BD_CRYPTO_TECH_MODE_ADD_KEY

-
-
-
-
-

bd_crypto_luks_open_keyring ()

-
gboolean
-bd_crypto_luks_open_keyring (const gchar *device,
-                             const gchar *name,
-                             const gchar *key_desc,
-                             gboolean read_only,
-                             GError **error);
-

Note: Keyslot passphrase must be stored in 'user' key type and the key has to be reachable - by process context on behalf of which this function is called.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the LUKS device

 

key_desc

kernel keyring key description

 

read_only

whether to open as read-only or not (meaning read-write)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_LUKS-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_tc_open ()

-
gboolean
-bd_crypto_tc_open (const gchar *device,
-                   const gchar *name,
-                   const guint8 *pass_data,
-                   gsize data_len,
-                   gboolean read_only,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the TrueCrypt/VeraCrypt device

 

pass_data

a passphrase for the TrueCrypt/VeraCrypt volume (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

read_only

whether to open as read-only or not (meaning read-write)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_TRUECRYPT-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_tc_open_full ()

-
gboolean
-bd_crypto_tc_open_full (const gchar *device,
-                        const gchar *name,
-                        const guint8 *pass_data,
-                        gsize data_len,
-                        const gchar **keyfiles,
-                        gboolean hidden,
-                        gboolean system,
-                        gboolean veracrypt,
-                        guint32 veracrypt_pim,
-                        gboolean read_only,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the TrueCrypt/VeraCrypt device

 

pass_data

a passphrase for the TrueCrypt/VeraCrypt volume (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

read_only

whether to open as read-only or not (meaning read-write)

 

keyfiles

paths to the keyfiles for the TrueCrypt/VeraCrypt volume.

[nullable][array zero-terminated=1]

hidden

whether a hidden volume inside the volume should be opened

 

system

whether to try opening as an encrypted system (with boot loader)

 

veracrypt

whether to try VeraCrypt modes (TrueCrypt modes are tried anyway)

 

veracrypt_pim

VeraCrypt PIM value

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_TRUECRYPT-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_tc_close ()

-
gboolean
-bd_crypto_tc_close (const gchar *tc_device,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

tc_device

TrueCrypt/VeraCrypt device to close

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given tc_device -was successfully closed or not

-

Tech category: BD_CRYPTO_TECH_TRUECRYPT-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_escrow_device ()

-
gboolean
-bd_crypto_escrow_device (const gchar *device,
-                         const gchar *passphrase,
-                         const gchar *cert_data,
-                         const gchar *directory,
-                         const gchar *backup_passphrase,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

path of the device to create escrow data for

 

passphrase

passphrase used for the device

 

cert_data

certificate data to use for escrow.

[array zero-terminated=1][element-type gchar]

directory

directory to put escrow data into

 

backup_passphrase

backup passphrase for the device or NULL.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the escrow data was successfully created for device -or not

-

Tech category: BD_CRYPTO_TECH_ESCROW-BD_CRYPTO_TECH_MODE_CREATE

-
-
-
-
-

bd_crypto_bitlk_open ()

-
gboolean
-bd_crypto_bitlk_open (const gchar *device,
-                      const gchar *name,
-                      const guint8 *pass_data,
-                      gsize data_len,
-                      gboolean read_only,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to open

 

name

name for the BITLK device

 

pass_data

a passphrase for the BITLK volume (may contain arbitrary binary data).

[array length=data_len]

data_len

length of the pass_data -buffer

 

read_only

whether to open as read-only or not (meaning read-write)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully opened or not

-

Tech category: BD_CRYPTO_TECH_BITLK-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_bitlk_close ()

-
gboolean
-bd_crypto_bitlk_close (const gchar *bitlk_device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bitlk_device

BITLK device to close

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given bitlk_device -was successfully closed or not

-

Tech category: BD_CRYPTO_TECH_BITLK-BD_CRYPTO_TECH_MODE_OPEN_CLOSE

-
-
-
-
-

bd_crypto_is_tech_avail ()

-
gboolean
-bd_crypto_is_tech_avail (BDCryptoTech tech,
-                         guint64 mode,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDCryptoTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_CRYPTO_LUKS_METADATA_SIZE

-
#define             BD_CRYPTO_LUKS_METADATA_SIZE
-
-
-
-

BD_CRYPTO_ERROR

-
#define             BD_CRYPTO_ERROR
-
-
-
-

enum BDCryptoError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_CRYPTO_ERROR_DEVICE

  

BD_CRYPTO_ERROR_STATE

  

BD_CRYPTO_ERROR_INVALID_SPEC

  

BD_CRYPTO_ERROR_FORMAT_FAILED

  

BD_CRYPTO_ERROR_RESIZE_FAILED

  

BD_CRYPTO_ERROR_RESIZE_PERM

  

BD_CRYPTO_ERROR_ADD_KEY

  

BD_CRYPTO_ERROR_REMOVE_KEY

  

BD_CRYPTO_ERROR_NO_KEY

  

BD_CRYPTO_ERROR_KEY_SLOT

  

BD_CRYPTO_ERROR_NSS_INIT_FAILED

  

BD_CRYPTO_ERROR_CERT_DECODE

  

BD_CRYPTO_ERROR_ESCROW_FAILED

  

BD_CRYPTO_ERROR_INVALID_PARAMS

  

BD_CRYPTO_ERROR_TECH_UNAVAIL

  

BD_CRYPTO_ERROR_KEYRING

  
-
-
-
-
-

BD_CRYPTO_BACKUP_PASSPHRASE_CHARSET

-
#define BD_CRYPTO_BACKUP_PASSPHRASE_CHARSET "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz./"
-
-
-
-
-

BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH

-
#define BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH 20
-
-
-
-
-

BD_CRYPTO_CHI_SQUARE_BYTES_TO_CHECK

-
#define BD_CRYPTO_CHI_SQUARE_BYTES_TO_CHECK 512
-
-
-
-
-

BD_CRYPTO_CHI_SQUARE_LOWER_LIMIT

-
#define BD_CRYPTO_CHI_SQUARE_LOWER_LIMIT 136
-
-
-
-
-

BD_CRYPTO_CHI_SQUARE_UPPER_LIMIT

-
#define BD_CRYPTO_CHI_SQUARE_UPPER_LIMIT 426
-
-
-
-
-

BDCryptoLUKSExtra

-
typedef struct {
-    guint64 data_alignment;
-    gchar *data_device;
-    gchar *integrity;
-    guint64 sector_size;
-    gchar *label;
-    gchar *subsystem;
-    BDCryptoLUKSPBKDF *pbkdf;
-} BDCryptoLUKSExtra;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint64 data_alignment;

data alignment in sectors, 0 for default/auto detection

 

gchar *data_device;

detached encrypted data device or NULL

 

gchar *integrity;

integrity algorithm (e.g. "hmac-sha256") or NULL for no integrity support -Note: this field is valid only for LUKS 2

 

guint64 sector_size;

encryption sector size, 0 for default (512) -Note: this field is valid only for LUKS 2

 

gchar *label;

LUKS header label or NULL -Note: this field is valid only for LUKS 2

 

gchar *subsystem;

LUKS header subsystem or NULL -Note: this field is valid only for LUKS 2

 

BDCryptoLUKSPBKDF *pbkdf;

key derivation function specification or NULL for default -Note: this field is valid only for LUKS 2

 
-
-
-
-
-

BDCryptoLUKSPBKDF

-
typedef struct {
-    gchar *type;
-    gchar *hash;
-    guint32 max_memory_kb;
-    guint32 iterations;
-    guint32 time_ms;
-    guint32 parallel_threads;
-} BDCryptoLUKSPBKDF;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *type;

PBKDF algorithm

 

gchar *hash;

hash for LUKS header or NULL

 

guint32 max_memory_kb;

requested memory cost (in KiB) or 0 for default (benchmark)

 

guint32 iterations;

requested iterations or 0 for default (benchmark)

 

guint32 time_ms;

requested time cost or 0 for default (benchmark)

 

guint32 parallel_threads;

requested parallel cost (threads) or 0 for default (benchmark)

 
-
-
-
-
-

enum BDCryptoLUKSVersion

-
-

Members

-
----- - - - - - - - - - - - - -

BD_CRYPTO_LUKS_VERSION_LUKS1

  

BD_CRYPTO_LUKS_VERSION_LUKS2

  
-
-
-
-
-

BDCryptoLUKSInfo

-
typedef struct {
-    BDCryptoLUKSVersion version;
-    gchar *cipher;
-    gchar *mode;
-    gchar *uuid;
-    gchar *backing_device;
-    gint64 sector_size;
-    gchar *label;
-    gchar *subsystem;
-} BDCryptoLUKSInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BDCryptoLUKSVersion version;

LUKS version

 

gchar *cipher;

used cipher (e.g. "aes")

 

gchar *mode;

used cipher mode (e.g. "xts-plain")

 

gchar *uuid;

UUID of the LUKS device

 

gchar *backing_device;

name of the underlying block device

 

gint64 sector_size;

size (in bytes) of encryption sector (valid only for LUKS 2)

 

gchar *label;

label of the LUKS device (valid only for LUKS 2)

 

gchar *subsystem;

subsystem of the LUKS device (valid only for LUKS 2)

 
-
-
-
-
-

BDCryptoIntegrityInfo

-
typedef struct {
-    gchar *algorithm;
-    guint32 key_size;
-    guint32 sector_size;
-    guint32 tag_size;
-    guint32 interleave_sectors;
-    guint64 journal_size;
-    gchar *journal_crypt;
-    gchar *journal_integrity;
-} BDCryptoIntegrityInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *algorithm;

integrity algorithm

 

guint32 key_size;

integrity key size in bytes

 

guint32 sector_size;

sector size in bytes

 

guint32 tag_size;

tag size per-sector in bytes

 

guint32 interleave_sectors;

number of interleave sectors

 

guint64 journal_size;

size of journal in bytes

 

gchar *journal_crypt;

journal encryption algorithm

 

gchar *journal_integrity;

journal integrity algorithm

 
-
-
-
-
-

BDCryptoIntegrityExtra

-
typedef struct {
-    guint32 sector_size;
-    guint64 journal_size;
-    guint journal_watermark;
-    guint journal_commit_time;
-    guint32 interleave_sectors;
-    guint32 tag_size;
-    guint32 buffer_sectors;
-} BDCryptoIntegrityExtra;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint32 sector_size;

integrity sector size

 

guint64 journal_size;

size of journal in bytes

 

guint journal_watermark;

journal flush watermark in percents; in bitmap mode sectors-per-bit

 

guint journal_commit_time;

journal commit time (or bitmap flush time) in ms

 

guint32 interleave_sectors;

number of interleave sectors (power of two)

 

guint32 tag_size;

tag size per-sector in bytes

 

guint32 buffer_sectors;

number of sectors in one buffer

 
-
-
-
-
-

enum BDCryptoIntegrityOpenFlags

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL

  

BD_CRYPTO_INTEGRITY_OPEN_RECOVERY

  

BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP

  

BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE

  

BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET

  

BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS

  
-
-
-
-
-

BDCryptoLUKSTokenInfo

-
typedef struct {
-    guint id;
-    gchar *type;
-    gint keyslot;
-} BDCryptoLUKSTokenInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

guint id;

ID of the token

 

gchar *type;

type of the token

 

gint keyslot;

keyslot this token is assigned to or -1 for inactive/unassigned tokens

 
-
-
-
-
-

enum BDCryptoTech

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_CRYPTO_TECH_LUKS

  

BD_CRYPTO_TECH_LUKS2

  

BD_CRYPTO_TECH_TRUECRYPT

  

BD_CRYPTO_TECH_ESCROW

  

BD_CRYPTO_TECH_INTEGRITY

  

BD_CRYPTO_TECH_BITLK

  

BD_CRYPTO_TECH_KEYRING

  
-
-
-
-
-

enum BDCryptoTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_CRYPTO_TECH_MODE_CREATE

  

BD_CRYPTO_TECH_MODE_OPEN_CLOSE

  

BD_CRYPTO_TECH_MODE_QUERY

  

BD_CRYPTO_TECH_MODE_ADD_KEY

  

BD_CRYPTO_TECH_MODE_REMOVE_KEY

  

BD_CRYPTO_TECH_MODE_RESIZE

  

BD_CRYPTO_TECH_MODE_SUSPEND_RESUME

  

BD_CRYPTO_TECH_MODE_BACKUP_RESTORE

  

BD_CRYPTO_TECH_MODE_MODIFY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-DeviceMapper.html b/libblockdev/docs/3.0/libblockdev-DeviceMapper.html deleted file mode 100644 index f389f52..0000000 --- a/libblockdev/docs/3.0/libblockdev-DeviceMapper.html +++ /dev/null @@ -1,813 +0,0 @@ - - - - -DeviceMapper: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

DeviceMapper

-

DeviceMapper — plugin for basic operations with device mapper

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_dm_check_deps () -
-void - -bd_dm_close () -
-gboolean - -bd_dm_init () -
-GQuark - -bd_dm_error_quark () -
-gboolean - -bd_dm_create_linear () -
-gboolean - -bd_dm_remove () -
-gchar * - -bd_dm_name_from_node () -
-gchar * - -bd_dm_node_from_name () -
-gboolean - -bd_dm_map_exists () -
-gchar * - -bd_dm_get_subsystem_from_name () -
-gchar ** - -bd_dm_get_member_raid_sets () -
-gboolean - -bd_dm_activate_raid_set () -
-gboolean - -bd_dm_deactivate_raid_set () -
-gchar * - -bd_dm_get_raid_set_type () -
-gboolean - -bd_dm_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - -
#defineBD_DM_ERROR
enumBDDMError
enumBDDMTech
enumBDDMTechMode
-
-
-

Includes

-
#include <dm.h>
-
-
-
-

Description

-

A plugin for basic operations with device mapper.

-
-
-

Functions

-
-

bd_dm_check_deps ()

-
gboolean
-bd_dm_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_dm_close ()

-
void
-bd_dm_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_dm_init ()

-
gboolean
-bd_dm_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_dm_error_quark ()

-
GQuark
-bd_dm_error_quark (void);
-

[skip]

-
-
-
-

bd_dm_create_linear ()

-
gboolean
-bd_dm_create_linear (const gchar *map_name,
-                     const gchar *device,
-                     guint64 length,
-                     const gchar *uuid,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

map_name

name of the map

 

device

device to create map for

 

length

length of the mapping in sectors

 

uuid

UUID for the new dev mapper device or NULL if not specified.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new linear mapping map_name -was successfully created -for the device -or not

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_CREATE_ACTIVATE

-
-
-
-
-

bd_dm_remove ()

-
gboolean
-bd_dm_remove (const gchar *map_name,
-              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

map_name

name of the map to remove

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the map_name -map was successfully removed or not

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_REMOVE_DEACTIVATE

-
-
-
-
-

bd_dm_name_from_node ()

-
gchar *
-bd_dm_name_from_node (const gchar *dm_node,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dm_node

name of the DM node (e.g. "dm-0")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

map name of the map providing the dm_node -device or NULL -(error -) contains the error in such cases)

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_QUERY

-
-
-
-
-

bd_dm_node_from_name ()

-
gchar *
-bd_dm_node_from_name (const gchar *map_name,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

map_name

name of the queried DM map

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

DM node name for the map_name -map or NULL (error -) contains -the error in such cases)

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_QUERY

-
-
-
-
-

bd_dm_map_exists ()

-
gboolean
-bd_dm_map_exists (const gchar *map_name,
-                  gboolean live_only,
-                  gboolean active_only,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

map_name

name of the queried map

 

live_only

whether to go through the live maps only or not

 

active_only

whether to ignore suspended maps or not

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given map_name -exists (and is live if live_only -is -TRUE (and is active if active_only -is TRUE)).

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_QUERY

-
-
-
-
-

bd_dm_get_subsystem_from_name ()

-
gchar *
-bd_dm_get_subsystem_from_name (const gchar *device_name,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device_name

name of the device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

subsystem of the given device

-

Tech category: BD_DM_TECH_MAP-BD_DM_TECH_MODE_QUERY

-
-
-
-
-

bd_dm_get_member_raid_sets ()

-
gchar **
-bd_dm_get_member_raid_sets (const gchar *name,
-                            const gchar *uuid,
-                            gint major,
-                            gint minor,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

name of the member.

[nullable]

uuid

uuid of the member.

[nullable]

major

major number of the device or -1 if not specified

 

minor

minor number of the device or -1 if not specified

 

error

variable to store error (if any).

[out][optional]
-
-
-

Returns

-

list of names of the RAID sets related to -the member or NULL in case of error

-

One of name -, uuid -or major -:minor -has to be given.

-

Tech category: BD_DM_TECH_RAID-BD_DM_TECH_MODE_QUERY.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_dm_activate_raid_set ()

-
gboolean
-bd_dm_activate_raid_set (const gchar *name,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

name

name of the DM RAID set to activate

 

error

variable to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the RAID set name -was successfully activate or not

-

Tech category: BD_DM_TECH_RAID-BD_DM_TECH_MODE_CREATE_ACTIVATE

-
-
-
-
-

bd_dm_deactivate_raid_set ()

-
gboolean
-bd_dm_deactivate_raid_set (const gchar *name,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

name

name of the DM RAID set to deactivate

 

error

variable to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the RAID set name -was successfully deactivate or not

-

Tech category: BD_DM_TECH_RAID-BD_DM_TECH_MODE_REMOVE_DEACTIVATE

-
-
-
-
-

bd_dm_get_raid_set_type ()

-
gchar *
-bd_dm_get_raid_set_type (const gchar *name,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

name

name of the DM RAID set to get the type of

 

error

variable to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of the name -RAID set's type

-

Tech category: BD_DM_TECH_RAID-BD_DM_TECH_MODE_QUERY

-
-
-
-
-

bd_dm_is_tech_avail ()

-
gboolean
-bd_dm_is_tech_avail (BDDMTech tech,
-                     guint64 mode,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDDMTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_DM_ERROR

-
#define             BD_DM_ERROR
-
-
-
-

enum BDDMError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_DM_ERROR_SYS

  

BD_DM_ERROR_NOT_ROOT

  

BD_DM_ERROR_TASK

  

BD_DM_ERROR_RAID_FAIL

  

BD_DM_ERROR_RAID_NO_DEVS

  

BD_DM_ERROR_RAID_NO_EXIST

  

BD_DM_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

enum BDDMTech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_DM_TECH_MAP

  

BD_DM_TECH_RAID

  
-
-
-
-
-

enum BDDMTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_DM_TECH_MODE_CREATE_ACTIVATE

  

BD_DM_TECH_MODE_REMOVE_DEACTIVATE

  

BD_DM_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-FS.html b/libblockdev/docs/3.0/libblockdev-FS.html deleted file mode 100644 index 21e261a..0000000 --- a/libblockdev/docs/3.0/libblockdev-FS.html +++ /dev/null @@ -1,7884 +0,0 @@ - - - - -FS: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

FS

-

FS — plugin for operations with file systems

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_fs_check_deps () -
-gboolean - -bd_fs_init () -
-void - -bd_fs_close () -
-GQuark - -bd_fs_error_quark () -
-gboolean - -bd_fs_wipe () -
-gboolean - -bd_fs_clean () -
-gchar * - -bd_fs_get_fstype () -
-gboolean - -bd_fs_freeze () -
-gboolean - -bd_fs_unfreeze () -
-gboolean - -bd_fs_mount () -
-gboolean - -bd_fs_unmount () -
-gchar * - -bd_fs_get_mountpoint () -
-gboolean - -bd_fs_is_mountpoint () -
-gboolean - -bd_fs_resize () -
-gboolean - -bd_fs_repair () -
-gboolean - -bd_fs_check () -
-gboolean - -bd_fs_set_label () -
-gboolean - -bd_fs_check_label () -
-guint64 - -bd_fs_get_size () -
-guint64 - -bd_fs_get_free_space () -
-gboolean - -bd_fs_can_resize () -
-gboolean - -bd_fs_can_check () -
-gboolean - -bd_fs_can_repair () -
-gboolean - -bd_fs_can_set_label () -
-gboolean - -bd_fs_can_get_size () -
-gboolean - -bd_fs_can_get_free_space () -
-gboolean - -bd_fs_can_set_uuid () -
-gboolean - -bd_fs_set_uuid () -
-gboolean - -bd_fs_check_uuid () -
const BDFSFeatures * - -bd_fs_features () -
-BDFSFeatures * - -bd_fs_features_copy () -
-void - -bd_fs_features_free () -
-gboolean - -bd_fs_can_mkfs () -
-gboolean - -bd_fs_mkfs () -
-BDFSMkfsOptions * - -bd_fs_mkfs_options_copy () -
-void - -bd_fs_mkfs_options_free () -
const gchar ** - -bd_fs_supported_filesystems () -
-gboolean - -bd_fs_ext2_check () -
-BDFSExt2Info * - -bd_fs_ext2_get_info () -
-BDFSExt2Info * - -bd_fs_ext2_info_copy () -
-void - -bd_fs_ext2_info_free () -
-gboolean - -bd_fs_ext2_mkfs () -
-gboolean - -bd_fs_ext2_repair () -
-gboolean - -bd_fs_ext2_resize () -
-gboolean - -bd_fs_ext2_set_label () -
-gboolean - -bd_fs_ext2_check_label () -
-gboolean - -bd_fs_ext2_set_uuid () -
-gboolean - -bd_fs_ext2_check_uuid () -
-gboolean - -bd_fs_ext3_check () -
-BDFSExt3Info * - -bd_fs_ext3_get_info () -
-BDFSExt3Info * - -bd_fs_ext3_info_copy () -
-void - -bd_fs_ext3_info_free () -
-gboolean - -bd_fs_ext3_mkfs () -
-gboolean - -bd_fs_ext3_repair () -
-gboolean - -bd_fs_ext3_resize () -
-gboolean - -bd_fs_ext3_set_label () -
-gboolean - -bd_fs_ext3_check_label () -
-gboolean - -bd_fs_ext3_set_uuid () -
-gboolean - -bd_fs_ext3_check_uuid () -
-gboolean - -bd_fs_ext4_check () -
-BDFSExt4Info * - -bd_fs_ext4_get_info () -
-BDFSExt4Info * - -bd_fs_ext4_info_copy () -
-void - -bd_fs_ext4_info_free () -
-gboolean - -bd_fs_ext4_mkfs () -
-gboolean - -bd_fs_ext4_repair () -
-gboolean - -bd_fs_ext4_resize () -
-gboolean - -bd_fs_ext4_set_label () -
-gboolean - -bd_fs_ext4_check_label () -
-gboolean - -bd_fs_ext4_set_uuid () -
-gboolean - -bd_fs_ext4_check_uuid () -
-gboolean - -bd_fs_xfs_check () -
-BDFSXfsInfo * - -bd_fs_xfs_get_info () -
-BDFSXfsInfo * - -bd_fs_xfs_info_copy () -
-void - -bd_fs_xfs_info_free () -
-gboolean - -bd_fs_xfs_mkfs () -
-gboolean - -bd_fs_xfs_repair () -
-gboolean - -bd_fs_xfs_resize () -
-gboolean - -bd_fs_xfs_set_label () -
-gboolean - -bd_fs_xfs_check_label () -
-gboolean - -bd_fs_xfs_set_uuid () -
-gboolean - -bd_fs_xfs_check_uuid () -
-gboolean - -bd_fs_vfat_check () -
-BDFSVfatInfo * - -bd_fs_vfat_get_info () -
-BDFSVfatInfo * - -bd_fs_vfat_info_copy () -
-void - -bd_fs_vfat_info_free () -
-gboolean - -bd_fs_vfat_mkfs () -
-gboolean - -bd_fs_vfat_repair () -
-gboolean - -bd_fs_vfat_resize () -
-gboolean - -bd_fs_vfat_set_label () -
-gboolean - -bd_fs_vfat_check_label () -
-gboolean - -bd_fs_is_tech_avail () -
-gboolean - -bd_fs_ntfs_check () -
-BDFSNtfsInfo * - -bd_fs_ntfs_get_info () -
-gboolean - -bd_fs_ntfs_mkfs () -
-gboolean - -bd_fs_ntfs_repair () -
-gboolean - -bd_fs_ntfs_resize () -
-gboolean - -bd_fs_ntfs_set_label () -
-gboolean - -bd_fs_ntfs_check_label () -
-BDFSNtfsInfo * - -bd_fs_ntfs_info_copy () -
-void - -bd_fs_ntfs_info_free () -
-gboolean - -bd_fs_ntfs_set_uuid () -
-gboolean - -bd_fs_ntfs_check_uuid () -
-BDFSF2FSInfo * - -bd_fs_f2fs_info_copy () -
-void - -bd_fs_f2fs_info_free () -
-gboolean - -bd_fs_f2fs_mkfs () -
-gboolean - -bd_fs_f2fs_check () -
-gboolean - -bd_fs_f2fs_repair () -
-BDFSF2FSInfo * - -bd_fs_f2fs_get_info () -
-gboolean - -bd_fs_f2fs_resize () -
-BDFSNILFS2Info * - -bd_fs_nilfs2_get_info () -
-BDFSNILFS2Info * - -bd_fs_nilfs2_info_copy () -
-void - -bd_fs_nilfs2_info_free () -
-gboolean - -bd_fs_nilfs2_mkfs () -
-gboolean - -bd_fs_nilfs2_resize () -
-gboolean - -bd_fs_nilfs2_set_label () -
-gboolean - -bd_fs_nilfs2_check_label () -
-gboolean - -bd_fs_nilfs2_set_uuid () -
-gboolean - -bd_fs_nilfs2_check_uuid () -
-gboolean - -bd_fs_exfat_check () -
-BDFSExfatInfo * - -bd_fs_exfat_get_info () -
-BDFSExfatInfo * - -bd_fs_exfat_info_copy () -
-void - -bd_fs_exfat_info_free () -
-gboolean - -bd_fs_exfat_mkfs () -
-gboolean - -bd_fs_exfat_repair () -
-gboolean - -bd_fs_exfat_set_label () -
-gboolean - -bd_fs_exfat_check_label () -
-BDFSBtrfsInfo * - -bd_fs_btrfs_get_info () -
-BDFSBtrfsInfo * - -bd_fs_btrfs_info_copy () -
-void - -bd_fs_btrfs_info_free () -
-gboolean - -bd_fs_btrfs_mkfs () -
-gboolean - -bd_fs_btrfs_check () -
-gboolean - -bd_fs_btrfs_repair () -
-gboolean - -bd_fs_btrfs_set_label () -
-gboolean - -bd_fs_btrfs_check_label () -
-gboolean - -bd_fs_btrfs_set_uuid () -
-gboolean - -bd_fs_btrfs_check_uuid () -
-gboolean - -bd_fs_btrfs_resize () -
-BDFSUdfInfo * - -bd_fs_udf_get_info () -
-BDFSUdfInfo * - -bd_fs_udf_info_copy () -
-void - -bd_fs_udf_info_free () -
-gboolean - -bd_fs_udf_mkfs () -
-gboolean - -bd_fs_udf_set_label () -
-gboolean - -bd_fs_udf_check_label () -
-gboolean - -bd_fs_udf_set_uuid () -
-gboolean - -bd_fs_udf_check_uuid () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
typedefBDFSExt2Info
typedefBDFSExt3Info
typedefBDFSExt4Info
enumBDFsError
#defineBD_FS_ERROR
enumBDFSConfigureFlags
enumBDFSFeatureFlags
 BDFSFeatures
enumBDFSFsckFlags
 BDFSMkfsOptions
enumBDFSMkfsOptionsFlags
 BDFSXfsInfo
 BDFSVfatInfo
enumBDFSTech
enumBDFSTechMode
enumBDFsResizeFlags
 BDFSNtfsInfo
 BDFSF2FSInfo
enumBDFSF2FSFeature
 BDFSNILFS2Info
 BDFSExfatInfo
 BDFSBtrfsInfo
 BDFSUdfInfo
-
-
-

Includes

-
#include <fs.h>
-
-
-
-

Description

-

A plugin for operations with file systems

-
-
-

Functions

-
-

bd_fs_check_deps ()

-
gboolean
-bd_fs_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_fs_init ()

-
gboolean
-bd_fs_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_fs_close ()

-
void
-bd_fs_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_fs_error_quark ()

-
GQuark
-bd_fs_error_quark (void);
-

[skip]

-
-
-
-

bd_fs_wipe ()

-
gboolean
-bd_fs_wipe (const gchar *device,
-            gboolean all,
-            gboolean force,
-            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device to wipe signatures from

 

all

whether to wipe all (TRUE) signatures or just the first (FALSE) one

 

force

whether to wipe signatures on a mounted device -

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether signatures were successfully wiped on device -or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_WIPE

-
-
-
-
-

bd_fs_clean ()

-
gboolean
-bd_fs_clean (const gchar *device,
-             gboolean force,
-             GError **error);
-

Clean all signatures from device -. -Difference between this and bd_fs_wipe() is that this function doesn't -return error if device - is already empty. This will also always remove -all signatures from device -, not only the first one.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to clean

 

force

whether to wipe signatures on a mounted device -

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether device -was successfully cleaned or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_WIPE

-
-
-
-
-

bd_fs_get_fstype ()

-
gchar *
-bd_fs_get_fstype (const gchar *device,
-                  GError **error);
-

Get first signature on device - as a string.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device to probe

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

type of filesystem found on device -, NULL in case -no signature has been detected or in case of error -(error -is set in this case)

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_freeze ()

-
gboolean
-bd_fs_freeze (const gchar *mountpoint,
-              GError **error);
-

Freezes filesystem mounted on mountpoint -. The filesystem must -support freezing.

-
-

Parameters

-
----- - - - - - - - - - - - - -

mountpoint

mountpoint of the device (filesystem) to freeze

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether mountpoint -was successfully freezed or not

-
-
-
-
-

bd_fs_unfreeze ()

-
gboolean
-bd_fs_unfreeze (const gchar *mountpoint,
-                GError **error);
-

Un-freezes filesystem mounted on mountpoint -. The filesystem must -support freezing.

-
-

Parameters

-
----- - - - - - - - - - - - - -

mountpoint

mountpoint of the device (filesystem) to un-freeze

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether mountpoint -was successfully unfreezed or not

-
-
-
-
-

bd_fs_mount ()

-
gboolean
-bd_fs_mount (const gchar *device,
-             const gchar *mountpoint,
-             const gchar *fstype,
-             const gchar *options,
-             const BDExtraArg **extra,
-             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

device to mount, if not specified mountpoint -entry -from fstab will be used.

[nullable]

mountpoint

mountpoint for device -, if not specified device -entry from fstab will be used.

[nullable]

fstype

filesystem type.

[nullable]

options

comma delimited options for mount.

[nullable]

extra

extra options for the unmount -currently only 'run_as_uid' -and 'run_as_gid' are supported -value must be a valid non zero -uid (gid).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether device -(or mountpoint -) was successfully mounted or not

-

Tech category: BD_FS_TECH_MOUNT (no mode, ignored)

-
-
-
-
-

bd_fs_unmount ()

-
gboolean
-bd_fs_unmount (const gchar *spec,
-               gboolean lazy,
-               gboolean force,
-               const BDExtraArg **extra,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

spec

mount point or device to unmount

 

lazy

enable/disable lazy unmount

 

force

enable/disable force unmount

 

extra

extra options for the unmount -currently only 'run_as_uid' -and 'run_as_gid' are supported -value must be a valid non zero -uid (gid).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether spec -was successfully unmounted or not

-

Tech category: BD_FS_TECH_MOUNT (no mode, ignored)

-
-
-
-
-

bd_fs_get_mountpoint ()

-
gchar *
-bd_fs_get_mountpoint (const gchar *device,
-                      GError **error);
-

Get mountpoint for device -. If device - is mounted multiple times only -one mountpoint will be returned.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

device to find mountpoint for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

mountpoint for device -, NULL in case device is -not mounted or in case of an error (error -is set -in this case)

-

Tech category: BD_FS_TECH_MOUNT (no mode, ignored).

-

[transfer full]

-
-
-
-
-

bd_fs_is_mountpoint ()

-
gboolean
-bd_fs_is_mountpoint (const gchar *path,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

path

path (folder) to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether path -is a mountpoint or not

-

Tech category: BD_FS_TECH_MOUNT (no mode, ignored)

-
-
-
-
-

bd_fs_resize ()

-
gboolean
-bd_fs_resize (const gchar *device,
-              guint64 new_size,
-              const gchar *fstype,
-              GError **error);
-

Resize filesystem on device -. This calls other fs resize functions from this -plugin based on provides or detected filesystem (e.g. bd_fs_xfs_resize for XFS). -This function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_repair ()

-
gboolean
-bd_fs_repair (const gchar *device,
-              const gchar *fstype,
-              GError **error);
-

Repair filesystem on device -. This calls other fs repair functions from this -plugin based on detected filesystem (e.g. bd_fs_xfs_repair for XFS). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system of which to repair

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully repaired or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_check ()

-
gboolean
-bd_fs_check (const gchar *device,
-             const gchar *fstype,
-             GError **error);
-

Check filesystem on device -. This calls other fs check functions from this -plugin based on detected filesystem (e.g. bd_fs_xfs_check for XFS). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system of which to check

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -passed the consistency check or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_set_label ()

-
gboolean
-bd_fs_set_label (const gchar *device,
-                 const gchar *label,
-                 const gchar *fstype,
-                 GError **error);
-

Set label for filesystem on device -. This calls other fs label functions from this -plugin based on detected filesystem (e.g. bd_fs_xfs_set_label for XFS). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device with file system to set the label for

 

label

label to set

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully relabeled or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_check_label ()

-
gboolean
-bd_fs_check_label (const gchar *fstype,
-                   const gchar *label,
-                   GError **error);
-

This calls other fs check label functions from this plugin based on the provided -filesystem (e.g. bd_fs_xfs_check_label for XFS). This function will return -an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

fstype

the filesystem type to check label -for

 

label

label to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the fstype -file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_get_size ()

-
guint64
-bd_fs_get_size (const gchar *device,
-                const gchar *fstype,
-                GError **error);
-

Get size for filesystem on device -. This calls other fs info functions from this -plugin based on detected filesystem (e.g. bd_fs_xfs_get_info for XFS). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device with file system to get size for

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

size of filesystem on device -, 0 in case of error.

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_get_free_space ()

-
guint64
-bd_fs_get_free_space (const gchar *device,
-                      const gchar *fstype,
-                      GError **error);
-

Get free space for filesystem on device -. This calls other fs info functions from this -plugin based on detected filesystem (e.g. bd_fs_ext4_get_info for ext4). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device with file system to get free space for

 

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

free space of filesystem on device -, 0 in case of error.

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_resize ()

-
gboolean
-bd_fs_can_resize (const gchar *type,
-                  BDFsResizeFlags *mode,
-                  gchar **required_utility,
-                  GError **error);
-

Searches for the required utility to resize the given filesystem and returns whether -it is installed. The mode flags indicate if growing and/or shrinking resize is available if -mounted/unmounted. -Unknown filesystems or filesystems which do not support resizing result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed resize support

 

mode

flags for allowed resizing (i.e. growing/shrinking support for online/offline).

[out]

required_utility

the utility binary which is required for resizing (if missing i.e. returns FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether filesystem resize is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_check ()

-
gboolean
-bd_fs_can_check (const gchar *type,
-                 gchar **required_utility,
-                 GError **error);
-

Searches for the required utility to check the given filesystem and returns whether -it is installed. -Unknown filesystems or filesystems which do not support checking result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed consistency check support

 

required_utility

the utility binary which is required for checking (if missing i.e. returns FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether filesystem check is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_repair ()

-
gboolean
-bd_fs_can_repair (const gchar *type,
-                  gchar **required_utility,
-                  GError **error);
-

Searches for the required utility to repair the given filesystem and returns whether -it is installed. -Unknown filesystems or filesystems which do not support reparing result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed repair support

 

required_utility

the utility binary which is required for repairing (if missing i.e. return FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether filesystem repair is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_set_label ()

-
gboolean
-bd_fs_can_set_label (const gchar *type,
-                     gchar **required_utility,
-                     GError **error);
-

Searches for the required utility to set the label of the given filesystem and returns whether -it is installed. -Unknown filesystems or filesystems which do not support setting the label result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed label support

 

required_utility

the utility binary which is required for relabeling (if missing i.e. return FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether setting filesystem label is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_get_size ()

-
gboolean
-bd_fs_can_get_size (const gchar *type,
-                    gchar **required_utility,
-                    GError **error);
-

Searches for the required utility to get size of the given filesystem and -returns whether it is installed. -Unknown filesystems or filesystems which do not support size querying result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed size querying support

 

required_utility

the utility binary which is required -for size querying (if missing i.e. return FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether getting filesystem size is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_get_free_space ()

-
gboolean
-bd_fs_can_get_free_space (const gchar *type,
-                          gchar **required_utility,
-                          GError **error);
-

Searches for the required utility to get free space of the given filesystem and -returns whether it is installed. -Unknown filesystems or filesystems which do not support free space querying result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed free space querying support

 

required_utility

the utility binary which is required -for free space querying (if missing i.e. return FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether getting filesystem free space is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_can_set_uuid ()

-
gboolean
-bd_fs_can_set_uuid (const gchar *type,
-                    gchar **required_utility,
-                    GError **error);
-

Searches for the required utility to set the UUID of the given filesystem and returns whether -it is installed. -Unknown filesystems or filesystems which do not support setting the UUID result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed UUID support

 

required_utility

the utility binary which is required for setting UUID (if missing i.e. return FALSE but no error).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether setting filesystem UUID is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_set_uuid ()

-
gboolean
-bd_fs_set_uuid (const gchar *device,
-                const gchar *uuid,
-                const gchar *fstype,
-                GError **error);
-

Set UUID for filesystem on device -. This calls other fs UUID functions from this -plugin based on detected filesystem (e.g. bd_fs_xfs_set_uuid for XFS). This -function will return an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device with file system to set the UUID for

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

fstype

the filesystem type on device -or NULL to detect.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID on the file system on device -was successfully changed or not

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_check_uuid ()

-
gboolean
-bd_fs_check_uuid (const gchar *fstype,
-                  const gchar *uuid,
-                  GError **error);
-

This calls other fs check uuid functions from this plugin based on the provided -filesystem (e.g. bd_fs_xfs_check_uuid for XFS). This function will return -an error for unknown/unsupported filesystems.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

fstype

the filesystem type to check uuid -for

 

uuid

uuid to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the fstype -file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_features ()

-
const BDFSFeatures *
-bd_fs_features (const gchar *fstype,
-                GError **error);
-

Returns (transfer-none): features supported by fstype -, see BDFSFeatures for more information.

-

Tech category: always available

-
-

Parameters

-
----- - - - - - - - - - - - - -

fstype

name of the filesystem to get features for (e.g. "ext4")

 

error

(out): place to store error (if any).

[allow-none]
-
-
-
-
-

bd_fs_features_copy ()

-
BDFSFeatures *
-bd_fs_features_copy (BDFSFeatures *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSFeatures to copy.

[allow-none]
-
-
-
-
-

bd_fs_features_free ()

-
void
-bd_fs_features_free (BDFSFeatures *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSFeatures to free.

[allow-none]
-
-
-
-
-

bd_fs_can_mkfs ()

-
gboolean
-bd_fs_can_mkfs (const gchar *type,
-                BDFSMkfsOptionsFlags *options,
-                gchar **required_utility,
-                GError **error);
-

Searches for the required utility to create the given filesystem and returns whether -it is installed. The options flags indicate what additional options can be specified for type -. -Unknown filesystems result in errors.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

type

the filesystem type to be tested for installed mkfs support

 

options

flags for allowed mkfs options (i.e. support for setting label or UUID when creating the filesystem).

[out]

required_utility

the utility binary which is required for creating (if missing returns FALSE but no error -).

[out][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether filesystem mkfs tool is available

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_QUERY

-
-
-
-
-

bd_fs_mkfs ()

-
gboolean
-bd_fs_mkfs (const gchar *device,
-            const gchar *fstype,
-            BDFSMkfsOptions *options,
-            const BDExtraArg **extra,
-            GError **error);
-

This is a helper function for creating filesystems with extra options. -This is the same as running a filesystem-specific function like bd_fs_ext4_mkfs -and manually specifying the extra command line options. BDFSMkfsOptions -removes the need to specify supported options for selected filesystems, -make sure to check whether fstype - supports these options (see bd_fs_can_mkfs) -for details.

-

When specifying additional mkfs options using extra -, it's caller's -responsibility to make sure these options do not conflict with options -specified using options -. Extra options are added after the options - and -there are no additional checks for duplicate and/or conflicting options.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to create the new filesystem on

 

fstype

name of the filesystem to create (e.g. "ext4")

 

options

additional options like label or UUID for the filesystem

 

extra

extra mkfs options not provided in options -.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether fstype -was successfully created on device -or not.

-

Tech category: BD_FS_TECH_GENERIC-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_mkfs_options_copy ()

-
BDFSMkfsOptions *
-bd_fs_mkfs_options_copy (BDFSMkfsOptions *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSMkfsOptions to copy.

[nullable]
-
-
-
-
-

bd_fs_mkfs_options_free ()

-
void
-bd_fs_mkfs_options_free (BDFSMkfsOptions *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSMkfsOptions to free.

[nullable]
-
-
-
-
-

bd_fs_supported_filesystems ()

-
const gchar **
-bd_fs_supported_filesystems (GError **error);
-
-

Parameters

-
----- - - - - - -

error

currently unused.

[out][optional]
-
-
-

Returns

-

list of filesystems supported by this plugin

-

Note: This returns filesystems supported by libblockdev, but not necessarily -by the systems this is running on, for this information you need to -run one of the bd_fs_can_ functions.

-

Tech category: always available.

-

[transfer container][array zero-terminated=1]

-
-
-
-
-

bd_fs_ext2_check ()

-
gboolean
-bd_fs_ext2_check (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to check

 

extra

extra options for the check (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext2 file system on the device -is clean or not

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_ext2_get_info ()

-
BDFSExt2Info *
-bd_fs_ext2_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device the file system of which to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_ext2_info_copy ()

-
BDFSExt2Info *
-bd_fs_ext2_info_copy (BDFSExt2Info *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt2Info to copy.

[nullable]
-
-
-
-
-

bd_fs_ext2_info_free ()

-
void
-bd_fs_ext2_info_free (BDFSExt2Info *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt2Info to free.

[nullable]
-
-
-
-
-

bd_fs_ext2_mkfs ()

-
gboolean
-bd_fs_ext2_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new ext2 fs on

 

extra

extra options for the creation (right now -passed to the 'mke2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new ext2 fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_ext2_repair ()

-
gboolean
-bd_fs_ext2_repair (const gchar *device,
-                   gboolean unsafe,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system on which to repair

 

unsafe

whether to do unsafe operations too

 

extra

extra options for the repair (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext2 file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_ext2_resize ()

-
gboolean
-bd_fs_ext2_resize (const gchar *device,
-                   guint64 new_size,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

extra

extra options for the resize (right now -passed to the 'resize2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_ext2_set_label ()

-
gboolean
-bd_fs_ext2_set_label (const gchar *device,
-                      const gchar *label,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of ext2 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_ext2_check_label ()

-
gboolean
-bd_fs_ext2_check_label (const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the ext2 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ext2_set_uuid ()

-
gboolean
-bd_fs_ext2_set_uuid (const gchar *device,
-                     const gchar *uuid,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set UUID for

 

uuid

UUID to set NULL to generate a new one -UUID can also be one of "clear", "random" and "time" to clear, -generate a new random/time-based UUID.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of ext2 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT2-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_ext2_check_uuid ()

-
gboolean
-bd_fs_ext2_check_uuid (const gchar *uuid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the ext2 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ext3_check ()

-
gboolean
-bd_fs_ext3_check (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to check

 

extra

extra options for the check (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext3 file system on the device -is clean or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_ext3_get_info ()

-
BDFSExt3Info *
-bd_fs_ext3_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device the file system of which to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_ext3_info_copy ()

-
BDFSExt3Info *
-bd_fs_ext3_info_copy (BDFSExt3Info *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt3Info to copy.

[nullable]
-
-
-
-
-

bd_fs_ext3_info_free ()

-
void
-bd_fs_ext3_info_free (BDFSExt3Info *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt3Info to free.

[nullable]
-
-
-
-
-

bd_fs_ext3_mkfs ()

-
gboolean
-bd_fs_ext3_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new ext3 fs on

 

extra

extra options for the creation (right now -passed to the 'mke2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new ext3 fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_ext3_repair ()

-
gboolean
-bd_fs_ext3_repair (const gchar *device,
-                   gboolean unsafe,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system on which to repair

 

unsafe

whether to do unsafe operations too

 

extra

extra options for the repair (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext3 file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_ext3_resize ()

-
gboolean
-bd_fs_ext3_resize (const gchar *device,
-                   guint64 new_size,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

extra

extra options for the resize (right now -passed to the 'resize2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_ext3_set_label ()

-
gboolean
-bd_fs_ext3_set_label (const gchar *device,
-                      const gchar *label,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of ext3 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_ext3_check_label ()

-
gboolean
-bd_fs_ext3_check_label (const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the ext3 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ext3_set_uuid ()

-
gboolean
-bd_fs_ext3_set_uuid (const gchar *device,
-                     const gchar *uuid,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set UUID for

 

uuid

UUID to set NULL to generate a new one -UUID can also be one of "clear", "random" and "time" to clear, -generate a new random/time-based UUID.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of ext3 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_ext3_check_uuid ()

-
gboolean
-bd_fs_ext3_check_uuid (const gchar *uuid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the ext3 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ext4_check ()

-
gboolean
-bd_fs_ext4_check (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to check

 

extra

extra options for the check (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext4 file system on the device -is clean or not

-

Tech category: BD_FS_TECH_EXT4-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_ext4_get_info ()

-
BDFSExt4Info *
-bd_fs_ext4_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device the file system of which to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_ext4_info_copy ()

-
BDFSExt4Info *
-bd_fs_ext4_info_copy (BDFSExt4Info *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt4Info to copy.

[nullable]
-
-
-
-
-

bd_fs_ext4_info_free ()

-
void
-bd_fs_ext4_info_free (BDFSExt4Info *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExt4Info to free.

[nullable]
-
-
-
-
-

bd_fs_ext4_mkfs ()

-
gboolean
-bd_fs_ext4_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new ext4 fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.ext4' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new ext4 fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_EXT4-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_ext4_repair ()

-
gboolean
-bd_fs_ext4_repair (const gchar *device,
-                   gboolean unsafe,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system on which to repair

 

unsafe

whether to do unsafe operations too

 

extra

extra options for the repair (right now -passed to the 'e2fsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ext4 file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_EXT4-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_ext4_resize ()

-
gboolean
-bd_fs_ext4_resize (const gchar *device,
-                   guint64 new_size,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

extra

extra options for the resize (right now -passed to the 'resize2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_EXT4-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_ext4_set_label ()

-
gboolean
-bd_fs_ext4_set_label (const gchar *device,
-                      const gchar *label,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of ext4 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT3-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_ext4_check_label ()

-
gboolean
-bd_fs_ext4_check_label (const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the ext4 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ext4_set_uuid ()

-
gboolean
-bd_fs_ext4_set_uuid (const gchar *device,
-                     const gchar *uuid,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system on which to set UUID for

 

uuid

UUID to set NULL to generate a new one -UUID can also be one of "clear", "random" and "time" to clear, -generate a new random/time-based UUID.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of ext4 file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXT4-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_ext4_check_uuid ()

-
gboolean
-bd_fs_ext4_check_uuid (const gchar *uuid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the ext4 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_xfs_check ()

-
gboolean
-bd_fs_xfs_check (const gchar *device,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an xfs file system on the device -is clean or not

-

Note: If the file system is mounted RW, it will always be reported as not -clean!

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_xfs_get_info ()

-
BDFSXfsInfo *
-bd_fs_xfs_get_info (const gchar *device,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for (device must -be mounted, trying to get info for an unmounted device will result -in an error)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_xfs_info_copy ()

-
BDFSXfsInfo *
-bd_fs_xfs_info_copy (BDFSXfsInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSXfsInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_xfs_info_free ()

-
void
-bd_fs_xfs_info_free (BDFSXfsInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSXfsInfo to free.

[nullable]
-
-
-
-
-

bd_fs_xfs_mkfs ()

-
gboolean
-bd_fs_xfs_mkfs (const gchar *device,
-                const BDExtraArg **extra,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new xfs fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.xfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new xfs fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_xfs_repair ()

-
gboolean
-bd_fs_xfs_repair (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to repair

 

extra

extra options for the repair (right now -passed to the 'xfs_repair' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an xfs file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_xfs_resize ()

-
gboolean
-bd_fs_xfs_resize (const gchar *mpoint,
-                  guint64 new_size,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mpoint

the mount point of the file system to resize

 

new_size

new requested size for the file system *in file system blocks* (see bd_fs_xfs_get_info()) -(if 0, the file system is adapted to the underlying block device)

 

extra

extra options for the resize (right now -passed to the 'xfs_growfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system mounted on mpoint -was successfully resized or not

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_xfs_set_label ()

-
gboolean
-bd_fs_xfs_set_label (const gchar *device,
-                     const gchar *label,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of xfs file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_xfs_check_label ()

-
gboolean
-bd_fs_xfs_check_label (const gchar *label,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the xfs file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_xfs_set_uuid ()

-
gboolean
-bd_fs_xfs_set_uuid (const gchar *device,
-                    const gchar *uuid,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set uuid for

 

uuid

UUID to set NULL to generate a new one -UUID can also be one of "nil" and "generate" to clear or -generate a new UUID.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of xfs file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_XFS-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_xfs_check_uuid ()

-
gboolean
-bd_fs_xfs_check_uuid (const gchar *uuid,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the xfs file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_vfat_check ()

-
gboolean
-bd_fs_vfat_check (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to check

 

extra

extra options for the repair (right now -passed to the 'fsck.vfat' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an vfat file system on the device -is clean or not

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_vfat_get_info ()

-
BDFSVfatInfo *
-bd_fs_vfat_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_vfat_info_copy ()

-
BDFSVfatInfo *
-bd_fs_vfat_info_copy (BDFSVfatInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSVfatInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_vfat_info_free ()

-
void
-bd_fs_vfat_info_free (BDFSVfatInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSVfatInfo to free.

[nullable]
-
-
-
-
-

bd_fs_vfat_mkfs ()

-
gboolean
-bd_fs_vfat_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-

Please remember that FAT labels should always be uppercase.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new vfat fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.vfat' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new vfat fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_vfat_repair ()

-
gboolean
-bd_fs_vfat_repair (const gchar *device,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to repair

 

extra

extra options for the repair (right now -passed to the 'fsck.vfat' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an vfat file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_vfat_resize ()

-
gboolean
-bd_fs_vfat_resize (const gchar *device,
-                   guint64 new_size,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_vfat_set_label ()

-
gboolean
-bd_fs_vfat_set_label (const gchar *device,
-                      const gchar *label,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of vfat file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_VFAT-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_vfat_check_label ()

-
gboolean
-bd_fs_vfat_check_label (const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the vfat file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_is_tech_avail ()

-
gboolean
-bd_fs_is_tech_avail (BDFSTech tech,
-                     guint64 mode,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDFSTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

bd_fs_ntfs_check ()

-
gboolean
-bd_fs_ntfs_check (const gchar *device,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an ntfs file system on the device -is clean or not

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_ntfs_get_info ()

-
BDFSNtfsInfo *
-bd_fs_ntfs_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for (device must -not be mounted, trying to get info for a mounted device will result -in an error)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_ntfs_mkfs ()

-
gboolean
-bd_fs_ntfs_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new ntfs fs on

 

extra

extra options for the creation (right now -passed to the 'mkntfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new NTFS fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_ntfs_repair ()

-
gboolean
-bd_fs_ntfs_repair (const gchar *device,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to repair

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an NTFS file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_ntfs_resize ()

-
gboolean
-bd_fs_ntfs_resize (const gchar *device,
-                   guint64 new_size,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system in bytes (if 0, the file system -is adapted to the underlying block device)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_ntfs_set_label ()

-
gboolean
-bd_fs_ntfs_set_label (const gchar *device,
-                      const gchar *label,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set the label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of the NTFS file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_ntfs_check_label ()

-
gboolean
-bd_fs_ntfs_check_label (const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the ntfs file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_ntfs_info_copy ()

-
BDFSNtfsInfo *
-bd_fs_ntfs_info_copy (BDFSNtfsInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSNtfsInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_ntfs_info_free ()

-
void
-bd_fs_ntfs_info_free (BDFSNtfsInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSNtfsInfo to free.

[nullable]
-
-
-
-
-

bd_fs_ntfs_set_uuid ()

-
gboolean
-bd_fs_ntfs_set_uuid (const gchar *device,
-                     const gchar *uuid,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set the UUID (serial number) for

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of the NTFS file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_NTFS-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_ntfs_check_uuid ()

-
gboolean
-bd_fs_ntfs_check_uuid (const gchar *uuid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the ntfs file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_f2fs_info_copy ()

-
BDFSF2FSInfo *
-bd_fs_f2fs_info_copy (BDFSF2FSInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSF2FSInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_f2fs_info_free ()

-
void
-bd_fs_f2fs_info_free (BDFSF2FSInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSF2FSInfo to free.

[nullable]
-
-
-
-
-

bd_fs_f2fs_mkfs ()

-
gboolean
-bd_fs_f2fs_mkfs (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new f2fs fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.f2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new f2fs fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_F2FS-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_f2fs_check ()

-
gboolean
-bd_fs_f2fs_check (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to check

 

extra

extra options for the repair (right now -passed to the 'fsck.f2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an f2fs file system on the device -is clean or not

-

Tech category: BD_FS_TECH_F2FS-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_f2fs_repair ()

-
gboolean
-bd_fs_f2fs_repair (const gchar *device,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to repair

 

extra

extra options for the repair (right now -passed to the 'fsck.f2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an f2fs file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_F2FS-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_f2fs_get_info ()

-
BDFSF2FSInfo *
-bd_fs_f2fs_get_info (const gchar *device,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_F2FS-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_f2fs_resize ()

-
gboolean
-bd_fs_f2fs_resize (const gchar *device,
-                   guint64 new_size,
-                   gboolean safe,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device containing the file system to resize

 

new_size

new requested size for the file system *in file system sectors* (see bd_fs_f2fs_get_info()) -(if 0, the file system is adapted to the underlying block device)

 

safe

whether to perform safe resize or not (does not resize metadata)

 

extra

extra options for the resize (right now -passed to the 'resize.f2fs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_F2FS-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_nilfs2_get_info ()

-
BDFSNILFS2Info *
-bd_fs_nilfs2_get_info (const gchar *device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_NILFS2-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_nilfs2_info_copy ()

-
BDFSNILFS2Info *
-bd_fs_nilfs2_info_copy (BDFSNILFS2Info *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSNILFS2Info to copy.

[nullable]
-
-
-
-
-

bd_fs_nilfs2_info_free ()

-
void
-bd_fs_nilfs2_info_free (BDFSNILFS2Info *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSNILFS2Info to free.

[nullable]
-
-
-
-
-

bd_fs_nilfs2_mkfs ()

-
gboolean
-bd_fs_nilfs2_mkfs (const gchar *device,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new nilfs fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.nilfs2' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new nilfs fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_NILFS2-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_nilfs2_resize ()

-
gboolean
-bd_fs_nilfs2_resize (const gchar *device,
-                     guint64 new_size,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device the file system of which to resize

 

new_size

new requested size for the file system (if 0, the file system is -adapted to the underlying block device)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file system on device -was successfully resized or not

-

Tech category: BD_FS_TECH_NILFS2-BD_FS_TECH_MODE_RESIZE

-
-
-
-
-

bd_fs_nilfs2_set_label ()

-
gboolean
-bd_fs_nilfs2_set_label (const gchar *device,
-                        const gchar *label,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of nilfs file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_NILFS2-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_nilfs2_check_label ()

-
gboolean
-bd_fs_nilfs2_check_label (const gchar *label,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the nilfs2 file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_nilfs2_set_uuid ()

-
gboolean
-bd_fs_nilfs2_set_uuid (const gchar *device,
-                       const gchar *uuid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set UUID for

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the uuid of nilfs file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_NILFS2-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_nilfs2_check_uuid ()

-
gboolean
-bd_fs_nilfs2_check_uuid (const gchar *uuid,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the nilfs file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_exfat_check ()

-
gboolean
-bd_fs_exfat_check (const gchar *device,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to check

 

extra

extra options for the repair (right now -passed to the 'exfatfsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the exfat file system on the device -is clean or not

-

Tech category: BD_FS_TECH_EXFAT-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_exfat_get_info ()

-
BDFSExfatInfo *
-bd_fs_exfat_get_info (const gchar *device,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error -Tech category: BD_FS_TECH_EXFAT-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_exfat_info_copy ()

-
BDFSExfatInfo *
-bd_fs_exfat_info_copy (BDFSExfatInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExfatInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_exfat_info_free ()

-
void
-bd_fs_exfat_info_free (BDFSExfatInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSExfatInfo to free.

[nullable]
-
-
-
-
-

bd_fs_exfat_mkfs ()

-
gboolean
-bd_fs_exfat_mkfs (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new exfat fs on

 

extra

extra options for the creation (right now -passed to the 'mkexfatfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new exfat fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_EXFAT-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_exfat_repair ()

-
gboolean
-bd_fs_exfat_repair (const gchar *device,
-                    const BDExtraArg **extra,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to repair

 

extra

extra options for the repair (right now -passed to the 'exfatfsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the exfat file system on the device -was successfully repaired -(if needed) or not (error is set in that case)

-

Tech category: BD_FS_TECH_EXFAT-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_exfat_set_label ()

-
gboolean
-bd_fs_exfat_set_label (const gchar *device,
-                       const gchar *label,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of exfat file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_EXFAT-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_exfat_check_label ()

-
gboolean
-bd_fs_exfat_check_label (const gchar *label,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the exfat file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_btrfs_get_info ()

-
BDFSBtrfsInfo *
-bd_fs_btrfs_get_info (const gchar *mpoint,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mpoint

a mountpoint of the btrfs filesystem to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Note: This function WON'T WORK for multi device btrfs filesystems, -for more complicated setups use the btrfs plugin instead.

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_btrfs_info_copy ()

-
BDFSBtrfsInfo *
-bd_fs_btrfs_info_copy (BDFSBtrfsInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSBtrfsInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_btrfs_info_free ()

-
void
-bd_fs_btrfs_info_free (BDFSBtrfsInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSBtrfsInfo to free.

[nullable]
-
-
-
-
-

bd_fs_btrfs_mkfs ()

-
gboolean
-bd_fs_btrfs_mkfs (const gchar *device,
-                  const BDExtraArg **extra,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to create a new btrfs fs on

 

extra

extra options for the creation (right now -passed to the 'mkfs.btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new btrfs fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_btrfs_check ()

-
gboolean
-bd_fs_btrfs_check (const gchar *device,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to check

 

extra

extra options for the check (right now -passed to the 'btrfsck' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the filesystem was successfully checked or not

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_CHECK

-
-
-
-
-

bd_fs_btrfs_repair ()

-
gboolean
-bd_fs_btrfs_repair (const gchar *device,
-                    const BDExtraArg **extra,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to repair

 

extra

extra options for the repair (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the filesystem was successfully checked and repaired or not

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_REPAIR

-
-
-
-
-

bd_fs_btrfs_set_label ()

-
gboolean
-bd_fs_btrfs_set_label (const gchar *mpoint,
-                       const gchar *label,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

mpoint

the mount point of the file system to resize

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of Btrfs file system on the mpoint -was -successfully set or not

-

Note: This function is intended to be used for btrfs filesystem on a single device, -for more complicated setups use the btrfs plugin instead.

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_btrfs_check_label ()

-
gboolean
-bd_fs_btrfs_check_label (const gchar *label,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the Btrfs file system or not -(reason is provided in error -)

-

Note: This function is intended to be used for btrfs filesystem on a single device, -for more complicated setups use the btrfs plugin instead.

-

Tech category: always available

-
-
-
-
-

bd_fs_btrfs_set_uuid ()

-
gboolean
-bd_fs_btrfs_set_uuid (const gchar *device,
-                      const gchar *uuid,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set the UUID (serial number) for

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of the Btrfs file system on the device -was -successfully set or not

-

Note: This function is intended to be used for btrfs filesystem on a single device, -for more complicated setups use the btrfs plugin instead.

-

Tech category: BD_FS_TECH_BTRFS-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_btrfs_check_uuid ()

-
gboolean
-bd_fs_btrfs_check_uuid (const gchar *uuid,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the Btrfs file system or not -(reason is provided in error -)

-

Note: This function is intended to be used for btrfs filesystem on a single device, -for more complicated setups use the btrfs plugin instead.

-

Tech category: always available

-
-
-
-
-

bd_fs_btrfs_resize ()

-
gboolean
-bd_fs_btrfs_resize (const gchar *mpoint,
-                    guint64 new_size,
-                    const BDExtraArg **extra,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

mpoint

a mountpoint of the to be resized btrfs filesystem

 

new_size

requested new size

 

extra

extra options for the volume resize (right now -passed to the 'btrfs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mpoint -filesystem was successfully resized to new_size -or not

-

Note: This function WON'T WORK for multi device btrfs filesystems, -for more complicated setups use the btrfs plugin instead.

-

Tech category: BD_BTRFS_TECH_FS-BD_BTRFS_TECH_MODE_MODIFY

-
-
-
-
-

bd_fs_udf_get_info ()

-
BDFSUdfInfo *
-bd_fs_udf_get_info (const gchar *device,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

the device containing the file system to get info for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the file system on device -or -NULL in case of error

-

Tech category: BD_FS_TECH_UDF-BD_FS_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_fs_udf_info_copy ()

-
BDFSUdfInfo *
-bd_fs_udf_info_copy (BDFSUdfInfo *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSUdfInfo to copy.

[nullable]
-
-
-
-
-

bd_fs_udf_info_free ()

-
void
-bd_fs_udf_info_free (BDFSUdfInfo *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDFSUdfInfo to free.

[nullable]
-
-
-
-
-

bd_fs_udf_mkfs ()

-
gboolean
-bd_fs_udf_mkfs (const gchar *device,
-                const gchar *media_type,
-                gchar *revision,
-                guint64 block_size,
-                const BDExtraArg **extra,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to create a new UDF fs on

 

media_type

specify the media type or NULL for default ('hd').

[nullable]

revision

UDF revision to use or NULL for default ('2.01').

[nullable]

block_size

block size in bytes or 0 for auto detection (device logical block size)

 

extra

extra options for the creation (right now -passed to the 'mkudffs' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new UDF fs was successfully created on device -or not

-

Tech category: BD_FS_TECH_UDF-BD_FS_TECH_MODE_MKFS

-
-
-
-
-

bd_fs_udf_set_label ()

-
gboolean
-bd_fs_udf_set_label (const gchar *device,
-                     const gchar *label,
-                     GError **error);
-

Note: This sets both Volume Identifier and Logical Volume Identifier. Volume Identifier - is truncated to 30 or 15 characters to accommodate to the different length limits - of these labels.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set label for

 

label

label to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label of UDF file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_UDF-BD_FS_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_fs_udf_check_label ()

-
gboolean
-bd_fs_udf_check_label (const gchar *label,
-                       GError **error);
-

Note: This checks only whether label - adheres the length limits for Logical Volume Identifier, - not the stricter limits for Volume Identifier.

-
-

Parameters

-
----- - - - - - - - - - - - - -

label

label to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether label -is a valid label for the UDF file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

bd_fs_udf_set_uuid ()

-
gboolean
-bd_fs_udf_set_uuid (const gchar *device,
-                    const gchar *uuid,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device containing the file system to set the UUID (serial number) for

 

uuid

UUID to set or NULL to generate a new one.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the UUID of the UDF file system on the device -was -successfully set or not

-

Tech category: BD_FS_TECH_UDF-BD_FS_TECH_MODE_SET_UUID

-
-
-
-
-

bd_fs_udf_check_uuid ()

-
gboolean
-bd_fs_udf_check_uuid (const gchar *uuid,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to check

 

error

place to store error.

[out][optional]
-
-
-

Returns

-

whether uuid -is a valid UUID for the UDF file system or not -(reason is provided in error -)

-

Tech category: always available

-
-
-
-
-

Types and Values

-
-

BDFSExt2Info

-
-
-
-

BDFSExt3Info

-
-
-
-

BDFSExt4Info

-
-
-
-

enum BDFsError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_ERROR_INVAL

  

BD_FS_ERROR_PARSE

  

BD_FS_ERROR_FAIL

  

BD_FS_ERROR_NOFS

  

BD_FS_ERROR_PIPE

  

BD_FS_ERROR_UNMOUNT_FAIL

  

BD_FS_ERROR_NOT_SUPPORTED

  

BD_FS_ERROR_NOT_MOUNTED

  

BD_FS_ERROR_AUTH

  

BD_FS_ERROR_TECH_UNAVAIL

  

BD_FS_ERROR_LABEL_INVALID

  

BD_FS_ERROR_UUID_INVALID

  

BD_FS_ERROR_UNKNOWN_FS

  
-
-
-
-
-

BD_FS_ERROR

-
#define             BD_FS_ERROR
-
-
-
-

enum BDFSConfigureFlags

-
-

Members

-
----- - - - - - - - - - - - - -

BD_FS_SUPPORT_SET_LABEL

  

BD_FS_SUPPORT_SET_UUID

  
-
-
-
-
-

enum BDFSFeatureFlags

-
-

Members

-
----- - - - - - - - - - - - - -

BD_FS_FEATURE_OWNERS

  

BD_FS_FEATURE_PARTITION_TABLE

  
-
-
-
-
-

BDFSFeatures

-
typedef struct {
-    BDFsResizeFlags resize;
-    BDFSMkfsOptionsFlags mkfs;
-    BDFSFsckFlags fsck;
-    BDFSConfigureFlags configure;
-    BDFSFeatureFlags features;
-    const gchar *partition_id;
-    const gchar *partition_type;
-} BDFSFeatures;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BDFsResizeFlags resize;

supported resizes modes

 

BDFSMkfsOptionsFlags mkfs;

supported options for mkfs

 

BDFSFsckFlags fsck;

support for fsck operations (check and repair)

 

BDFSConfigureFlags configure;

support for changing properties of an existing filesystem

 

BDFSFeatureFlags features;

other supported features

 

const gchar *partition_id;

partition ID used for this filesystem on MSDOS partitions

 

const gchar *partition_type;

partition type/GUID used for this filesystem GPT partitions

 
-
-
-
-
-

enum BDFSFsckFlags

-
-

Members

-
----- - - - - - - - - - - - - -

BD_FS_FSCK_CHECK

  

BD_FS_FSCK_REPAIR

  
-
-
-
-
-

BDFSMkfsOptions

-
typedef struct {
-    const gchar *label;
-    const gchar *uuid;
-    gboolean dry_run;
-    gboolean no_discard;
-    gboolean force;
-    gboolean no_pt;
-    guint8 reserve[32];
-} BDFSMkfsOptions;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

const gchar *label;

label of the filesystem

 

const gchar *uuid;

uuid of the filesystem

 

gboolean dry_run;

whether to run mkfs in dry run mode (no changes written to the device)

 

gboolean no_discard;

whether to avoid discarding blocks at mkfs time

 

gboolean force;

whether to run mkfs with the --force (or similar) option, the behaviour of this -option depends on the filesystem, but in general it allows overwriting other -preexisting formats detected on the device

 

gboolean no_pt;

whether to disable (protective) partition table creation during mkfs

 

guint8 reserve[32];

reserve for future expansion

 
-
-
-
-
-

enum BDFSMkfsOptionsFlags

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_MKFS_LABEL

  

BD_FS_MKFS_UUID

  

BD_FS_MKFS_DRY_RUN

  

BD_FS_MKFS_NODISCARD

  

BD_FS_MKFS_FORCE

  

BD_FS_MKFS_NOPT

  
-
-
-
-
-

BDFSXfsInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 block_size;
-    guint64 block_count;
-} BDFSXfsInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 block_size;

block size used by the filesystem

 

guint64 block_count;

number of blocks in the filesystem

 
-
-
-
-
-

BDFSVfatInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 cluster_size;
-    guint64 cluster_count;
-    guint64 free_cluster_count;
-} BDFSVfatInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 cluster_size;

cluster size used by the filesystem

 

guint64 cluster_count;

number of clusters in the filesystem

 

guint64 free_cluster_count;

number of free clusters in the filesystem

 
-
-
-
-
-

enum BDFSTech

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_TECH_GENERIC

  

BD_FS_TECH_MOUNT

  

BD_FS_TECH_EXT2

  

BD_FS_TECH_EXT3

  

BD_FS_TECH_EXT4

  

BD_FS_TECH_XFS

  

BD_FS_TECH_VFAT

  

BD_FS_TECH_NTFS

  

BD_FS_TECH_F2FS

  

BD_FS_TECH_NILFS2

  

BD_FS_TECH_EXFAT

  

BD_FS_TECH_BTRFS

  

BD_FS_TECH_UDF

  
-
-
-
-
-

enum BDFSTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_TECH_MODE_MKFS

  

BD_FS_TECH_MODE_WIPE

  

BD_FS_TECH_MODE_CHECK

  

BD_FS_TECH_MODE_REPAIR

  

BD_FS_TECH_MODE_SET_LABEL

  

BD_FS_TECH_MODE_QUERY

  

BD_FS_TECH_MODE_RESIZE

  

BD_FS_TECH_MODE_SET_UUID

  
-
-
-
-
-

enum BDFsResizeFlags

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_OFFLINE_SHRINK

  

BD_FS_OFFLINE_GROW

  

BD_FS_ONLINE_SHRINK

  

BD_FS_ONLINE_GROW

  
-
-
-
-
-

BDFSNtfsInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 size;
-    guint64 free_space;
-} BDFSNtfsInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 size;

size of the filesystem in bytes

 

guint64 free_space;

number of free space in the filesystem in bytes

 
-
-
-
-
-

BDFSF2FSInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 sector_size;
-    guint64 sector_count;
-    guint64 features;
-} BDFSF2FSInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 sector_size;

sector size used by the filesystem

 

guint64 sector_count;

number of sectors in the filesystem

 

guint64 features;

features enabled for this filesystem, see BDFSF2FSFeature

 
-
-
-
-
-

enum BDFSF2FSFeature

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_FS_F2FS_FEATURE_ENCRYPT

  

BD_FS_F2FS_FEATURE_BLKZONED

  

BD_FS_F2FS_FEATURE_ATOMIC_WRITE

  

BD_FS_F2FS_FEATURE_EXTRA_ATTR

  

BD_FS_F2FS_FEATURE_PRJQUOTA

  

BD_FS_F2FS_FEATURE_INODE_CHKSUM

  

BD_FS_F2FS_FEATURE_FLEXIBLE_INLINE_XATTR

  

BD_FS_F2FS_FEATURE_QUOTA_INO

  

BD_FS_F2FS_FEATURE_INODE_CRTIME

  

BD_FS_F2FS_FEATURE_LOST_FOUND

  

BD_FS_F2FS_FEATURE_VERITY

  

BD_FS_F2FS_FEATURE_SB_CHKSUM

  
-
-
-
-
-

BDFSNILFS2Info

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 size;
-    guint64 block_size;
-    guint64 free_blocks;
-} BDFSNILFS2Info;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 size;

size of the filesystem

 

guint64 block_size;

block size used by the filesystem

 

guint64 free_blocks;

number of free blocks in the filesystem

 
-
-
-
-
-

BDFSExfatInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 sector_size;
-    guint64 sector_count;
-    guint64 cluster_count;
-} BDFSExfatInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 sector_size;

sector size used by the filesystem

 

guint64 sector_count;

number of sectors in the filesystem

 

guint64 cluster_count;

number of clusters in the filesystem

 
-
-
-
-
-

BDFSBtrfsInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    guint64 size;
-    guint64 free_space;
-} BDFSBtrfsInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

guint64 size;

size of the filesystem in bytes

 

guint64 free_space;

free space on the filesystem in bytes

 
-
-
-
-
-

BDFSUdfInfo

-
typedef struct {
-    gchar *label;
-    gchar *uuid;
-    gchar *revision;
-    gchar *lvid;
-    gchar *vid;
-    guint64 block_size;
-    guint64 block_count;
-    guint64 free_blocks;
-} BDFSUdfInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *label;

label of the filesystem

 

gchar *uuid;

uuid of the filesystem

 

gchar *revision;

UDF revision

 

gchar *lvid;

Logical Volume Identifier (most UDF implementations use this identifier as a disk label)

 

gchar *vid;

Volume Identifier

 

guint64 block_size;

block size used by the filesystem

 

guint64 block_count;

number of blocks in the filesystem

 

guint64 free_blocks;

number of free blocks in the filesystem

 
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-KernelBlockDevices.html b/libblockdev/docs/3.0/libblockdev-KernelBlockDevices.html deleted file mode 100644 index d1abe94..0000000 --- a/libblockdev/docs/3.0/libblockdev-KernelBlockDevices.html +++ /dev/null @@ -1,1381 +0,0 @@ - - - - -KernelBlockDevices: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

KernelBlockDevices

-

KernelBlockDevices — plugin for operations with kernel block devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_kbd_check_deps () -
-gboolean - -bd_kbd_init () -
-void - -bd_kbd_close () -
-gboolean - -bd_kbd_bcache_attach () -
-gboolean - -bd_kbd_bcache_create () -
-gboolean - -bd_kbd_bcache_destroy () -
-gboolean - -bd_kbd_bcache_detach () -
-gchar * - -bd_kbd_bcache_get_backing_device () -
-gchar * - -bd_kbd_bcache_get_cache_device () -
-BDKBDBcacheMode - -bd_kbd_bcache_get_mode () -
-BDKBDBcacheMode - -bd_kbd_bcache_get_mode_from_str () -
const gchar * - -bd_kbd_bcache_get_mode_str () -
-gboolean - -bd_kbd_bcache_set_mode () -
-BDKBDBcacheStats * - -bd_kbd_bcache_stats_copy () -
-void - -bd_kbd_bcache_stats_free () -
-BDKBDBcacheStats * - -bd_kbd_bcache_status () -
-GQuark - -bd_kbd_error_quark () -
-gboolean - -bd_kbd_zram_create_devices () -
-gboolean - -bd_kbd_zram_destroy_devices () -
-gboolean - -bd_kbd_zram_add_device () -
-gboolean - -bd_kbd_zram_remove_device () -
-BDKBDZramStats * - -bd_kbd_zram_get_stats () -
-BDKBDZramStats * - -bd_kbd_zram_stats_copy () -
-void - -bd_kbd_zram_stats_free () -
-gboolean - -bd_kbd_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
enumBDKBDBcacheMode
 BDKBDBcacheStats
enumBDKBDError
 BDKBDZramStats
#defineBD_KBD_ERROR
enumBDKBDTech
enumBDKBDTechMode
-
-
-

Includes

-
#include <kbd.h>
-
-
-
-

Description

-

A plugin for operations with kernel block devices.

-
-
-

Functions

-
-

bd_kbd_check_deps ()

-
gboolean
-bd_kbd_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_kbd_init ()

-
gboolean
-bd_kbd_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_kbd_close ()

-
void
-bd_kbd_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_kbd_bcache_attach ()

-
gboolean
-bd_kbd_bcache_attach (const gchar *c_set_uuid,
-                      const gchar *bcache_device,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

c_set_uuid

cache set UUID of the cache to attach

 

bcache_device

bcache device to attach c_set_uuid -cache to

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the c_set_uuid -cache was successfully attached to bcache_device -or not

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_MODIFY

-
-
-
-
-

bd_kbd_bcache_create ()

-
gboolean
-bd_kbd_bcache_create (const gchar *backing_device,
-                      const gchar *cache_device,
-                      const BDExtraArg **extra,
-                      const gchar **bcache_device,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

backing_device

backing (slow) device of the cache

 

cache_device

cache (fast) device of the cache

 

extra

extra options for the creation (right now -passed to the 'make-bcache' utility).

[nullable][array zero-terminated=1]

bcache_device

place to store the name of the new bcache device (if any).

[out][optional][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the bcache device was successfully created or not

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_CREATE

-
-
-
-
-

bd_kbd_bcache_destroy ()

-
gboolean
-bd_kbd_bcache_destroy (const gchar *bcache_device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bcache_device

bcache device to destroy

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the bcache device bcache_device -was successfully destroyed or not

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_DESTROY

-
-
-
-
-

bd_kbd_bcache_detach ()

-
gboolean
-bd_kbd_bcache_detach (const gchar *bcache_device,
-                      gchar **c_set_uuid,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

bcache_device

bcache device to detach the cache from

 

c_set_uuid

cache set UUID of the detached cache.

[out][optional][transfer full]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the bcache device bcache_device -was successfully destroyed or not

-

Note: Flushes the cache first.

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_MODIFY

-
-
-
-
-

bd_kbd_bcache_get_backing_device ()

-
gchar *
-bd_kbd_bcache_get_backing_device (const gchar *bcache_device,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bcache_device

Bcache device to get the backing device for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

name of the backing device of the bcache_device -or NULL if failed to determine (error -is populated)

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_kbd_bcache_get_cache_device ()

-
gchar *
-bd_kbd_bcache_get_cache_device (const gchar *bcache_device,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bcache_device

Bcache device to get the cache device for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

name of the cache device of the bcache_device -or NULL if failed to determine (error -is populated)

-

Note: returns the name of the first cache device of bcache_device -(in case -there are more)

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_kbd_bcache_get_mode ()

-
BDKBDBcacheMode
-bd_kbd_bcache_get_mode (const gchar *bcache_device,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bcache_device

device to get mode of

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

current mode of the bcache_device -

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_QUERY

-
-
-
-
-

bd_kbd_bcache_get_mode_from_str ()

-
BDKBDBcacheMode
-bd_kbd_bcache_get_mode_from_str (const gchar *mode_str,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode_str

string representation of mode

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

mode matching the mode_str -given or BD_KBD_MODE_UNKNOWN in case of no match

-
-
-
-
-

bd_kbd_bcache_get_mode_str ()

-
const gchar *
-bd_kbd_bcache_get_mode_str (BDKBDBcacheMode mode,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode

mode to get string representation of

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of mode -or NULL in case of error

-

Tech category: always available.

-

[transfer none]

-
-
-
-
-

bd_kbd_bcache_set_mode ()

-
gboolean
-bd_kbd_bcache_set_mode (const gchar *bcache_device,
-                        BDKBDBcacheMode mode,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

bcache_device

bcache device to set mode of

 

mode

mode to set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the mode was successfully set or not

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_MODIFY

-
-
-
-
-

bd_kbd_bcache_stats_copy ()

-
BDKBDBcacheStats *
-bd_kbd_bcache_stats_copy (BDKBDBcacheStats *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDKBDBcacheStats to copy.

[nullable]
-
-
-
-
-

bd_kbd_bcache_stats_free ()

-
void
-bd_kbd_bcache_stats_free (BDKBDBcacheStats *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDKBDBcacheStats to copy.

[nullable]
-
-
-
-
-

bd_kbd_bcache_status ()

-
BDKBDBcacheStats *
-bd_kbd_bcache_status (const gchar *bcache_device,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

bcache_device

bcache device to get status for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

status of the bcache_device -or NULL in case of -error (error -is set)

-

Tech category: BD_KBD_TECH_BCACHE-BD_KBD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_kbd_error_quark ()

-
GQuark
-bd_kbd_error_quark (void);
-

[skip]

-
-
-
-

bd_kbd_zram_create_devices ()

-
gboolean
-bd_kbd_zram_create_devices (guint64 num_devices,
-                            const guint64 *sizes,
-                            const guint64 *nstreams,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

num_devices

number of devices to create

 

sizes

requested sizes (in bytes) for created zRAM -devices.

[array zero-terminated=1]

nstreams

numbers of streams for created -zRAM devices.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether num_devices -zRAM devices were successfully created or not

-

**Lengths of size -and nstreams -(if given) have to be >= num_devices -!**

-

Tech category: BD_KBD_TECH_ZRAM-BD_KBD_TECH_MODE_CREATE

-
-
-
-
-

bd_kbd_zram_destroy_devices ()

-
gboolean
-bd_kbd_zram_destroy_devices (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether zRAM devices were successfully destroyed or not

-

The only way how to destroy zRAM device right now is to unload the 'zram' -module and thus destroy all of them. That's why this function doesn't allow -specification of which devices should be destroyed.

-

Tech category: BD_KBD_TECH_ZRAM-BD_KBD_TECH_MODE_DESTROY

-
-
-
-
-

bd_kbd_zram_add_device ()

-
gboolean
-bd_kbd_zram_add_device (guint64 size,
-                        guint64 nstreams,
-                        gchar **device,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

size

size of the zRAM device to add

 

nstreams

number of streams to use for the new device (or 0 to use the defaults)

 

device

place to store the name of the newly added device.

[optional][out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a new zRAM device was added or not

-

Tech category: BD_KBD_TECH_ZRAM-BD_KBD_TECH_MODE_MODIFY

-
-
-
-
-

bd_kbd_zram_remove_device ()

-
gboolean
-bd_kbd_zram_remove_device (const gchar *device,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

zRAM device to remove

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully removed or not

-

Tech category: BD_KBD_TECH_ZRAM-BD_KBD_TECH_MODE_MODIFY

-
-
-
-
-

bd_kbd_zram_get_stats ()

-
BDKBDZramStats *
-bd_kbd_zram_get_stats (const gchar *device,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

zRAM device to get stats for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

statistics for the zRAM device

-

Tech category: BD_KBD_TECH_ZRAM-BD_KBD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_kbd_zram_stats_copy ()

-
BDKBDZramStats *
-bd_kbd_zram_stats_copy (BDKBDZramStats *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDKBDZramStats to copy.

[nullable]
-
-
-
-
-

bd_kbd_zram_stats_free ()

-
void
-bd_kbd_zram_stats_free (BDKBDZramStats *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDKBDZramStats to free.

[nullable]
-
-
-
-
-

bd_kbd_is_tech_avail ()

-
gboolean
-bd_kbd_is_tech_avail (BDKBDTech tech,
-                      guint64 mode,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDKBDTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

enum BDKBDBcacheMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_KBD_MODE_WRITETHROUGH

  

BD_KBD_MODE_WRITEBACK

  

BD_KBD_MODE_WRITEAROUND

  

BD_KBD_MODE_NONE

  

BD_KBD_MODE_UNKNOWN

  
-
-
-
-
-

BDKBDBcacheStats

-
typedef struct {
-    gchar *state;
-    guint64 block_size;
-    guint64 cache_size;
-    guint64 cache_used;
-    guint64 hits;
-    guint64 misses;
-    guint64 bypass_hits;
-    guint64 bypass_misses;
-} BDKBDBcacheStats;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *state;

state of the cache

 

guint64 block_size;

block size used by the cache

 

guint64 cache_size;

size of the cache

 

guint64 cache_used;

size of the used space in the cache

 

guint64 hits;

number of hits

 

guint64 misses;

number of misses

 

guint64 bypass_hits;

number of bypass hits

 

guint64 bypass_misses;

number of bypass misses

 
-
-
-
-
-

enum BDKBDError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_KBD_ERROR_INVAL

  

BD_KBD_ERROR_ZRAM_NOEXIST

  

BD_KBD_ERROR_ZRAM_INVAL

  

BD_KBD_ERROR_BCACHE_PARSE

  

BD_KBD_ERROR_BCACHE_SETUP_FAIL

  

BD_KBD_ERROR_BCACHE_DETACH_FAIL

  

BD_KBD_ERROR_BCACHE_NOT_ATTACHED

  

BD_KBD_ERROR_BCACHE_UUID

  

BD_KBD_ERROR_BCACHE_MODE_FAIL

  

BD_KBD_ERROR_BCACHE_MODE_INVAL

  

BD_KBD_ERROR_BCACHE_NOEXIST

  

BD_KBD_ERROR_BCACHE_INVAL

  

BD_KBD_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

BDKBDZramStats

-
typedef struct {
-    guint64 disksize;
-    guint64 num_reads;
-    guint64 num_writes;
-    guint64 invalid_io;
-    guint64 zero_pages;
-    guint64 max_comp_streams;
-    gchar* comp_algorithm;
-    guint64 orig_data_size;
-    guint64 compr_data_size;
-    guint64 mem_used_total;
-} BDKBDZramStats;
-
-

see zRAM kernel documentation for details -(https://www.kernel.org/doc/Documentation/blockdev/zram.txt)

-
-
-
-

BD_KBD_ERROR

-
#define             BD_KBD_ERROR
-
-
-
-

enum BDKBDTech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_KBD_TECH_ZRAM

  

BD_KBD_TECH_BCACHE

  
-
-
-
-
-

enum BDKBDTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_KBD_TECH_MODE_CREATE

  

BD_KBD_TECH_MODE_DESTROY

  

BD_KBD_TECH_MODE_MODIFY

  

BD_KBD_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-LVM.html b/libblockdev/docs/3.0/libblockdev-LVM.html deleted file mode 100644 index e8216e8..0000000 --- a/libblockdev/docs/3.0/libblockdev-LVM.html +++ /dev/null @@ -1,6691 +0,0 @@ - - - - -LVM: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

LVM

-

LVM — plugin for operations with LVM

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_lvm_check_deps () -
-void - -bd_lvm_close () -
-gboolean - -bd_lvm_init () -
-GQuark - -bd_lvm_error_quark () -
-void - -bd_lvm_pvdata_free () -
-BDLVMPVdata * - -bd_lvm_pvdata_copy () -
-void - -bd_lvm_vgdata_free () -
-BDLVMVGdata * - -bd_lvm_vgdata_copy () -
-void - -bd_lvm_segdata_free () -
-BDLVMSEGdata * - -bd_lvm_segdata_copy () -
-void - -bd_lvm_lvdata_free () -
-BDLVMLVdata * - -bd_lvm_lvdata_copy () -
-BDLVMCacheStats * - -bd_lvm_cache_stats_copy () -
-void - -bd_lvm_cache_stats_free () -
-void - -bd_lvm_vdo_stats_free () -
-BDLVMVDOStats * - -bd_lvm_vdo_stats_copy () -
-gboolean - -bd_lvm_is_supported_pe_size () -
-guint64 * - -bd_lvm_get_supported_pe_sizes () -
-guint64 - -bd_lvm_get_max_lv_size () -
-guint64 - -bd_lvm_round_size_to_pe () -
-guint64 - -bd_lvm_get_lv_physical_size () -
-guint64 - -bd_lvm_get_thpool_padding () -
-guint64 - -bd_lvm_get_thpool_meta_size () -
-gboolean - -bd_lvm_is_valid_thpool_md_size () -
-gboolean - -bd_lvm_is_valid_thpool_chunk_size () -
-gboolean - -bd_lvm_pvcreate () -
-gboolean - -bd_lvm_pvresize () -
-gboolean - -bd_lvm_pvremove () -
-gboolean - -bd_lvm_pvmove () -
-gboolean - -bd_lvm_pvscan () -
-gboolean - -bd_lvm_add_pv_tags () -
-gboolean - -bd_lvm_delete_pv_tags () -
-BDLVMPVdata * - -bd_lvm_pvinfo () -
-BDLVMPVdata ** - -bd_lvm_pvs () -
-gboolean - -bd_lvm_vgcreate () -
-gboolean - -bd_lvm_vgremove () -
-gboolean - -bd_lvm_vgrename () -
-gboolean - -bd_lvm_vgactivate () -
-gboolean - -bd_lvm_vgdeactivate () -
-gboolean - -bd_lvm_vgextend () -
-gboolean - -bd_lvm_vgreduce () -
-gboolean - -bd_lvm_add_vg_tags () -
-gboolean - -bd_lvm_delete_vg_tags () -
-BDLVMVGdata * - -bd_lvm_vginfo () -
-BDLVMVGdata ** - -bd_lvm_vgs () -
-gchar * - -bd_lvm_lvorigin () -
-gboolean - -bd_lvm_lvcreate () -
-gboolean - -bd_lvm_lvremove () -
-gboolean - -bd_lvm_lvrename () -
-gboolean - -bd_lvm_lvresize () -
-gboolean - -bd_lvm_lvrepair () -
-gboolean - -bd_lvm_lvactivate () -
-gboolean - -bd_lvm_lvdeactivate () -
-gboolean - -bd_lvm_lvsnapshotcreate () -
-gboolean - -bd_lvm_lvsnapshotmerge () -
-gboolean - -bd_lvm_add_lv_tags () -
-gboolean - -bd_lvm_delete_lv_tags () -
-BDLVMLVdata * - -bd_lvm_lvinfo () -
-BDLVMLVdata * - -bd_lvm_lvinfo_tree () -
-BDLVMLVdata ** - -bd_lvm_lvs () -
-BDLVMLVdata ** - -bd_lvm_lvs_tree () -
-gboolean - -bd_lvm_thpoolcreate () -
-gboolean - -bd_lvm_thpool_convert () -
-gboolean - -bd_lvm_thlvcreate () -
-gchar * - -bd_lvm_thlvpoolname () -
-gboolean - -bd_lvm_thsnapshotcreate () -
-gboolean - -bd_lvm_set_global_config () -
-gchar * - -bd_lvm_get_global_config () -
-gboolean - -bd_lvm_cache_attach () -
-gboolean - -bd_lvm_cache_create_cached_lv () -
-gboolean - -bd_lvm_cache_create_pool () -
-gboolean - -bd_lvm_cache_pool_convert () -
-gboolean - -bd_lvm_cache_detach () -
-guint64 - -bd_lvm_cache_get_default_md_size () -
-BDLVMCacheMode - -bd_lvm_cache_get_mode_from_str () -
const gchar * - -bd_lvm_cache_get_mode_str () -
-gchar * - -bd_lvm_cache_pool_name () -
-BDLVMCacheStats * - -bd_lvm_cache_stats () -
-gchar * - -bd_lvm_vdolvpoolname () -
const gchar * - -bd_lvm_get_vdo_operating_mode_str () -
const gchar * - -bd_lvm_get_vdo_compression_state_str () -
const gchar * - -bd_lvm_get_vdo_index_state_str () -
-BDLVMVDOWritePolicy - -bd_lvm_get_vdo_write_policy_from_str () -
-BDLVMVDOStats * - -bd_lvm_vdo_get_stats () -
-GHashTable * - -bd_lvm_vdo_get_stats_full () -
-gboolean - -bd_lvm_vdo_disable_compression () -
-gboolean - -bd_lvm_vdo_disable_deduplication () -
-gboolean - -bd_lvm_vdo_enable_compression () -
-gboolean - -bd_lvm_vdo_enable_deduplication () -
-BDLVMVDOPooldata * - -bd_lvm_vdo_info () -
-gboolean - -bd_lvm_vdo_pool_convert () -
-gboolean - -bd_lvm_vdo_pool_create () -
-gboolean - -bd_lvm_vdo_pool_resize () -
-gboolean - -bd_lvm_vdo_resize () -
-BDLVMVDOPooldata * - -bd_lvm_vdopooldata_copy () -
-void - -bd_lvm_vdopooldata_free () -
-gboolean - -bd_lvm_devices_add () -
-gboolean - -bd_lvm_devices_delete () -
-gchar ** - -bd_lvm_get_devices_filter () -
const gchar * - -bd_lvm_get_vdo_write_policy_str () -
-gboolean - -bd_lvm_set_devices_filter () -
-gboolean - -bd_lvm_writecache_attach () -
-gboolean - -bd_lvm_writecache_create_cached_lv () -
-gboolean - -bd_lvm_writecache_detach () -
-gboolean - -bd_lvm_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_LVM_DEFAULT_PE_SIZE
#defineBD_LVM_DEFAULT_PE_START
#defineBD_LVM_MIN_PE_SIZE
#defineBD_LVM_MAX_PE_SIZE
#defineBD_LVM_MIN_THPOOL_MD_SIZE
#defineBD_LVM_MAX_THPOOL_MD_SIZE
#defineBD_LVM_MIN_THPOOL_CHUNK_SIZE
#defineBD_LVM_MAX_THPOOL_CHUNK_SIZE
#defineBD_LVM_MIN_CACHE_MD_SIZE
#defineBD_LVM_DEFAULT_CHUNK_SIZE
#defineBD_LVM_ERROR
enumBDLVMError
 BDLVMPVdata
 BDLVMVGdata
 BDLVMSEGdata
 BDLVMLVdata
enumBDLVMCacheMode
enumBDLVMCachePoolFlags
 BDLVMCacheStats
 BDLVMVDOStats
enumBDLVMVDOCompressionState
enumBDLVMVDOIndexState
enumBDLVMVDOOperatingMode
 BDLVMVDOPooldata
enumBDLVMVDOWritePolicy
enumBDLVMTech
enumBDLVMTechMode
-
-
-

Includes

-
#include <lvm.h>
-
-
-
-

Description

-

A plugin for operations with LVM. All sizes passed in/out to/from -the functions are in bytes.

-
-
-

Functions

-
-

bd_lvm_check_deps ()

-
gboolean
-bd_lvm_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_lvm_close ()

-
void
-bd_lvm_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_lvm_init ()

-
gboolean
-bd_lvm_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_lvm_error_quark ()

-
GQuark
-bd_lvm_error_quark (void);
-

[skip]

-
-
-
-

bd_lvm_pvdata_free ()

-
void
-bd_lvm_pvdata_free (BDLVMPVdata *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMPVdata to free.

[nullable]
-
-
-
-
-

bd_lvm_pvdata_copy ()

-
BDLVMPVdata *
-bd_lvm_pvdata_copy (BDLVMPVdata *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMPVdata to copy.

[nullable]
-
-
-
-
-

bd_lvm_vgdata_free ()

-
void
-bd_lvm_vgdata_free (BDLVMVGdata *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMVGdata to free.

[nullable]
-
-
-
-
-

bd_lvm_vgdata_copy ()

-
BDLVMVGdata *
-bd_lvm_vgdata_copy (BDLVMVGdata *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMVGdata to copy.

[nullable]
-
-
-
-
-

bd_lvm_segdata_free ()

-
void
-bd_lvm_segdata_free (BDLVMSEGdata *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMSEGdata to free.

[nullable]
-
-
-
-
-

bd_lvm_segdata_copy ()

-
BDLVMSEGdata *
-bd_lvm_segdata_copy (BDLVMSEGdata *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMSEGdata to copy.

[nullable]
-
-
-
-
-

bd_lvm_lvdata_free ()

-
void
-bd_lvm_lvdata_free (BDLVMLVdata *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMLVdata to free.

[nullable]
-
-
-
-
-

bd_lvm_lvdata_copy ()

-
BDLVMLVdata *
-bd_lvm_lvdata_copy (BDLVMLVdata *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMLVdata to copy.

[nullable]
-
-
-
-
-

bd_lvm_cache_stats_copy ()

-
BDLVMCacheStats *
-bd_lvm_cache_stats_copy (BDLVMCacheStats *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMCacheStats to copy.

[nullable]
-
-
-
-
-

bd_lvm_cache_stats_free ()

-
void
-bd_lvm_cache_stats_free (BDLVMCacheStats *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMCacheStats to free.

[nullable]
-
-
-
-
-

bd_lvm_vdo_stats_free ()

-
void
-bd_lvm_vdo_stats_free (BDLVMVDOStats *stats);
-

Frees stats -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

stats

BDLVMVDOStats to free.

[nullable]
-
-
-
-
-

bd_lvm_vdo_stats_copy ()

-
BDLVMVDOStats *
-bd_lvm_vdo_stats_copy (BDLVMVDOStats *stats);
-

Creates a new copy of stats -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

stats

BDLVMVDOStats to copy.

[nullable]
-
-
-
-
-

bd_lvm_is_supported_pe_size ()

-
gboolean
-bd_lvm_is_supported_pe_size (guint64 size,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

size

size (in bytes) to test

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given size is supported physical extent size or not

-

Tech category: BD_LVM_TECH_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_supported_pe_sizes ()

-
guint64 *
-bd_lvm_get_supported_pe_sizes (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

list of supported PE sizes

-

Tech category: BD_LVM_TECH_CALCS no mode (it is ignored).

-

[transfer full][array fixed-size=25]

-
-
-
-
-

bd_lvm_get_max_lv_size ()

-
guint64
-bd_lvm_get_max_lv_size (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

maximum LV size in bytes

-

Tech category: BD_LVM_TECH_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_round_size_to_pe ()

-
guint64
-bd_lvm_round_size_to_pe (guint64 size,
-                         guint64 pe_size,
-                         gboolean roundup,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

size

size to be rounded

 

pe_size

physical extent (PE) size or 0 to use the default

 

roundup

whether to round up or down (ceil or floor)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

size -rounded to pe_size -according to the roundup -

-

Rounds given size -up/down to a multiple of pe_size -according to the value -of the roundup -parameter. If the rounded value is too big to fit in the -return type, the result is rounded down (floored) regardless of the roundup -parameter.

-

Tech category: BD_LVM_TECH_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_lv_physical_size ()

-
guint64
-bd_lvm_get_lv_physical_size (guint64 lv_size,
-                             guint64 pe_size,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

lv_size

LV size

 

pe_size

PE size

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

space taken on disk(s) by the LV with given size -

-

Gives number of bytes needed for an LV with the size lv_size -on an LVM stack -using given pe_size -.

-

Tech category: BD_LVM_TECH_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_thpool_padding ()

-
guint64
-bd_lvm_get_thpool_padding (guint64 size,
-                           guint64 pe_size,
-                           gboolean included,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

size

size of the thin pool

 

pe_size

PE size or 0 if the default value should be used

 

included

if padding is already included in the size

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

size of the padding needed for a thin pool with the given size -according to the pe_size -and included -

-

Tech category: BD_LVM_TECH_THIN_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_thpool_meta_size ()

-
guint64
-bd_lvm_get_thpool_meta_size (guint64 size,
-                             guint64 chunk_size,
-                             guint64 n_snapshots,
-                             GError **error);
-

Note: This function will be changed in 3.0: the n_snapshots - parameter - is currently not used and will be removed.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

size

size of the thin pool

 

chunk_size

chunk size of the thin pool or 0 to use the default (BD_LVM_DEFAULT_CHUNK_SIZE)

 

n_snapshots

ignored

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

recommended size of the metadata space for the specified pool

-

Tech category: BD_LVM_TECH_THIN_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_is_valid_thpool_md_size ()

-
gboolean
-bd_lvm_is_valid_thpool_md_size (guint64 size,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

size

the size to be tested

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given size is a valid thin pool metadata size or not

-

Tech category: BD_LVM_TECH_THIN_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_is_valid_thpool_chunk_size ()

-
gboolean
-bd_lvm_is_valid_thpool_chunk_size (guint64 size,
-                                   gboolean discard,
-                                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

size

the size to be tested

 

discard

whether discard/TRIM is required to be supported or not

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given size is a valid thin pool chunk size or not

-

Tech category: BD_LVM_TECH_THIN_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_pvcreate ()

-
gboolean
-bd_lvm_pvcreate (const gchar *device,
-                 guint64 data_alignment,
-                 guint64 metadata_size,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

the device to make PV from

 

data_alignment

data (first PE) alignment or 0 to use the default

 

metadata_size

size of the area reserved for metadata or 0 to use the default

 

extra

extra options for the PV creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the PV was successfully created or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_pvresize ()

-
gboolean
-bd_lvm_pvresize (const gchar *device,
-                 guint64 size,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device to resize

 

size

the new requested size of the PV or 0 if it should be adjusted to device's size

 

extra

extra options for the PV resize -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the PV's size was successfully changed or not

-

If given size -different from 0, sets the PV's size to the given value (see -pvresize(8)). If given size -0, adjusts the PV's size to the underlying -block device's size.

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_pvremove ()

-
gboolean
-bd_lvm_pvremove (const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the PV device to be removed/destroyed

 

extra

extra options for the PV removal -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the PV was successfully removed/destroyed or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_REMOVE

-
-
-
-
-

bd_lvm_pvmove ()

-
gboolean
-bd_lvm_pvmove (const gchar *src,
-               const gchar *dest,
-               const BDExtraArg **extra,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

src

the PV device to move extents off of

 

dest

the PV device to move extents onto or NULL.

[nullable]

extra

extra options for the PV move -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the extents from the src -PV where successfully moved or not

-

If dest -is NULL, VG allocation rules are used for the extents from the src -PV (see pvmove(8)).

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_pvscan ()

-
gboolean
-bd_lvm_pvscan (const gchar *device,
-               gboolean update_cache,
-               const BDExtraArg **extra,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

the device to scan for PVs or NULL.

[nullable]

update_cache

whether to update the lvmetad cache or not

 

extra

extra options for the PV scan -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the system or device -was successfully scanned for PVs or not

-

The device -argument is used only if update_cache -is TRUE. Otherwise the -whole system is scanned for PVs.

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_add_pv_tags ()

-
gboolean
-bd_lvm_add_pv_tags (const gchar *device,
-                    const gchar **tags,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to set PV tags for

 

tags

list of tags to add.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully added to device -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_delete_pv_tags ()

-
gboolean
-bd_lvm_delete_pv_tags (const gchar *device,
-                       const gchar **tags,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

the device to set PV tags for

 

tags

list of tags to remove.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully removed from device -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_pvinfo ()

-
BDLVMPVdata *
-bd_lvm_pvinfo (const gchar *device,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a PV to get information about or NULL

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the PV on the given device -or -NULL in case of error (the error -) gets populated in those cases)

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_pvs ()

-
BDLVMPVdata **
-bd_lvm_pvs (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about PVs found in the system

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_lvm_vgcreate ()

-
gboolean
-bd_lvm_vgcreate (const gchar *name,
-                 const gchar **pv_list,
-                 guint64 pe_size,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

name of the newly created VG

 

pv_list

list of PVs the newly created VG should use.

[array zero-terminated=1]

pe_size

PE size or 0 if the default value should be used

 

extra

extra options for the VG creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG name -was successfully created or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_vgremove ()

-
gboolean
-bd_lvm_vgremove (const gchar *vg_name,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the to be removed VG

 

extra

extra options for the VG removal -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG was successfully removed or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_REMOVE

-
-
-
-
-

bd_lvm_vgrename ()

-
gboolean
-bd_lvm_vgrename (const gchar *old_vg_name,
-                 const gchar *new_vg_name,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

old_vg_name

old name of the VG to rename

 

new_vg_name

new name for the old_vg_name -VG

 

extra

extra options for the VG rename -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG was successfully renamed or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vgactivate ()

-
gboolean
-bd_lvm_vgactivate (const gchar *vg_name,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the to be activated VG

 

extra

extra options for the VG activation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG was successfully activated or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vgdeactivate ()

-
gboolean
-bd_lvm_vgdeactivate (const gchar *vg_name,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the to be deactivated VG

 

extra

extra options for the VG deactivation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG was successfully deactivated or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vgextend ()

-
gboolean
-bd_lvm_vgextend (const gchar *vg_name,
-                 const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the to be extended VG

 

device

PV device to extend the vg_name -VG with

 

extra

extra options for the VG extension -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG vg_name -was successfully extended with the given device -or not.

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vgreduce ()

-
gboolean
-bd_lvm_vgreduce (const gchar *vg_name,
-                 const gchar *device,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the to be reduced VG

 

device

PV device the vg_name -VG should be reduced of or NULL -if the VG should be reduced of the missing PVs.

[nullable]

extra

extra options for the VG reduction -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the VG vg_name -was successfully reduced of the given device -or not

-

Note: This function does not move extents off of the PV before removing -it from the VG. You must do that first by calling bd_lvm_pvmove.

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_add_vg_tags ()

-
gboolean
-bd_lvm_add_vg_tags (const gchar *vg_name,
-                    const gchar **tags,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

the VG to set tags on

 

tags

list of tags to add.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully added to vg_name -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_delete_vg_tags ()

-
gboolean
-bd_lvm_delete_vg_tags (const gchar *vg_name,
-                       const gchar **tags,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

the VG to set tags on

 

tags

list of tags to remove.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully removed from vg_name -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_vginfo ()

-
BDLVMVGdata *
-bd_lvm_vginfo (const gchar *vg_name,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

vg_name

a VG to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the vg_name -VG or NULL in case -of error (the error -) gets populated in those cases)

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_vgs ()

-
BDLVMVGdata **
-bd_lvm_vgs (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about VGs found in the system

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_lvm_lvorigin ()

-
gchar *
-bd_lvm_lvorigin (const gchar *vg_name,
-                 const gchar *lv_name,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the queried LV

 

lv_name

name of the queried LV

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

the origin volume for the vg_name -/lv_name -LV or -NULL if failed to determine (error -) is set in those cases)

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_lvcreate ()

-
gboolean
-bd_lvm_lvcreate (const gchar *vg_name,
-                 const gchar *lv_name,
-                 guint64 size,
-                 const gchar *type,
-                 const gchar **pv_list,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create a new LV in

 

lv_name

name of the to-be-created LV

 

size

requested size of the new LV

 

type

type of the new LV ("striped", "raid1",..., see lvcreate (8)).

[nullable]

pv_list

list of PVs the newly created LV should use or NULL -if not specified.

[nullable][array zero-terminated=1]

extra

extra options for the LV creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given vg_name -/lv_name -LV was successfully created or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_lvremove ()

-
gboolean
-bd_lvm_lvremove (const gchar *vg_name,
-                 const gchar *lv_name,
-                 gboolean force,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-removed LV

 

lv_name

name of the to-be-removed LV

 

force

whether to force removal or not

 

extra

extra options for the LV removal -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully removed or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_REMOVE

-
-
-
-
-

bd_lvm_lvrename ()

-
gboolean
-bd_lvm_lvrename (const gchar *vg_name,
-                 const gchar *lv_name,
-                 const gchar *new_name,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-renamed LV

 

lv_name

name of the to-be-renamed LV

 

new_name

new name for the vg_name -/lv_name -LV

 

extra

extra options for the LV rename -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully renamed to -vg_name -/new_name -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_lvresize ()

-
gboolean
-bd_lvm_lvresize (const gchar *vg_name,
-                 const gchar *lv_name,
-                 guint64 size,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-resized LV

 

lv_name

name of the to-be-resized LV

 

size

the requested new size of the LV

 

extra

extra options for the LV resize -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully resized or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_lvrepair ()

-
gboolean
-bd_lvm_lvrepair (const gchar *vg_name,
-                 const gchar *lv_name,
-                 const gchar **pv_list,
-                 const BDExtraArg **extra,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-repaired LV

 

lv_name

name of the to-be-repaired LV

 

pv_list

list of PVs to be used for the repair.

[array zero-terminated=1]

extra

extra options for the LV repair -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully repaired or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_lvactivate ()

-
gboolean
-bd_lvm_lvactivate (const gchar *vg_name,
-                   const gchar *lv_name,
-                   gboolean ignore_skip,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-activated LV

 

lv_name

name of the to-be-activated LV

 

ignore_skip

whether to ignore the skip flag or not

 

extra

extra options for the LV activation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully activated or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_lvdeactivate ()

-
gboolean
-bd_lvm_lvdeactivate (const gchar *vg_name,
-                     const gchar *lv_name,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-deactivated LV

 

lv_name

name of the to-be-deactivated LV

 

extra

extra options for the LV deactivation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -LV was successfully deactivated or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_lvsnapshotcreate ()

-
gboolean
-bd_lvm_lvsnapshotcreate (const gchar *vg_name,
-                         const gchar *origin_name,
-                         const gchar *snapshot_name,
-                         guint64 size,
-                         const BDExtraArg **extra,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the LV a new snapshot should be created of

 

origin_name

name of the LV a new snapshot should be created of

 

snapshot_name

name fo the to-be-created snapshot

 

size

requested size for the snapshot

 

extra

extra options for the LV snapshot creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the snapshot_name -snapshot of the vg_name -/origin_name -LV -was successfully created or not.

-

Tech category: BD_LVM_TECH_BASIC_SNAP-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_lvsnapshotmerge ()

-
gboolean
-bd_lvm_lvsnapshotmerge (const gchar *vg_name,
-                        const gchar *snapshot_name,
-                        const BDExtraArg **extra,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-merged LV snapshot

 

snapshot_name

name of the to-be-merged LV snapshot

 

extra

extra options for the LV snapshot merge -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/snapshot_name -LV snapshot was successfully merged or not

-

Tech category: BD_LVM_TECH_BASIC_SNAP-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_add_lv_tags ()

-
gboolean
-bd_lvm_add_lv_tags (const gchar *vg_name,
-                    const gchar *lv_name,
-                    const gchar **tags,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains the LV to set tags on

 

lv_name

name of the LV to set tags on

 

tags

list of tags to add.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully added to device -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_delete_lv_tags ()

-
gboolean
-bd_lvm_delete_lv_tags (const gchar *vg_name,
-                       const gchar *lv_name,
-                       const gchar **tags,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains the LV to set tags on

 

lv_name

name of the LV to set tags on

 

tags

list of tags to remove.

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the tags were successfully removed from device -or not

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_lvinfo ()

-
BDLVMLVdata *
-bd_lvm_lvinfo (const gchar *vg_name,
-               const gchar *lv_name,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains the LV to get information about

 

lv_name

name of the LV to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the vg_name -/lv_name -LV or NULL in case -of error (the error -) gets populated in those cases)

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_lvinfo_tree ()

-
BDLVMLVdata *
-bd_lvm_lvinfo_tree (const gchar *vg_name,
-                    const gchar *lv_name,
-                    GError **error);
-

This function will fill out the data_lvs, metadata_lvs, and segs fields as well.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains the LV to get information about

 

lv_name

name of the LV to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the vg_name -/lv_name -LV or NULL in case -of error (the error -) gets populated in those cases)

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_lvs ()

-
BDLVMLVdata **
-bd_lvm_lvs (const gchar *vg_name,
-            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

vg_name

name of the VG to get information about LVs from.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about LVs found in the given -vg_name -VG or in system if vg_name -is NULL

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_lvm_lvs_tree ()

-
BDLVMLVdata **
-bd_lvm_lvs_tree (const gchar *vg_name,
-                 GError **error);
-

This function will fill out the data_lvs, metadata_lvs, and segs fields as well.

-
-

Parameters

-
----- - - - - - - - - - - - - -

vg_name

name of the VG to get information about LVs from.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about LVs found in the given -vg_name -VG or in system if vg_name -is NULL.

-

Tech category: BD_LVM_TECH_BASIC-BD_LVM_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_lvm_thpoolcreate ()

-
gboolean
-bd_lvm_thpoolcreate (const gchar *vg_name,
-                     const gchar *lv_name,
-                     guint64 size,
-                     guint64 md_size,
-                     guint64 chunk_size,
-                     const gchar *profile,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create a thin pool in

 

lv_name

name of the to-be-created pool LV

 

size

requested size of the to-be-created pool

 

md_size

requested metadata size or 0 to use the default

 

chunk_size

requested chunk size or 0 to use the default

 

profile

profile to use (see lvm(8) for more information) or NULL to use -the default.

[nullable]

extra

extra options for the thin pool creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -thin pool was successfully created or not

-

Tech category: BD_LVM_TECH_THIN-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_thpool_convert ()

-
gboolean
-bd_lvm_thpool_convert (const gchar *vg_name,
-                       const gchar *data_lv,
-                       const gchar *metadata_lv,
-                       const gchar *name,
-                       const BDExtraArg **extra,
-                       GError **error);
-

Converts the data_lv - and metadata_lv - into a new thin pool in the vg_name - -VG.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create the new thin pool in

 

data_lv

name of the LV that should become the data part of the new pool

 

metadata_lv

name of the LV that should become the metadata part of the new pool

 

name

name for the thin pool (if NULL, the name data_lv -is inherited).

[nullable]

extra

extra options for the thin pool creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new thin pool was successfully created from data_lv -and -metadata_lv -or not

-

Tech category: BD_LVM_TECH_THIN-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_thlvcreate ()

-
gboolean
-bd_lvm_thlvcreate (const gchar *vg_name,
-                   const gchar *pool_name,
-                   const gchar *lv_name,
-                   guint64 size,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the thin pool providing extents for the to-be-created thin LV

 

pool_name

name of the pool LV providing extents for the to-be-created thin LV

 

lv_name

name of the to-be-created thin LV

 

size

requested virtual size of the to-be-created thin LV

 

extra

extra options for the thin LV creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -thin LV was successfully created or not

-

Tech category: BD_LVM_TECH_THIN-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_thlvpoolname ()

-
gchar *
-bd_lvm_thlvpoolname (const gchar *vg_name,
-                     const gchar *lv_name,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the queried thin LV

 

lv_name

name of the queried thin LV

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

the name of the pool volume for the vg_name -/lv_name -thin LV or NULL if failed to determine (error -) is set in those cases)

-

Tech category: BD_LVM_TECH_THIN-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_thsnapshotcreate ()

-
gboolean
-bd_lvm_thsnapshotcreate (const gchar *vg_name,
-                         const gchar *origin_name,
-                         const gchar *snapshot_name,
-                         const gchar *pool_name,
-                         const BDExtraArg **extra,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the thin LV a new snapshot should be created of

 

origin_name

name of the thin LV a new snapshot should be created of

 

snapshot_name

name fo the to-be-created snapshot

 

pool_name

name of the thin pool to create the snapshot in or NULL if not specified.

[nullable]

extra

extra options for the thin LV snapshot creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the snapshot_name -snapshot of the vg_name -/origin_name -thin LV was successfully created or not.

-

Tech category: BD_LVM_TECH_THIN-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_set_global_config ()

-
gboolean
-bd_lvm_set_global_config (const gchar *new_config,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

new_config

string representation of the new global LVM -configuration to set or NULL to reset to default.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new requested global config new_config -was successfully -set or not

-

Tech category: BD_LVM_TECH_GLOB_CONF no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_global_config ()

-
gchar *
-bd_lvm_get_global_config (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a copy of a string representation of the currently set LVM global -configuration

-

Tech category: BD_LVM_TECH_GLOB_CONF no mode (it is ignored)

-
-
-
-
-

bd_lvm_cache_attach ()

-
gboolean
-bd_lvm_cache_attach (const gchar *vg_name,
-                     const gchar *data_lv,
-                     const gchar *cache_pool_lv,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the data_lv -and the cache_pool_lv -LVs

 

data_lv

data LV to attache the cache_pool_lv -to

 

cache_pool_lv

cache pool LV to attach to the data_lv -

 

extra

extra options for the cache attachment -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cache_pool_lv -was successfully attached to the data_lv -or not

-

Note: Both data_lv -and cache_lv -will be deactivated before the operation.

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_cache_create_cached_lv ()

-
gboolean
-bd_lvm_cache_create_cached_lv (const gchar *vg_name,
-                               const gchar *lv_name,
-                               guint64 data_size,
-                               guint64 cache_size,
-                               guint64 md_size,
-                               BDLVMCacheMode mode,
-                               BDLVMCachePoolFlags flags,
-                               const gchar **slow_pvs,
-                               const gchar **fast_pvs,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create a cached LV in

 

lv_name

name of the cached LV to create

 

data_size

size of the data LV

 

cache_size

size of the cache (or cached LV more precisely)

 

md_size

size of the cache metadata LV or 0 to use the default

 

mode

cache mode for the cached LV

 

flags

a combination of (ORed) BDLVMCachePoolFlags

 

slow_pvs

list of slow PVs (used for the data LV).

[array zero-terminated=1]

fast_pvs

list of fast PVs (used for the cache LV).

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cached LV lv_name -was successfully created or not

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_cache_create_pool ()

-
gboolean
-bd_lvm_cache_create_pool (const gchar *vg_name,
-                          const gchar *pool_name,
-                          guint64 pool_size,
-                          guint64 md_size,
-                          BDLVMCacheMode mode,
-                          BDLVMCachePoolFlags flags,
-                          const gchar **fast_pvs,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create pool_name -in

 

pool_name

name of the cache pool LV to create

 

pool_size

desired size of the cache pool pool_name -

 

md_size

desired size of the pool_name -cache pool's metadata LV or 0 to -use the default

 

mode

cache mode of the pool_name -cache pool

 

flags

a combination of (ORed) BDLVMCachePoolFlags

 

fast_pvs

list of (fast) PVs to create the pool_name -cache pool (and the metadata LV).

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cache pool vg_name -/pool_name -was successfully created or not

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_cache_pool_convert ()

-
gboolean
-bd_lvm_cache_pool_convert (const gchar *vg_name,
-                           const gchar *data_lv,
-                           const gchar *metadata_lv,
-                           const gchar *name,
-                           const BDExtraArg **extra,
-                           GError **error);
-

Converts the data_lv - and metadata_lv - into a new cache pool in the vg_name - -VG.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create the new thin pool in

 

data_lv

name of the LV that should become the data part of the new pool

 

metadata_lv

name of the LV that should become the metadata part of the new pool

 

name

name for the thin pool (if NULL, the name data_lv -is inherited).

[nullable]

extra

extra options for the thin pool creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new cache pool was successfully created from data_lv -and -metadata_lv -or not

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_cache_detach ()

-
gboolean
-bd_lvm_cache_detach (const gchar *vg_name,
-                     const gchar *cached_lv,
-                     gboolean destroy,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the cached_lv -

 

cached_lv

name of the cached LV to detach its cache from

 

destroy

whether to destroy the cache after detach or not

 

extra

extra options for the cache detachment -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cache was successfully detached from the cached_lv -or not

-

Note: synces the cache first

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_cache_get_default_md_size ()

-
guint64
-bd_lvm_cache_get_default_md_size (guint64 cache_size,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

cache_size

size of the cache to determine MD size for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

recommended default size of the cache metadata LV or 0 in case of error

-

Tech category: BD_LVM_TECH_CACHE_CALCS no mode (it is ignored)

-
-
-
-
-

bd_lvm_cache_get_mode_from_str ()

-
BDLVMCacheMode
-bd_lvm_cache_get_mode_from_str (const gchar *mode_str,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode_str

string representation of a cache mode

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

cache mode for the mode_str -or BD_LVM_CACHE_MODE_UNKNOWN if -failed to determine

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_cache_get_mode_str ()

-
const gchar *
-bd_lvm_cache_get_mode_str (BDLVMCacheMode mode,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode

mode to get the string representation for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of mode -or NULL in case of error

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_cache_pool_name ()

-
gchar *
-bd_lvm_cache_pool_name (const gchar *vg_name,
-                        const gchar *cached_lv,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the cached_lv -

 

cached_lv

cached LV to get the name of the its pool LV for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

name of the cache pool LV used by the cached_lv -or NULL in case of error

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_cache_stats ()

-
BDLVMCacheStats *
-bd_lvm_cache_stats (const gchar *vg_name,
-                    const gchar *cached_lv,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the cached_lv -

 

cached_lv

cached LV to get stats for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

stats for the cached_lv -or NULL in case of error

-

Tech category: BD_LVM_TECH_CACHE-BD_LVM_TECH_MODE_QUERY

-
-
-
-
-

bd_lvm_vdolvpoolname ()

-
gchar *
-bd_lvm_vdolvpoolname (const gchar *vg_name,
-                      const gchar *lv_name,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the queried VDO LV

 

lv_name

name of the queried VDO LV

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

the name of the pool volume for the vg_name -/lv_name -VDO LV or NULL if failed to determine (error -) is set in those cases)

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_get_vdo_operating_mode_str ()

-
const gchar *
-bd_lvm_get_vdo_operating_mode_str (BDLVMVDOOperatingMode mode,
-                                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode

mode to get the string representation for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of mode -or NULL in case of error

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_get_vdo_compression_state_str ()

-
const gchar *
-bd_lvm_get_vdo_compression_state_str (BDLVMVDOCompressionState state,
-                                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

state

state to get the string representation for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of state -or NULL in case of error

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_get_vdo_index_state_str ()

-
const gchar *
-bd_lvm_get_vdo_index_state_str (BDLVMVDOIndexState state,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

state

state to get the string representation for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of state -or NULL in case of error

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_get_vdo_write_policy_from_str ()

-
BDLVMVDOWritePolicy
-bd_lvm_get_vdo_write_policy_from_str (const gchar *policy_str,
-                                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

policy_str

string representation of a policy

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

write policy for the policy_str -or BD_LVM_VDO_WRITE_POLICY_UNKNOWN if -failed to determine

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_vdo_get_stats ()

-
BDLVMVDOStats *
-bd_lvm_vdo_get_stats (const gchar *vg_name,
-                      const gchar *pool_name,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains pool_name -VDO pool

 

pool_name

name of the VDO pool to get statistics for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a structure containing selected statistics or NULL in case of error -(error -gets populated in those cases)

-

In contrast to bd_lvm_vdo_get_stats_full -this function will only return selected statistics -in a fixed structure. In case a value is not available, -1 would be returned.

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_vdo_get_stats_full ()

-
GHashTable *
-bd_lvm_vdo_get_stats_full (const gchar *vg_name,
-                           const gchar *pool_name,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains pool_name -VDO pool

 

pool_name

name of the VDO pool to get statistics for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

hashtable of type string - string of available -statistics or NULL in case of error -(error -gets populated in those cases)

-

Statistics are collected from the values exposed by the kernel kvdo module -at the /sys/kvdo/&lt;VDO_NAME>/statistics/ path. -Some of the keys are computed to mimic the information produced by the vdo tools. -Please note the contents of the hashtable may vary depending on the actual kvdo module version.

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_QUERY.

-

[transfer full][element-type utf8 utf8]

-
-
-
-
-

bd_lvm_vdo_disable_compression ()

-
gboolean
-bd_lvm_vdo_disable_compression (const gchar *vg_name,
-                                const gchar *pool_name,
-                                const BDExtraArg **extra,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-changed VDO pool LV

 

pool_name

name of the VDO pool LV to disable compression on

 

extra

extra options for the VDO change -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether compression was successfully disabled on vg_name -/pool_name -LV or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_disable_deduplication ()

-
gboolean
-bd_lvm_vdo_disable_deduplication (const gchar *vg_name,
-                                  const gchar *pool_name,
-                                  const BDExtraArg **extra,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-changed VDO pool LV

 

pool_name

name of the VDO pool LV to disable deduplication on

 

extra

extra options for the VDO change -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether deduplication was successfully disabled on vg_name -/pool_name -LV or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_enable_compression ()

-
gboolean
-bd_lvm_vdo_enable_compression (const gchar *vg_name,
-                               const gchar *pool_name,
-                               const BDExtraArg **extra,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-changed VDO pool LV

 

pool_name

name of the VDO pool LV to enable compression on

 

extra

extra options for the VDO change -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether compression was successfully enabled on vg_name -/pool_name -LV or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_enable_deduplication ()

-
gboolean
-bd_lvm_vdo_enable_deduplication (const gchar *vg_name,
-                                 const gchar *pool_name,
-                                 const BDExtraArg **extra,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-changed VDO pool LV

 

pool_name

name of the VDO pool LV to enable deduplication on

 

extra

extra options for the VDO change -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether deduplication was successfully enabled on vg_name -/pool_name -LV or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_info ()

-
BDLVMVDOPooldata *
-bd_lvm_vdo_info (const gchar *vg_name,
-                 const gchar *lv_name,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains the LV to get information about

 

lv_name

name of the LV to get information about

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the vg_name -/lv_name -LV or NULL in case -of error (the error -) gets populated in those cases)

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_lvm_vdo_pool_convert ()

-
gboolean
-bd_lvm_vdo_pool_convert (const gchar *vg_name,
-                         const gchar *pool_lv,
-                         const gchar *name,
-                         guint64 virtual_size,
-                         guint64 index_memory,
-                         gboolean compression,
-                         gboolean deduplication,
-                         BDLVMVDOWritePolicy write_policy,
-                         const BDExtraArg **extra,
-                         GError **error);
-

Converts the pool_lv - into a new VDO pool LV in the vg_name - VG and creates a new -name - VDO LV with size virtual_size -.

-

Note: All data on pool_lv - will be irreversibly destroyed.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG that contains pool_lv -

 

pool_lv

name of the LV that should become the new VDO pool LV

 

name

name for the VDO LV or NULL for default name.

[nullable]

virtual_size

virtual size for the new VDO LV

 

index_memory

amount of index memory (in bytes) or 0 for default

 

compression

whether to enable compression or not

 

deduplication

whether to enable deduplication or not

 

write_policy

write policy for the volume

 

extra

extra options for the VDO pool creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new VDO pool LV was successfully created from pool_lv -and or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_CREATE&BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_pool_create ()

-
gboolean
-bd_lvm_vdo_pool_create (const gchar *vg_name,
-                        const gchar *lv_name,
-                        const gchar *pool_name,
-                        guint64 data_size,
-                        guint64 virtual_size,
-                        guint64 index_memory,
-                        gboolean compression,
-                        gboolean deduplication,
-                        BDLVMVDOWritePolicy write_policy,
-                        const BDExtraArg **extra,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create a new LV in

 

lv_name

name of the to-be-created VDO LV

 

pool_name

name of the to-be-created VDO pool LV or NULL for default name.

[nullable]

data_size

requested size of the data VDO LV (physical size of the pool_name -VDO pool LV)

 

virtual_size

requested virtual_size of the lv_name -VDO LV

 

index_memory

amount of index memory (in bytes) or 0 for default

 

compression

whether to enable compression or not

 

deduplication

whether to enable deduplication or not

 

write_policy

write policy for the volume

 

extra

extra options for the VDO LV creation -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the given vg_name -/lv_name -VDO LV was successfully created or not

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_vdo_pool_resize ()

-
gboolean
-bd_lvm_vdo_pool_resize (const gchar *vg_name,
-                        const gchar *pool_name,
-                        guint64 size,
-                        const BDExtraArg **extra,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-resized VDO pool LV

 

pool_name

name of the to-be-resized VDO pool LV

 

size

the requested new size of the VDO pool LV

 

extra

extra options for the VDO pool LV resize -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/pool_name -VDO pool LV was successfully resized or not

-

Note: Size of the VDO pool LV can be only extended, not reduced.

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdo_resize ()

-
gboolean
-bd_lvm_vdo_resize (const gchar *vg_name,
-                   const gchar *lv_name,
-                   guint64 size,
-                   const BDExtraArg **extra,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the to-be-resized VDO LV

 

lv_name

name of the to-be-resized VDO LV

 

size

the requested new size of the VDO LV

 

extra

extra options for the VDO LV resize -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the vg_name -/lv_name -VDO LV was successfully resized or not

-

Note: Reduction needs to process TRIM for reduced disk area to unmap used data blocks -from the VDO pool LV and it may take a long time.

-

Tech category: BD_LVM_TECH_VDO-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_vdopooldata_copy ()

-
BDLVMVDOPooldata *
-bd_lvm_vdopooldata_copy (BDLVMVDOPooldata *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMVDOPooldata to copy.

[nullable]
-
-
-
-
-

bd_lvm_vdopooldata_free ()

-
void
-bd_lvm_vdopooldata_free (BDLVMVDOPooldata *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDLVMVDOPooldata to free.

[nullable]
-
-
-
-
-

bd_lvm_devices_add ()

-
gboolean
-bd_lvm_devices_add (const gchar *device,
-                    const gchar *devices_file,
-                    const BDExtraArg **extra,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device (PV) to add to the devices file

 

devices_file

LVM devices file or NULL for default.

[nullable]

extra

extra options for the lvmdevices command.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully added to devices_file -or not

-

Tech category: BD_LVM_TECH_DEVICES no mode (it is ignored)

-
-
-
-
-

bd_lvm_devices_delete ()

-
gboolean
-bd_lvm_devices_delete (const gchar *device,
-                       const gchar *devices_file,
-                       const BDExtraArg **extra,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

device (PV) to delete from the devices file

 

devices_file

LVM devices file or NULL for default.

[nullable]

extra

extra options for the lvmdevices command.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully removed from devices_file -or not

-

Tech category: BD_LVM_TECH_DEVICES no mode (it is ignored)

-
-
-
-
-

bd_lvm_get_devices_filter ()

-
gchar **
-bd_lvm_get_devices_filter (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a copy of a string representation of -the currently set LVM devices filter

-

Tech category: BD_LVM_TECH_DEVICES no mode (it is ignored).

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_lvm_get_vdo_write_policy_str ()

-
const gchar *
-bd_lvm_get_vdo_write_policy_str (BDLVMVDOWritePolicy policy,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

policy

policy to get the string representation for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of policy -or NULL in case of error

-

Tech category: always provided/supported

-
-
-
-
-

bd_lvm_set_devices_filter ()

-
gboolean
-bd_lvm_set_devices_filter (const gchar **devices,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

devices

list of devices for lvm commands to work on.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the devices filter was successfully set or not

-

Tech category: BD_LVM_TECH_DEVICES no mode (it is ignored)

-
-
-
-
-

bd_lvm_writecache_attach ()

-
gboolean
-bd_lvm_writecache_attach (const gchar *vg_name,
-                          const gchar *data_lv,
-                          const gchar *cache_lv,
-                          const BDExtraArg **extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the data_lv -and the cache_pool_lv -LVs

 

data_lv

data LV to attach the cache_lv -to

 

cache_lv

cache (fast) LV to attach to the data_lv -

 

extra

extra options for the cache attachment -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cache_lv -was successfully attached to the data_lv -or not

-

Tech category: BD_LVM_TECH_WRITECACHE-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_writecache_create_cached_lv ()

-
gboolean
-bd_lvm_writecache_create_cached_lv (const gchar *vg_name,
-                                    const gchar *lv_name,
-                                    guint64 data_size,
-                                    guint64 cache_size,
-                                    const gchar **slow_pvs,
-                                    const gchar **fast_pvs,
-                                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG to create a cached LV in

 

lv_name

name of the cached LV to create

 

data_size

size of the data LV

 

cache_size

size of the cache (or cached LV more precisely)

 

slow_pvs

list of slow PVs (used for the data LV).

[array zero-terminated=1]

fast_pvs

list of fast PVs (used for the cache LV).

[array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cached LV lv_name -was successfully created or not

-

Tech category: BD_LVM_TECH_WRITECACHE-BD_LVM_TECH_MODE_CREATE

-
-
-
-
-

bd_lvm_writecache_detach ()

-
gboolean
-bd_lvm_writecache_detach (const gchar *vg_name,
-                          const gchar *cached_lv,
-                          gboolean destroy,
-                          const BDExtraArg **extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vg_name

name of the VG containing the cached_lv -

 

cached_lv

name of the cached LV to detach its cache from

 

destroy

whether to destroy the cache after detach or not

 

extra

extra options for the cache detachment -(just passed to LVM as is).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the cache was successfully detached from the cached_lv -or not

-

Note: synces the cache first

-

Tech category: BD_LVM_TECH_WRITECACHE-BD_LVM_TECH_MODE_MODIFY

-
-
-
-
-

bd_lvm_is_tech_avail ()

-
gboolean
-bd_lvm_is_tech_avail (BDLVMTech tech,
-                      guint64 mode,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDLVMTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_LVM_DEFAULT_PE_SIZE

-
#define             BD_LVM_DEFAULT_PE_SIZE
-
-
-
-

BD_LVM_DEFAULT_PE_START

-
#define             BD_LVM_DEFAULT_PE_START
-
-
-
-

BD_LVM_MIN_PE_SIZE

-
#define             BD_LVM_MIN_PE_SIZE
-
-
-
-

BD_LVM_MAX_PE_SIZE

-
#define             BD_LVM_MAX_PE_SIZE
-
-
-
-

BD_LVM_MIN_THPOOL_MD_SIZE

-
#define             BD_LVM_MIN_THPOOL_MD_SIZE
-
-
-
-

BD_LVM_MAX_THPOOL_MD_SIZE

-
#define             BD_LVM_MAX_THPOOL_MD_SIZE
-
-
-
-

BD_LVM_MIN_THPOOL_CHUNK_SIZE

-
#define             BD_LVM_MIN_THPOOL_CHUNK_SIZE
-
-
-
-

BD_LVM_MAX_THPOOL_CHUNK_SIZE

-
#define             BD_LVM_MAX_THPOOL_CHUNK_SIZE
-
-
-
-

BD_LVM_MIN_CACHE_MD_SIZE

-
#define             BD_LVM_MIN_CACHE_MD_SIZE
-
-
-
-

BD_LVM_DEFAULT_CHUNK_SIZE

-
#define             BD_LVM_DEFAULT_CHUNK_SIZE
-
-
-
-

BD_LVM_ERROR

-
#define             BD_LVM_ERROR
-
-
-
-

enum BDLVMError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_ERROR_PARSE

  

BD_LVM_ERROR_NOEXIST

  

BD_LVM_ERROR_DM_ERROR

  

BD_LVM_ERROR_NOT_ROOT

  

BD_LVM_ERROR_CACHE_INVAL

  

BD_LVM_ERROR_CACHE_NOCACHE

  

BD_LVM_ERROR_TECH_UNAVAIL

  

BD_LVM_ERROR_FAIL

  

BD_LVM_ERROR_NOT_SUPPORTED

  

BD_LVM_ERROR_VDO_POLICY_INVAL

  

BD_LVM_ERROR_DEVICES_DISABLED

  
-
-
-
-
-

BDLVMPVdata

-
typedef struct {
-    gchar *pv_name;
-    gchar *pv_uuid;
-    guint64 pv_free;
-    guint64 pv_size;
-    guint64 pe_start;
-    gchar *vg_name;
-    gchar *vg_uuid;
-    guint64 vg_size;
-    guint64 vg_free;
-    guint64 vg_extent_size;
-    guint64 vg_extent_count;
-    guint64 vg_free_count;
-    guint64 vg_pv_count;
-    gchar **pv_tags;
-    gboolean missing;
-} BDLVMPVdata;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *pv_name;

name of the PV

 

gchar *pv_uuid;

UUID of the PV

 

guint64 pv_free;

size of the free space in the PV

 

guint64 pv_size;

size of the PV

 

guint64 pe_start;

start of the physical extents area (i.e. offset of the first PE)

 

gchar *vg_name;

name of the VG the PV belongs to

 

gchar *vg_uuid;

UUID of the VG the PV belongs to

 

guint64 vg_size;

size of the VG the PV belongs to

 

guint64 vg_free;

size of the free space in the PV's VG

 

guint64 vg_extent_size;

extent size used by the PV's VG

 

guint64 vg_extent_count;

number of extents in the PV's VG

 

guint64 vg_free_count;

number of free extents in the PV's VG

 

guint64 vg_pv_count;

number of PVs that belong to this PV's VG

 

gchar **pv_tags;

list of LVM tags for this PV.

[array zero-terminated=1]

gboolean missing;

whether this PV is missing from the system or not

 
-
-
-
-
-

BDLVMVGdata

-
typedef struct {
-    gchar *name;
-    gchar *uuid;
-    guint64 size;
-    guint64 free;
-    guint64 extent_size;
-    guint64 extent_count;
-    guint64 free_count;
-    guint64 pv_count;
-    gboolean exported;
-    gchar **vg_tags;
-} BDLVMVGdata;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *name;

name of the VG

 

gchar *uuid;

UUID of the VG

 

guint64 size;

size of the VG

 

guint64 free;

size of the free space in the VG

 

guint64 extent_size;

extent size used by the VG

 

guint64 extent_count;

number of extents in the VG

 

guint64 free_count;

number of free extents in the VG

 

guint64 pv_count;

number of PVs that belong to the VG

 

gboolean exported;

whether the VG is exported or not

 

gchar **vg_tags;

list of LVM tags for this VG.

[array zero-terminated=1]
-
-
-
-
-

BDLVMSEGdata

-
typedef struct {
-    guint64 size_pe;
-    guint64 pv_start_pe;
-    gchar *pvdev;
-} BDLVMSEGdata;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

guint64 size_pe;

Size of this segment in extents

 

guint64 pv_start_pe;

Where it starts in the physical volume in extents

 

gchar *pvdev;

Device name of the physical volume or NULL

 
-
-
-
-
-

BDLVMLVdata

-
typedef struct {
-    gchar *lv_name;
-    gchar *vg_name;
-    gchar *uuid;
-    guint64 size;
-    gchar *attr;
-    gchar *segtype;
-    gchar *origin;
-    gchar *pool_lv;
-    gchar *data_lv;
-    gchar *metadata_lv;
-    gchar *roles;
-    gchar *move_pv;
-    guint64 data_percent;
-    guint64 metadata_percent;
-    guint64 copy_percent;
-    gchar **lv_tags;
-    gchar **data_lvs;
-    gchar **metadata_lvs;
-    BDLVMSEGdata **segs;
-} BDLVMLVdata;
-
-

The segs -, data_lvs -, and metadata_lvs - fields are only filled by a -call to bd_lvm_lvinfo_tree or bd_lvm_lvs_tree. They are all NULL -normally. If they are filled, they follow these rules:

-

A LV is either stored directly on physical volumes, or is made up -of sub-LVs. If it is stored on PVs, the segs - list is non-empty -and the data_lvs - and metadata_lvs - fields are both NULL. If it is -made up of sub-LVs, then segs - is NULL, data_lvs - is non-empty and -metadata_lvs - might or might not be empty but is non-NULL. The -sub-LVs contained in data_lv - and metadata_lv - are always included -in data_lvs - and metadata_lvs -, respectively.

-

For a partial LV, the segs - list might not be complete; i.e., the -sum of the sizes of the listed segments might not be equal to the -size reported for the LV itself.

-

Also, the order of entries in segs - must be assumed to be random; -it does not correspond to the order of segements in the logical -volume itself.

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *lv_name;

name of the LV

 

gchar *vg_name;

name of the VG the LV belongs to

 

gchar *uuid;

UUID of the LV

 

guint64 size;

size of the LV

 

gchar *attr;

attributes of the LV

 

gchar *segtype;

segment type of the LV

 

gchar *origin;

origin of the LV (for snapshots, etc.)

 

gchar *pool_lv;

pool LV of the LV (for thin and cached LVs)

 

gchar *data_lv;

data LV of the LV (for thin and cache pools)

 

gchar *metadata_lv;

metadata LV of the LV (for thin and cache pools)

 

gchar *roles;

comma separated list of this LV's roles

 

gchar *move_pv;

source physical volume of a temporary logical volume created with the pvmove command

 

guint64 data_percent;

available data space in a thin pool

 

guint64 metadata_percent;

available metadata space in a thin pool

 

guint64 copy_percent;

synchronization percentage of a mirrored logical volume

 

gchar **lv_tags;

list of LVM tags for this LV.

[array zero-terminated=1]

gchar **data_lvs;

list of data sub-LVs this LV (for raids, etc).

[nullable][array zero-terminated=1]

gchar **metadata_lvs;

list of metadata sub-LVS for this LV (for raids, etc).

[nullable][array zero-terminated=1]

BDLVMSEGdata **segs;

The segments of this LV.

[nullable][array zero-terminated=1]
-
-
-
-
-

enum BDLVMCacheMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_LVM_CACHE_MODE_WRITETHROUGH

  

BD_LVM_CACHE_MODE_WRITEBACK

  

BD_LVM_CACHE_MODE_UNKNOWN

  
-
-
-
-
-

enum BDLVMCachePoolFlags

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_CACHE_POOL_STRIPED

  

BD_LVM_CACHE_POOL_RAID1

  

BD_LVM_CACHE_POOL_RAID5

  

BD_LVM_CACHE_POOL_RAID6

  

BD_LVM_CACHE_POOL_RAID10

  

BD_LVM_CACHE_POOL_META_STRIPED

  

BD_LVM_CACHE_POOL_META_RAID1

  

BD_LVM_CACHE_POOL_META_RAID5

  

BD_LVM_CACHE_POOL_META_RAID6

  

BD_LVM_CACHE_POOL_META_RAID10

  
-
-
-
-
-

BDLVMCacheStats

-
typedef struct {
-    guint64 block_size;
-    guint64 cache_size;
-    guint64 cache_used;
-    guint64 md_block_size;
-    guint64 md_size;
-    guint64 md_used;
-    guint64 read_hits;
-    guint64 read_misses;
-    guint64 write_hits;
-    guint64 write_misses;
-    BDLVMCacheMode mode;
-} BDLVMCacheStats;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint64 block_size;

block size used by the cache

 

guint64 cache_size;

size of the cache

 

guint64 cache_used;

size of the used space in the cache

 

guint64 md_block_size;

block size used for cache metadata

 

guint64 md_size;

size of the metadata space of the cache

 

guint64 md_used;

size of the used metadata space in the cache

 

guint64 read_hits;

number of read hits

 

guint64 read_misses;

number of read misses

 

guint64 write_hits;

number of write hits

 

guint64 write_misses;

number of write misses

 

BDLVMCacheMode mode;

mode the cache is operating in

 
-
-
-
-
-

BDLVMVDOStats

-
typedef struct {
-    gint64 block_size;
-    gint64 logical_block_size;
-    gint64 physical_blocks;
-    gint64 data_blocks_used;
-    gint64 overhead_blocks_used;
-    gint64 logical_blocks_used;
-    gint64 used_percent;
-    gint64 saving_percent;
-    gdouble write_amplification_ratio;
-} BDLVMVDOStats;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gint64 block_size;

The block size of a VDO volume, in bytes.

 

gint64 logical_block_size;

The logical block size, in bytes.

 

gint64 physical_blocks;

The total number of physical blocks allocated for a VDO volume.

 

gint64 data_blocks_used;

The number of physical blocks currently in use by a VDO volume -to store data.

 

gint64 overhead_blocks_used;

The number of physical blocks currently in use by a VDO volume -to store VDO metadata.

 

gint64 logical_blocks_used;

The number of logical blocks currently mapped.

 

gint64 used_percent;

The percentage of physical blocks used on a VDO volume -(= used blocks / allocated blocks * 100).

 

gint64 saving_percent;

The percentage of physical blocks saved on a VDO volume -(= [logical blocks used - physical blocks used] / logical blocks used).

 

gdouble write_amplification_ratio;

The average number of block writes to the underlying storage -per block written to the VDO device.

 
-
-
-
-
-

enum BDLVMVDOCompressionState

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_LVM_VDO_COMPRESSION_ONLINE

  

BD_LVM_VDO_COMPRESSION_OFFLINE

  

BD_LVM_VDO_COMPRESSION_UNKNOWN

  
-
-
-
-
-

enum BDLVMVDOIndexState

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_VDO_INDEX_ERROR

  

BD_LVM_VDO_INDEX_CLOSED

  

BD_LVM_VDO_INDEX_OPENING

  

BD_LVM_VDO_INDEX_CLOSING

  

BD_LVM_VDO_INDEX_OFFLINE

  

BD_LVM_VDO_INDEX_ONLINE

  

BD_LVM_VDO_INDEX_UNKNOWN

  
-
-
-
-
-

enum BDLVMVDOOperatingMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_VDO_MODE_RECOVERING

  

BD_LVM_VDO_MODE_READ_ONLY

  

BD_LVM_VDO_MODE_NORMAL

  

BD_LVM_VDO_MODE_UNKNOWN

  
-
-
-
-
-

BDLVMVDOPooldata

-
typedef struct {
-    BDLVMVDOOperatingMode operating_mode;
-    BDLVMVDOCompressionState compression_state;
-    BDLVMVDOIndexState index_state;
-    BDLVMVDOWritePolicy write_policy;
-    guint64 used_size;
-    gint32 saving_percent;
-    guint64 index_memory_size;
-    gboolean deduplication;
-    gboolean compression;
-} BDLVMVDOPooldata;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BDLVMVDOOperatingMode operating_mode;

operating mode of the VDO pool (e.g. BD_LVM_VDO_MODE_NORMAL)

 

BDLVMVDOCompressionState compression_state;

state of the compression

 

BDLVMVDOIndexState index_state;

state of the VDO index

 

BDLVMVDOWritePolicy write_policy;

write policy of the VDO LV

 

guint64 used_size;

currently used space

 

gint32 saving_percent;

percentage of physical blocks saved

 

guint64 index_memory_size;

index memory size of the VDO volume

 

gboolean deduplication;

whether deduplication is enabled

 

gboolean compression;

whether compression is enabled

 
-
-
-
-
-

enum BDLVMVDOWritePolicy

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_VDO_WRITE_POLICY_AUTO

  

BD_LVM_VDO_WRITE_POLICY_SYNC

  

BD_LVM_VDO_WRITE_POLICY_ASYNC

  

BD_LVM_VDO_WRITE_POLICY_UNKNOWN

  
-
-
-
-
-

enum BDLVMTech

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_TECH_BASIC

  

BD_LVM_TECH_BASIC_SNAP

  

BD_LVM_TECH_THIN

  

BD_LVM_TECH_CACHE

  

BD_LVM_TECH_CALCS

  

BD_LVM_TECH_THIN_CALCS

  

BD_LVM_TECH_CACHE_CALCS

  

BD_LVM_TECH_GLOB_CONF

  

BD_LVM_TECH_VDO

  

BD_LVM_TECH_WRITECACHE

  

BD_LVM_TECH_DEVICES

  
-
-
-
-
-

enum BDLVMTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_LVM_TECH_MODE_CREATE

  

BD_LVM_TECH_MODE_REMOVE

  

BD_LVM_TECH_MODE_MODIFY

  

BD_LVM_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Loop.html b/libblockdev/docs/3.0/libblockdev-Loop.html deleted file mode 100644 index 67f9371..0000000 --- a/libblockdev/docs/3.0/libblockdev-Loop.html +++ /dev/null @@ -1,672 +0,0 @@ - - - - -Loop: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Loop

-

Loop — plugin for operations with loop devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_loop_check_deps () -
-gboolean - -bd_loop_init () -
-void - -bd_loop_close () -
-GQuark - -bd_loop_error_quark () -
-gchar * - -bd_loop_get_backing_file () -
-gchar * - -bd_loop_get_loop_name () -
-gboolean - -bd_loop_setup () -
-gboolean - -bd_loop_setup_from_fd () -
-gboolean - -bd_loop_teardown () -
-gboolean - -bd_loop_get_autoclear () -
-gboolean - -bd_loop_set_autoclear () -
-gboolean - -bd_loop_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - -
#defineBD_LOOP_ERROR
enumBDLoopError
enumBDLoopTech
enumBDLoopTechMode
-
-
-

Includes

-
#include <loop.h>
-
-
-
-

Description

-

A plugin for operations with loop devices. All sizes passed -in/out to/from the functions are in bytes.

-
-
-

Functions

-
-

bd_loop_check_deps ()

-
gboolean
-bd_loop_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_loop_init ()

-
gboolean
-bd_loop_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_loop_close ()

-
void
-bd_loop_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_loop_error_quark ()

-
GQuark
-bd_loop_error_quark (void);
-

[skip]

-
-
-
-

bd_loop_get_backing_file ()

-
gchar *
-bd_loop_get_backing_file (const gchar *dev_name,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dev_name

name of the loop device to get backing file for (e.g. "loop0")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

path of the device's backing file or NULL if none -is found

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_loop_get_loop_name ()

-
gchar *
-bd_loop_get_loop_name (const gchar *file,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

file

path of the backing file to get loop name for

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

name of the loop device associated with the given file -

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_loop_setup ()

-
gboolean
-bd_loop_setup (const gchar *file,
-               guint64 offset,
-               guint64 size,
-               gboolean read_only,
-               gboolean part_scan,
-               const gchar **loop_name,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

file

file to setup as a loop device

 

offset

offset of the start of the device (in file -)

 

size

maximum size of the device (or 0 to leave unspecified)

 

read_only

whether to setup as read-only (TRUE) or read-write (FALSE)

 

part_scan

whether to enforce partition scan on the newly created device or not

 

loop_name

if not NULL, it is used to store the name of the loop device.

[optional][out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the file -was successfully setup as a loop device or not

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_CREATE

-
-
-
-
-

bd_loop_setup_from_fd ()

-
gboolean
-bd_loop_setup_from_fd (gint fd,
-                       guint64 offset,
-                       guint64 size,
-                       gboolean read_only,
-                       gboolean part_scan,
-                       const gchar **loop_name,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

fd

file descriptor for a file to setup as a new loop device

 

offset

offset of the start of the device (in file given by fd -)

 

size

maximum size of the device (or 0 to leave unspecified)

 

read_only

whether to setup as read-only (TRUE) or read-write (FALSE)

 

part_scan

whether to enforce partition scan on the newly created device or not

 

loop_name

if not NULL, it is used to store the name of the loop device.

[optional][out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether an new loop device was successfully setup for fd -or not

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_CREATE

-
-
-
-
-

bd_loop_teardown ()

-
gboolean
-bd_loop_teardown (const gchar *loop,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

loop

path or name of the loop device to tear down

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the loop -device was successfully torn down or not

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_DESTROY

-
-
-
-
-

bd_loop_get_autoclear ()

-
gboolean
-bd_loop_get_autoclear (const gchar *loop,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

loop

path or name of the loop device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the autoclear flag is set on the loop -device or not (if FALSE, error -may be set)

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_QUERY

-
-
-
-
-

bd_loop_set_autoclear ()

-
gboolean
-bd_loop_set_autoclear (const gchar *loop,
-                       gboolean autoclear,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

loop

path or name of the loop device

 

autoclear

whether to set or unset the autoclear flag

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the autoclear flag was successfully set on the loop -device or not

-

Tech category: BD_LOOP_TECH_LOOP-BD_LOOP_TECH_MODE_MODIFY

-
-
-
-
-

bd_loop_is_tech_avail ()

-
gboolean
-bd_loop_is_tech_avail (BDLoopTech tech,
-                       guint64 mode,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDLoopTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_LOOP_ERROR

-
#define             BD_LOOP_ERROR
-
-
-
-

enum BDLoopError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_LOOP_ERROR_DEVICE

  

BD_LOOP_ERROR_FAIL

  

BD_LOOP_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

enum BDLoopTech

-
-

Members

-
----- - - - - - -

BD_LOOP_TECH_LOOP

  
-
-
-
-
-

enum BDLoopTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_LOOP_TECH_MODE_CREATE

  

BD_LOOP_TECH_MODE_DESTROY

  

BD_LOOP_TECH_MODE_MODIFY

  

BD_LOOP_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-MD-RAID.html b/libblockdev/docs/3.0/libblockdev-MD-RAID.html deleted file mode 100644 index e5a394d..0000000 --- a/libblockdev/docs/3.0/libblockdev-MD-RAID.html +++ /dev/null @@ -1,1694 +0,0 @@ - - - - -MD RAID: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

MD RAID

-

MD RAID — plugin for basic operations with MD RAID

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_md_check_deps () -
-gboolean - -bd_md_init () -
-void - -bd_md_close () -
-GQuark - -bd_md_error_quark () -
-BDMDExamineData * - -bd_md_examine_data_copy () -
-void - -bd_md_examine_data_free () -
-void - -bd_md_detail_data_free () -
-BDMDDetailData * - -bd_md_detail_data_copy () -
-guint64 - -bd_md_get_superblock_size () -
-gboolean - -bd_md_create () -
-gboolean - -bd_md_destroy () -
-gboolean - -bd_md_deactivate () -
-gboolean - -bd_md_activate () -
-gboolean - -bd_md_run () -
-gboolean - -bd_md_nominate () -
-gboolean - -bd_md_denominate () -
-gboolean - -bd_md_add () -
-gboolean - -bd_md_remove () -
-BDMDExamineData * - -bd_md_examine () -
-gchar * - -bd_md_canonicalize_uuid () -
-gchar * - -bd_md_get_md_uuid () -
-BDMDDetailData * - -bd_md_detail () -
-gchar * - -bd_md_node_from_name () -
-gchar * - -bd_md_name_from_node () -
-gchar * - -bd_md_get_status () -
-gboolean - -bd_md_set_bitmap_location () -
-gchar * - -bd_md_get_bitmap_location () -
-gboolean - -bd_md_request_sync_action () -
-gboolean - -bd_md_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_MD_SUPERBLOCK_SIZE
#defineBD_MD_CHUNK_SIZE
#defineBD_MD_ERROR
enumBDMDError
 BDMDExamineData
 BDMDDetailData
enumBDMDTech
enumBDMDTechMode
-
-
-

Includes

-
#include <mdraid.h>
-
-
-
-

Description

-

A plugin for basic operations with MD RAID. Also sizes are in -bytes unless specified otherwise.

-
-
-

Functions

-
-

bd_md_check_deps ()

-
gboolean
-bd_md_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_md_init ()

-
gboolean
-bd_md_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_md_close ()

-
void
-bd_md_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_md_error_quark ()

-
GQuark
-bd_md_error_quark (void);
-

[skip]

-
-
-
-

bd_md_examine_data_copy ()

-
BDMDExamineData *
-bd_md_examine_data_copy (BDMDExamineData *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDMDExamineData to copy.

[nullable]
-
-
-
-
-

bd_md_examine_data_free ()

-
void
-bd_md_examine_data_free (BDMDExamineData *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDMDExamineData to free.

[nullable]
-
-
-
-
-

bd_md_detail_data_free ()

-
void
-bd_md_detail_data_free (BDMDDetailData *data);
-

Frees data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDMDDetailData to free.

[nullable]
-
-
-
-
-

bd_md_detail_data_copy ()

-
BDMDDetailData *
-bd_md_detail_data_copy (BDMDDetailData *data);
-

Creates a new copy of data -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

data

BDMDDetailData to copy.

[nullable]
-
-
-
-
-

bd_md_get_superblock_size ()

-
guint64
-bd_md_get_superblock_size (guint64 member_size,
-                           const gchar *version,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

member_size

size of an array member

 

version

metadata version or NULL to use the current default version.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

Calculated superblock size for an array with a given member_size -and metadata version -or default if unsupported version -is used.

-

Tech category: always available

-
-
-
-
-

bd_md_create ()

-
gboolean
-bd_md_create (const gchar *device_name,
-              const gchar *level,
-              const gchar **disks,
-              guint64 spares,
-              const gchar *version,
-              gboolean bitmap,
-              guint64 chunk_size,
-              const BDExtraArg **extra,
-              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device_name

name of the device to create

 

level

RAID level (as understood by mdadm, see mdadm(8))

 

disks

disks to use for the new RAID (including spares).

[array zero-terminated=1]

spares

number of spare devices

 

version

metadata version.

[nullable]

bitmap

whether to create an internal bitmap on the device or not

 

chunk_size

chunk size of the device to create

 

extra

extra options for the creation (right now -passed to the 'mdadm' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the new MD RAID device device_name -was successfully created or not

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_CREATE

-
-
-
-
-

bd_md_destroy ()

-
gboolean
-bd_md_destroy (const gchar *device,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

device to destroy MD RAID metadata on

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the MD RAID metadata was successfully destroyed on device -or not

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_DELETE

-
-
-
-
-

bd_md_deactivate ()

-
gboolean
-bd_md_deactivate (const gchar *raid_spec,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the RAID device raid_spec -was successfully deactivated or not

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_activate ()

-
gboolean
-bd_md_activate (const gchar *raid_spec,
-                const gchar **members,
-                const gchar *uuid,
-                gboolean start_degraded,
-                const BDExtraArg **extra,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to activate (if not given "--scan" is implied and members -is ignored).

[nullable]

members

member devices to be considered for device -activation.

[nullable][array zero-terminated=1]

uuid

UUID (in the MD RAID format!) of the MD RAID to activate.

[nullable]

start_degraded

whether to start the array even if it's degraded

 

extra

extra options for the activation (right now -passed to the 'mdadm' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the MD RAID device -was successfully activated or not

-

Note: either members -or uuid -(or both) have to be specified.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_run ()

-
gboolean
-bd_md_run (const gchar *raid_spec,
-           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

raid_spec

specification of the (possibly degraded) RAID device (name, node or path) to be started

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the raid_spec -was successfully started or not

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_nominate ()

-
gboolean
-bd_md_nominate (const gchar *device,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

device to nominate (add to its appropriate RAID) as a MD RAID device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully nominated (added to its -appropriate RAID) or not

-

Note: may start the MD RAID if it becomes ready by adding device -.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_denominate ()

-
gboolean
-bd_md_denominate (const gchar *device,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

device to denominate (remove from its appropriate RAID) as a MD RAID device

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully denominated (added to its -appropriate RAID) or not

-

Note: may start the MD RAID if it becomes ready by adding device -.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_add ()

-
gboolean
-bd_md_add (const gchar *raid_spec,
-           const gchar *device,
-           guint64 raid_devs,
-           const BDExtraArg **extra,
-           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to add device -into

 

device

name of the device to add to the raid_spec -RAID device

 

raid_devs

number of devices the raid_spec -RAID should actively use or 0 -to leave unspecified (see below)

 

extra

extra options for the addition (right now -passed to the 'mdadm' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully added to the raid_spec -RAID or -not

-

The raid_devs -parameter is used when adding devices to a raid array that has -no actual redundancy. In this case it is necessary to explicitly grow the -array all at once rather than manage it in the sense of adding spares.

-

Whether the new device will be added as a spare or an active member is -decided by mdadm.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_remove ()

-
gboolean
-bd_md_remove (const gchar *raid_spec,
-              const gchar *device,
-              gboolean fail,
-              const BDExtraArg **extra,
-              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to remove device -from

 

device

device to remove from the raid_spec -RAID

 

fail

whether to mark the device -as failed before removing

 

extra

extra options for the removal (right now -passed to the 'mdadm' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the device -was successfully removed from the raid_spec -RAID or not.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_examine ()

-
BDMDExamineData *
-bd_md_examine (const gchar *device,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

name of the device (a member of an MD RAID) to examine

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the MD RAID extracted from the device -

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_QUERY

-
-
-
-
-

bd_md_canonicalize_uuid ()

-
gchar *
-bd_md_canonicalize_uuid (const gchar *uuid,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to canonicalize

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

canonicalized form of uuid -

-

This function expects a UUID in the form that mdadm returns. The change is as -follows: 3386ff85:f5012621:4a435f06:1eb47236 -> 3386ff85-f501-2621-4a43-5f061eb47236

-

Tech category: always available.

-

[transfer full]

-
-
-
-
-

bd_md_get_md_uuid ()

-
gchar *
-bd_md_get_md_uuid (const gchar *uuid,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

uuid

UUID to transform into format used by MD RAID

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

transformed form of uuid -

-

This function expects a UUID in the canonical (traditional format) and -returns a UUID in the format used by MD RAID and is thus reverse to -bd_md_canonicalize_uuid(). The change is as follows: -3386ff85-f501-2621-4a43-5f061eb47236 -> 3386ff85:f5012621:4a435f06:1eb47236

-

Tech category: always available.

-

[transfer full]

-
-
-
-
-

bd_md_detail ()

-
BDMDDetailData *
-bd_md_detail (const gchar *raid_spec,
-              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to examine

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the MD RAID raid_spec -

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_QUERY

-
-
-
-
-

bd_md_node_from_name ()

-
gchar *
-bd_md_node_from_name (const gchar *name,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

name

name of the MD RAID

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

device node of the name -MD RAID or NULL in case of error

-

Tech category: always available

-
-
-
-
-

bd_md_name_from_node ()

-
gchar *
-bd_md_name_from_node (const gchar *node,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

node

path of the MD RAID's device node

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

name -of the MD RAID the device node belongs to or NULL in case of error

-

Tech category: always available

-
-
-
-
-

bd_md_get_status ()

-
gchar *
-bd_md_get_status (const gchar *raid_spec,
-                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to get status

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

status of the raid_spec -RAID.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_md_set_bitmap_location ()

-
gboolean
-bd_md_set_bitmap_location (const gchar *raid_spec,
-                           const gchar *location,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to set the bitmap location

 

location

bitmap location (none, internal or path)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether location -was successfully set for raid_spec -

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_get_bitmap_location ()

-
gchar *
-bd_md_get_bitmap_location (const gchar *raid_spec,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to get the bitmap location

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

bitmap location for raid_spec -

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_md_request_sync_action ()

-
gboolean
-bd_md_request_sync_action (const gchar *raid_spec,
-                           const gchar *action,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

raid_spec

specification of the RAID device (name, node or path) to request sync action on

 

action

requested sync action (resync, recovery, check, repair or idle)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the action -was successfully requested for the raid_spec -RAID or not.

-

Tech category: BD_MD_TECH_MDRAID-BD_MD_TECH_MODE_MODIFY

-
-
-
-
-

bd_md_is_tech_avail ()

-
gboolean
-bd_md_is_tech_avail (BDMDTech tech,
-                     guint64 mode,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_MD_SUPERBLOCK_SIZE

-
#define             BD_MD_SUPERBLOCK_SIZE
-
-
-
-

BD_MD_CHUNK_SIZE

-
#define             BD_MD_CHUNK_SIZE
-
-
-
-

BD_MD_ERROR

-
#define             BD_MD_ERROR
-
-
-
-

enum BDMDError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_MD_ERROR_PARSE

  

BD_MD_ERROR_BAD_FORMAT

  

BD_MD_ERROR_NO_MATCH

  

BD_MD_ERROR_INVAL

  

BD_MD_ERROR_FAIL

  

BD_MD_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

BDMDExamineData

-
typedef struct {
-    gchar *device;
-    gchar *level;
-    guint64 num_devices;
-    gchar *name;
-    guint64 size;
-    gchar *uuid;
-    guint64 update_time;
-    gchar *dev_uuid;
-    guint64 events;
-    gchar *metadata;
-    guint64 chunk_size;
-} BDMDExamineData;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *device;

path of the MD device

 

gchar *level;

RAID level of the device

 

guint64 num_devices;

number of devices used by the MD device

 

gchar *name;

name of the MD device

 

guint64 size;

size of the MD device

 

gchar *uuid;

array UUID

 

guint64 update_time;

update time of the MD device

 

gchar *dev_uuid;

UUID of the member device

 

guint64 events;

number of events on the MD device

 

gchar *metadata;

version of the metadata used by the MD device

 

guint64 chunk_size;

chunk size used by the MD device

 
-
-
-
-
-

BDMDDetailData

-
typedef struct {
-    gchar *device;
-    gchar *metadata;
-    gchar *creation_time;
-    gchar *level;
-    gchar *name;
-    guint64 array_size;
-    guint64 use_dev_size;
-    guint64 raid_devices;
-    guint64 total_devices;
-    guint64 active_devices;
-    guint64 working_devices;
-    guint64 failed_devices;
-    guint64 spare_devices;
-    gboolean clean;
-    gchar *uuid;
-    gchar *container;
-} BDMDDetailData;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *device;

path of the device

 

gchar *metadata;

version of the metadata used by the device

 

gchar *creation_time;

creation time

 

gchar *level;

level of the MD RAID

 

gchar *name;

name of the MD device

 

guint64 array_size;

size of the MD array

 

guint64 use_dev_size;

size of the used space

 

guint64 raid_devices;

number of devices in the MD array

 

guint64 total_devices;

total number of devices in the MD array

 

guint64 active_devices;

number of active devices in the MD array

 

guint64 working_devices;

number of working devices in the MD array

 

guint64 failed_devices;

number of failed devices in the MD array

 

guint64 spare_devices;

number of spare devices in the MD array

 

gboolean clean;

whether the MD array is clean or not

 

gchar *uuid;

uuid of the MD array

 

gchar *container;

path of the MD container this device belongs to

 
-
-
-
-
-

enum BDMDTech

-
-

Members

-
----- - - - - - -

BD_MD_TECH_MDRAID

  
-
-
-
-
-

enum BDMDTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_MD_TECH_MODE_CREATE

  

BD_MD_TECH_MODE_DELETE

  

BD_MD_TECH_MODE_MODIFY

  

BD_MD_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Mpath.html b/libblockdev/docs/3.0/libblockdev-Mpath.html deleted file mode 100644 index d03166c..0000000 --- a/libblockdev/docs/3.0/libblockdev-Mpath.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - -Mpath: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Mpath

-

Mpath — plugin for basic operations with multipath devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_mpath_check_deps () -
-gboolean - -bd_mpath_init () -
-void - -bd_mpath_close () -
-GQuark - -bd_mpath_error_quark () -
-gboolean - -bd_mpath_flush_mpaths () -
-gboolean - -bd_mpath_is_mpath_member () -
-gchar ** - -bd_mpath_get_mpath_members () -
-gboolean - -bd_mpath_set_friendly_names () -
-gboolean - -bd_mpath_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - -
#defineBD_MPATH_ERROR
enumBDMpathError
enumBDMpathTech
enumBDMpathTechMode
-
-
-

Includes

-
#include <mpath.h>
-
-
-
-

Description

-

A plugin for basic operations with multipath devices.

-
-
-

Functions

-
-

bd_mpath_check_deps ()

-
gboolean
-bd_mpath_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_mpath_init ()

-
gboolean
-bd_mpath_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_mpath_close ()

-
void
-bd_mpath_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_mpath_error_quark ()

-
GQuark
-bd_mpath_error_quark (void);
-

[skip]

-
-
-
-

bd_mpath_flush_mpaths ()

-
gboolean
-bd_mpath_flush_mpaths (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether multipath device maps were successfully flushed or not

-

Flushes all unused multipath device maps.

-

Tech category: BD_MPATH_TECH_BASE-BD_MPATH_TECH_MODE_MODIFY

-
-
-
-
-

bd_mpath_is_mpath_member ()

-
gboolean
-bd_mpath_is_mpath_member (const gchar *device,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

device to test

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

TRUE if the device is a multipath member, FALSE if not or an error -appeared when queried (error -is set in those cases)

-

Tech category: BD_MPATH_TECH_BASE-BD_MPATH_TECH_MODE_QUERY

-
-
-
-
-

bd_mpath_get_mpath_members ()

-
gchar **
-bd_mpath_get_mpath_members (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

list of names of all devices that are -members of the mpath mappings (or NULL -in case of error)

-

Tech category: BD_MPATH_TECH_BASE-BD_MPATH_TECH_MODE_QUERY.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_mpath_set_friendly_names ()

-
gboolean
-bd_mpath_set_friendly_names (gboolean enabled,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

enabled

whether friendly names should be enabled or not

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

if successfully set or not

-

Tech category: BD_MPATH_TECH_FRIENDLY_NAMES-BD_MPATH_TECH_MODE_MODIFY

-
-
-
-
-

bd_mpath_is_tech_avail ()

-
gboolean
-bd_mpath_is_tech_avail (BDMpathTech tech,
-                        guint64 mode,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_MPATH_ERROR

-
#define             BD_MPATH_ERROR
-
-
-
-

enum BDMpathError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_MPATH_ERROR_FLUSH

  

BD_MPATH_ERROR_NOT_ROOT

  

BD_MPATH_ERROR_DM_ERROR

  

BD_MPATH_ERROR_INVAL

  

BD_MPATH_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

enum BDMpathTech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_MPATH_TECH_BASE

  

BD_MPATH_TECH_FRIENDLY_NAMES

  
-
-
-
-
-

enum BDMpathTechMode

-
-

Members

-
----- - - - - - - - - - - - - -

BD_MPATH_TECH_MODE_QUERY

  

BD_MPATH_TECH_MODE_MODIFY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-NVDIMM.html b/libblockdev/docs/3.0/libblockdev-NVDIMM.html deleted file mode 100644 index f7b49ec..0000000 --- a/libblockdev/docs/3.0/libblockdev-NVDIMM.html +++ /dev/null @@ -1,953 +0,0 @@ - - - - -NVDIMM: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

NVDIMM

-

NVDIMM — plugin for operations with nvdimm space

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_nvdimm_check_deps () -
-void - -bd_nvdimm_close () -
-gboolean - -bd_nvdimm_init () -
-GQuark - -bd_nvdimm_error_quark () -
-BDNVDIMMNamespaceMode - -bd_nvdimm_namespace_get_mode_from_str () -
const gchar * - -bd_nvdimm_namespace_get_mode_str () -
-gchar * - -bd_nvdimm_namespace_get_devname () -
-gboolean - -bd_nvdimm_namespace_enable () -
-gboolean - -bd_nvdimm_namespace_disable () -
-BDNVDIMMNamespaceInfo * - -bd_nvdimm_namespace_info () -
-BDNVDIMMNamespaceInfo ** - -bd_nvdimm_list_namespaces () -
-gboolean - -bd_nvdimm_namespace_reconfigure () -
const guint64 * - -bd_nvdimm_namespace_get_supported_sector_sizes () -
-BDNVDIMMNamespaceInfo * - -bd_nvdimm_namespace_info_copy () -
-void - -bd_nvdimm_namespace_info_free () -
-gboolean - -bd_nvdimm_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_NVDIMM_ERROR
enumBDNVDIMMError
enumBDNVDIMMNamespaceMode
 BDNVDIMMNamespaceInfo
enumBDNVDIMMTech
enumBDNVDIMMTechMode
-
-
-

Includes

-
#include <nvdimm.h>
-
-
-
-

Description

-

A plugin for operations with NVDIMM devices.

-
-
-

Functions

-
-

bd_nvdimm_check_deps ()

-
gboolean
-bd_nvdimm_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_nvdimm_close ()

-
void
-bd_nvdimm_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_nvdimm_init ()

-
gboolean
-bd_nvdimm_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_nvdimm_error_quark ()

-
GQuark
-bd_nvdimm_error_quark (void);
-

[skip]

-
-
-
-

bd_nvdimm_namespace_get_mode_from_str ()

-
BDNVDIMMNamespaceMode
-bd_nvdimm_namespace_get_mode_from_str (const gchar *mode_str,
-                                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode_str

string representation of mode

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

mode matching the mode_str -given or BD_NVDIMM_NAMESPACE_MODE_UNKNOWN in case of no match

-

Tech category: always available

-
-
-
-
-

bd_nvdimm_namespace_get_mode_str ()

-
const gchar *
-bd_nvdimm_namespace_get_mode_str (BDNVDIMMNamespaceMode mode,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode

mode to get string representation of

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

string representation of mode -or NULL in case of error

-

Tech category: always available.

-

[transfer none]

-
-
-
-
-

bd_nvdimm_namespace_get_devname ()

-
gchar *
-bd_nvdimm_namespace_get_devname (const gchar *device,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

name or path of a block device (e.g. "/dev/pmem0")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

namespace device name (e.g. "namespaceX.Y") for device -or NULL if device -is not a NVDIMM namespace -(error -may be set to indicate error)

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_nvdimm_namespace_enable ()

-
gboolean
-bd_nvdimm_namespace_enable (const gchar *namespace,
-                            const BDExtraArg **extra,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

namespace

name of the namespace to enable

 

extra

extra options (currently unused).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the namespace -was successfully enabled or not

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_ACTIVATE_DEACTIVATE

-
-
-
-
-

bd_nvdimm_namespace_disable ()

-
gboolean
-bd_nvdimm_namespace_disable (const gchar *namespace,
-                             const BDExtraArg **extra,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

namespace

name of the namespace to disable

 

extra

extra options (currently unused).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the namespace -was successfully disabled or not

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_ACTIVATE_DEACTIVATE

-
-
-
-
-

bd_nvdimm_namespace_info ()

-
BDNVDIMMNamespaceInfo *
-bd_nvdimm_namespace_info (const gchar *namespace,
-                          const BDExtraArg **extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

namespace

namespace to get information about

 

extra

extra options (currently unused).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about given namespace or NULL if no such -namespace was found (error -may be set to indicate error)

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_QUERY.

-

[transfer full]

-
-
-
-
-

bd_nvdimm_list_namespaces ()

-
BDNVDIMMNamespaceInfo **
-bd_nvdimm_list_namespaces (const gchar *bus,
-                           const gchar *region,
-                           gboolean idle,
-                           const BDExtraArg **extra,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

bus

return only namespaces on given bus (specified by name), -NULL may be specified to return namespaces from all buses.

[nullable]

region

return only namespaces on given region (specified by regionX name or region id), -NULL may be specified to return namespaces from all regions.

[nullable]

idle

whether to list idle (not enabled) namespaces too

 

extra

extra options for the creation (right now -passed to the 'ndctl' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

information about the namespaces on bus -and region -or -NULL if no namespaces were found (error -may be set to indicate error)

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_QUERY.

-

[array zero-terminated=1]

-
-
-
-
-

bd_nvdimm_namespace_reconfigure ()

-
gboolean
-bd_nvdimm_namespace_reconfigure (const gchar *namespace,
-                                 BDNVDIMMNamespaceMode mode,
-                                 gboolean force,
-                                 const BDExtraArg **extra,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

namespace

name of the namespace to reconfigure

 

mode

mode type to set (memory/sector/raw/dax)

 

force

whether to use force to reconfigure an active namespace

 

error

place to store error if any.

[out][optional]

extra

extra options for the creation (right now -passed to the 'ndctl' utility).

[nullable][array zero-terminated=1]
-
-
-

Returns

-

whether namespace -was successfully reconfigured or not

-
-
-
-
-

bd_nvdimm_namespace_get_supported_sector_sizes ()

-
const guint64 *
-bd_nvdimm_namespace_get_supported_sector_sizes
-                               (BDNVDIMMNamespaceMode mode,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

mode

namespace mode

 

error

place to store error if any.

[out][optional]
-
-
-

Returns

-

list of supported sector sizes for mode -

-

Tech category: BD_NVDIMM_TECH_NAMESPACE-BD_NVDIMM_TECH_MODE_QUERY.

-

[transfer none][array zero-terminated=1]

-
-
-
-
-

bd_nvdimm_namespace_info_copy ()

-
BDNVDIMMNamespaceInfo *
-bd_nvdimm_namespace_info_copy (BDNVDIMMNamespaceInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVDIMMNamespaceInfo to copy.

[nullable]
-
-
-
-
-

bd_nvdimm_namespace_info_free ()

-
void
-bd_nvdimm_namespace_info_free (BDNVDIMMNamespaceInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVDIMMNamespaceInfo to free.

[nullable]
-
-
-
-
-

bd_nvdimm_is_tech_avail ()

-
gboolean
-bd_nvdimm_is_tech_avail (BDNVDIMMTech tech,
-                         guint64 mode,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDNVDIMMTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_NVDIMM_ERROR

-
#define             BD_NVDIMM_ERROR
-
-
-
-

enum BDNVDIMMError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVDIMM_ERROR_NAMESPACE_PARSE

  

BD_NVDIMM_ERROR_NAMESPACE_FAIL

  

BD_NVDIMM_ERROR_NAMESPACE_NOEXIST

  

BD_NVDIMM_ERROR_NAMESPACE_MODE_INVAL

  

BD_NVDIMM_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

enum BDNVDIMMNamespaceMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVDIMM_NAMESPACE_MODE_RAW

  

BD_NVDIMM_NAMESPACE_MODE_SECTOR

  

BD_NVDIMM_NAMESPACE_MODE_MEMORY

  

BD_NVDIMM_NAMESPACE_MODE_DAX

  

BD_NVDIMM_NAMESPACE_MODE_FSDAX

  

BD_NVDIMM_NAMESPACE_MODE_DEVDAX

  

BD_NVDIMM_NAMESPACE_MODE_UNKNOWN

  
-
-
-
-
-

BDNVDIMMNamespaceInfo

-
typedef struct {
-    gchar *dev;
-    guint64 mode;
-    guint64 size;
-    gchar *uuid;
-    guint64 sector_size;
-    gchar *blockdev;
-    gboolean enabled;
-} BDNVDIMMNamespaceInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *dev;

namespace device name ("namespaceX.Y")

 

guint64 mode;

mode of the namespace (BDNVDIMMNamespaceMode)

 

guint64 size;

size of the namespace

 

gchar *uuid;

UUID of the namespace

 

guint64 sector_size;

sector size of the namespace (0 for non-sector namespaces)

 

gchar *blockdev;

name of the block device for the namespace

 

gboolean enabled;

whether the namespace is enabled or not

 
-
-
-
-
-

enum BDNVDIMMTech

-
-

Members

-
----- - - - - - -

BD_NVDIMM_TECH_NAMESPACE

  
-
-
-
-
-

enum BDNVDIMMTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVDIMM_TECH_MODE_CREATE

  

BD_NVDIMM_TECH_MODE_REMOVE

  

BD_NVDIMM_TECH_MODE_ACTIVATE_DEACTIVATE

  

BD_NVDIMM_TECH_MODE_QUERY

  

BD_NVDIMM_TECH_MODE_RECONFIGURE

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-NVMe.html b/libblockdev/docs/3.0/libblockdev-NVMe.html deleted file mode 100644 index bac1660..0000000 --- a/libblockdev/docs/3.0/libblockdev-NVMe.html +++ /dev/null @@ -1,3804 +0,0 @@ - - - - -NVMe: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

NVMe

-

NVMe — NVMe device reporting and management.

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_nvme_check_deps () -
-void - -bd_nvme_close () -
-gboolean - -bd_nvme_init () -
-GQuark - -bd_nvme_error_quark () -
-gboolean - -bd_nvme_is_tech_avail () -
-BDNVMEControllerInfo * - -bd_nvme_get_controller_info () -
-void - -bd_nvme_controller_info_free () -
-BDNVMEControllerInfo * - -bd_nvme_controller_info_copy () -
-void - -bd_nvme_lba_format_free () -
-BDNVMELBAFormat * - -bd_nvme_lba_format_copy () -
-BDNVMENamespaceInfo * - -bd_nvme_get_namespace_info () -
-void - -bd_nvme_namespace_info_free () -
-BDNVMENamespaceInfo * - -bd_nvme_namespace_info_copy () -
-BDNVMESmartLog * - -bd_nvme_get_smart_log () -
-void - -bd_nvme_smart_log_free () -
-BDNVMESmartLog * - -bd_nvme_smart_log_copy () -
-BDNVMEErrorLogEntry ** - -bd_nvme_get_error_log_entries () -
-void - -bd_nvme_error_log_entry_free () -
-BDNVMEErrorLogEntry * - -bd_nvme_error_log_entry_copy () -
-BDNVMESelfTestLog * - -bd_nvme_get_self_test_log () -
-void - -bd_nvme_self_test_log_free () -
-BDNVMESelfTestLog * - -bd_nvme_self_test_log_copy () -
-void - -bd_nvme_self_test_log_entry_free () -
-BDNVMESelfTestLogEntry * - -bd_nvme_self_test_log_entry_copy () -
const gchar * - -bd_nvme_self_test_result_to_string () -
-gboolean - -bd_nvme_device_self_test () -
-gboolean - -bd_nvme_format () -
-BDNVMESanitizeLog * - -bd_nvme_get_sanitize_log () -
-void - -bd_nvme_sanitize_log_free () -
-BDNVMESanitizeLog * - -bd_nvme_sanitize_log_copy () -
-gboolean - -bd_nvme_sanitize () -
-gchar * - -bd_nvme_get_host_nqn () -
-gchar * - -bd_nvme_get_host_id () -
-gchar * - -bd_nvme_generate_host_nqn () -
-gboolean - -bd_nvme_set_host_nqn () -
-gboolean - -bd_nvme_set_host_id () -
-gboolean - -bd_nvme_connect () -
-gboolean - -bd_nvme_disconnect () -
-gboolean - -bd_nvme_disconnect_by_path () -
-BDNVMEDiscoveryLogEntry * - -bd_nvme_discovery_log_entry_copy () -
-void - -bd_nvme_discovery_log_entry_free () -
-BDNVMEDiscoveryLogEntry ** - -bd_nvme_discover () -
-gchar ** - -bd_nvme_find_ctrls_for_ns () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_NVME_ERROR
enumBDNVMEError
enumBDNVMETech
enumBDNVMETechMode
enumBDNVMEControllerFeature
enumBDNVMEControllerType
 BDNVMEControllerInfo
enumBDNVMELBAFormatRelativePerformance
 BDNVMELBAFormat
enumBDNVMENamespaceFeature
 BDNVMENamespaceInfo
enumBDNVMESmartCriticalWarning
 BDNVMESmartLog
enumBDNVMETransportType
 BDNVMEErrorLogEntry
 BDNVMESelfTestLog
 BDNVMESelfTestLogEntry
enumBDNVMESelfTestAction
enumBDNVMESelfTestResult
enumBDNVMEFormatSecureErase
enumBDNVMESanitizeStatus
 BDNVMESanitizeLog
enumBDNVMESanitizeAction
 BDNVMEDiscoveryLogEntry
enumBDNVMEAddressFamily
enumBDNVMETCPSecurity
-
-
-

Includes

-
#include <nvme.h>
-
-
-
-

Description

-

A plugin for NVMe device reporting and management, based around libnvme.

-
-
-

Functions

-
-

bd_nvme_check_deps ()

-
gboolean
-bd_nvme_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_nvme_close ()

-
void
-bd_nvme_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_nvme_init ()

-
gboolean
-bd_nvme_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_nvme_error_quark ()

-
GQuark
-bd_nvme_error_quark (void);
-

[skip]

-
-
-
-

bd_nvme_is_tech_avail ()

-
gboolean
-bd_nvme_is_tech_avail (BDNVMETech tech,
-                       guint64 mode,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDNVMETechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][nullable]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

bd_nvme_get_controller_info ()

-
BDNVMEControllerInfo *
-bd_nvme_get_controller_info (const gchar *device,
-                             GError **error);
-

Retrieves information about the NVMe controller (the Identify Controller command) -as specified by the device - block device path.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe controller device (e.g. /dev/nvme0)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

information about given controller or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full]

-
-
-
-
-

bd_nvme_controller_info_free ()

-
void
-bd_nvme_controller_info_free (BDNVMEControllerInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVMEControllerInfo to free.

[nullable]
-
-
-
-
-

bd_nvme_controller_info_copy ()

-
BDNVMEControllerInfo *
-bd_nvme_controller_info_copy (BDNVMEControllerInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVMEControllerInfo to copy.

[nullable]
-
-
-
-
-

bd_nvme_lba_format_free ()

-
void
-bd_nvme_lba_format_free (BDNVMELBAFormat *fmt);
-

Frees fmt -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

fmt

BDNVMELBAFormat to free.

[nullable]
-
-
-
-
-

bd_nvme_lba_format_copy ()

-
BDNVMELBAFormat *
-bd_nvme_lba_format_copy (BDNVMELBAFormat *fmt);
-

Creates a new copy of fmt -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

fmt

BDNVMELBAFormat to copy.

[nullable]
-
-
-
-
-

bd_nvme_get_namespace_info ()

-
BDNVMENamespaceInfo *
-bd_nvme_get_namespace_info (const gchar *device,
-                            GError **error);
-

Retrieves information about the NVMe namespace (the Identify Namespace command) -as specified by the device - block device path.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe namespace device (e.g. /dev/nvme0n1)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

information about given namespace or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full]

-
-
-
-
-

bd_nvme_namespace_info_free ()

-
void
-bd_nvme_namespace_info_free (BDNVMENamespaceInfo *info);
-

Frees info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVMENamespaceInfo to free.

[nullable]
-
-
-
-
-

bd_nvme_namespace_info_copy ()

-
BDNVMENamespaceInfo *
-bd_nvme_namespace_info_copy (BDNVMENamespaceInfo *info);
-

Creates a new copy of info -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

info

BDNVMENamespaceInfo to copy.

[nullable]
-
-
-
-
-

bd_nvme_get_smart_log ()

-
BDNVMESmartLog *
-bd_nvme_get_smart_log (const gchar *device,
-                       GError **error);
-

Retrieves drive SMART and general health information (Log Identifier 02h). -The information provided is over the life of the controller and is retained across power cycles.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe controller device (e.g. /dev/nvme0)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

health log data or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full]

-
-
-
-
-

bd_nvme_smart_log_free ()

-
void
-bd_nvme_smart_log_free (BDNVMESmartLog *log);
-

Frees log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESmartLog to free.

[nullable]
-
-
-
-
-

bd_nvme_smart_log_copy ()

-
BDNVMESmartLog *
-bd_nvme_smart_log_copy (BDNVMESmartLog *log);
-

Creates a new copy of log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESmartLog to copy.

[nullable]
-
-
-
-
-

bd_nvme_get_error_log_entries ()

-
BDNVMEErrorLogEntry **
-bd_nvme_get_error_log_entries (const gchar *device,
-                               GError **error);
-

Retrieves Error Information Log (Log Identifier 01h) entries, used to describe -extended error information for a command that completed with error or to report -an error that is not specific to a particular command. This log is global to the -controller. The ordering of the entries is based on the time when the error -occurred, with the most recent error being returned as the first log entry. -As the number of entries is typically limited by the drive implementation, only -most recent entries are provided.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe controller device (e.g. /dev/nvme0)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

null-terminated list -of error entries or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_nvme_error_log_entry_free ()

-
void
-bd_nvme_error_log_entry_free (BDNVMEErrorLogEntry *entry);
-

Frees entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMEErrorLogEntry to free.

[nullable]
-
-
-
-
-

bd_nvme_error_log_entry_copy ()

-
BDNVMEErrorLogEntry *
-bd_nvme_error_log_entry_copy (BDNVMEErrorLogEntry *entry);
-

Creates a new copy of entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMEErrorLogEntry to copy.

[nullable]
-
-
-
-
-

bd_nvme_get_self_test_log ()

-
BDNVMESelfTestLog *
-bd_nvme_get_self_test_log (const gchar *device,
-                           GError **error);
-

Retrieves drive self-test log (Log Identifier 06h). Provides the status of a self-test operation -in progress and the percentage complete of that operation, along with the results of the last -20 device self-test operations.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe controller device (e.g. /dev/nvme0)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

self-test log data or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full]

-
-
-
-
-

bd_nvme_self_test_log_free ()

-
void
-bd_nvme_self_test_log_free (BDNVMESelfTestLog *log);
-

Frees log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESelfTestLog to free.

[nullable]
-
-
-
-
-

bd_nvme_self_test_log_copy ()

-
BDNVMESelfTestLog *
-bd_nvme_self_test_log_copy (BDNVMESelfTestLog *log);
-

Creates a new copy of log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESelfTestLog to copy.

[nullable]
-
-
-
-
-

bd_nvme_self_test_log_entry_free ()

-
void
-bd_nvme_self_test_log_entry_free (BDNVMESelfTestLogEntry *entry);
-

Frees entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMESelfTestLogEntry to free.

[nullable]
-
-
-
-
-

bd_nvme_self_test_log_entry_copy ()

-
BDNVMESelfTestLogEntry *
-bd_nvme_self_test_log_entry_copy (BDNVMESelfTestLogEntry *entry);
-

Creates a new copy of entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMESelfTestLogEntry to copy.

[nullable]
-
-
-
-
-

bd_nvme_self_test_result_to_string ()

-
const gchar *
-bd_nvme_self_test_result_to_string (BDNVMESelfTestResult result,
-                                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

result

A BDNVMESelfTestResult.

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

A string representation of result -for use as an identifier string -or NULL when the code is unknown.

-

[transfer none]

-
-
-
-
-

bd_nvme_device_self_test ()

-
gboolean
-bd_nvme_device_self_test (const gchar *device,
-                          BDNVMESelfTestAction action,
-                          GError **error);
-

Initiates or aborts the Device Self-test operation on the controller or a namespace, -distinguished by the device - path specified. In case a controller device -is specified then the self-test operation would include all active namespaces.

-

To abort a running operation, pass BD_NVME_SELF_TEST_ACTION_ABORT as action -. -To retrieve progress of a current running operation, check the self-test log using -bd_nvme_get_self_test_log().

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

a NVMe controller or namespace device (e.g. /dev/nvme0)

 

action

self-test action to take.

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the device self-test command was issued successfully, -FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_MANAGE

-
-
-
-
-

bd_nvme_format ()

-
gboolean
-bd_nvme_format (const gchar *device,
-                guint16 lba_data_size,
-                BDNVMEFormatSecureErase secure_erase,
-                GError **error);
-

Performs low level format of the NVM media, destroying all data and metadata for either -a specific namespace or all attached namespaces to the controller. Use this command -to change LBA sector size. Optional secure erase method can be specified as well.

-

Supported LBA data sizes for a given namespace can be listed using the bd_nvme_get_namespace_info() -call. In case of a special value 0 the current LBA format for a given namespace will be -retained. When called on a controller device the first namespace is used as a reference.

-

Note that the NVMe controller may define a Format NVM attribute indicating that the format -operation would apply to all namespaces and a format (excluding secure erase) of any -namespace results in a format of all namespaces in the NVM subsystem. In such case and -when device - is a namespace block device the BD_NVME_ERROR_WOULD_FORMAT_ALL_NS error -is returned to prevent further damage. This is then supposed to be handled by the caller -and bd_nvme_format() is supposed to be called on a controller device instead.

-

This call blocks until the format operation has finished. To retrieve progress -of a current running operation, check the namespace info using bd_nvme_get_namespace_info().

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

NVMe namespace or controller device to format (e.g. /dev/nvme0n1)

 

lba_data_size

desired LBA data size (i.e. a sector size) in bytes or 0 to keep current. See BDNVMELBAFormat and bd_nvme_get_namespace_info().

 

secure_erase

optional secure erase action to take.

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the format command finished successfully, FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_MANAGE

-
-
-
-
-

bd_nvme_get_sanitize_log ()

-
BDNVMESanitizeLog *
-bd_nvme_get_sanitize_log (const gchar *device,
-                          GError **error);
-

Retrieves the drive sanitize status log (Log Identifier 81h) that includes information -about the most recent sanitize operation and the sanitize operation time estimates.

-

As advised in the NVMe specification whitepaper the host should limit polling -to retrieve progress of a running sanitize operations (e.g. to at most once every -several minutes) to avoid interfering with the progress of the sanitize operation itself.

-
-

Parameters

-
----- - - - - - - - - - - - - -

device

a NVMe controller device (e.g. /dev/nvme0)

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

sanitize log data or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_INFO.

-

[transfer full]

-
-
-
-
-

bd_nvme_sanitize_log_free ()

-
void
-bd_nvme_sanitize_log_free (BDNVMESanitizeLog *log);
-

Frees log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESanitizeLog to free.

[nullable]
-
-
-
-
-

bd_nvme_sanitize_log_copy ()

-
BDNVMESanitizeLog *
-bd_nvme_sanitize_log_copy (BDNVMESanitizeLog *log);
-

Creates a new copy of log -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

log

BDNVMESanitizeLog to copy.

[nullable]
-
-
-
-
-

bd_nvme_sanitize ()

-
gboolean
-bd_nvme_sanitize (const gchar *device,
-                  BDNVMESanitizeAction action,
-                  gboolean no_dealloc,
-                  gint overwrite_pass_count,
-                  guint32 overwrite_pattern,
-                  gboolean overwrite_invert_pattern,
-                  GError **error);
-

Starts a sanitize operation or recovers from a previously failed sanitize operation. -By definition, a sanitize operation alters all user data in the NVM subsystem such -that recovery of any previous user data from any cache, the non-volatile media, -or any Controller Memory Buffer is not possible. The scope of a sanitize operation -is all locations in the NVM subsystem that are able to contain user data, including -caches, Persistent Memory Regions, and unallocated or deallocated areas of the media.

-

Once started, a sanitize operation is not able to be aborted and continues after -a Controller Level Reset including across power cycles. Once the sanitize operation -has run the media affected may not be immediately ready for use unless additional -media modification mechanism is run. This is often vendor specific and also depends -on the sanitize method (action -) used. Callers to this sanitize operation should -set no_dealloc - to TRUE for the added convenience.

-

The controller also ignores Critical Warning(s) in the SMART / Health Information -log page (e.g., read only mode) and attempts to complete the sanitize operation requested.

-

This call returns immediately and the actual sanitize operation is performed -in the background. Use bd_nvme_get_sanitize_log() to retrieve status and progress -of a running sanitize operation. In case a sanitize operation fails the controller -may restrict its operation until a subsequent sanitize operation is started -(i.e. retried) or an BD_NVME_SANITIZE_ACTION_EXIT_FAILURE action is used -to acknowledge the failure explicitly.

-

The overwrite_pass_count -, overwrite_pattern - and overwrite_invert_pattern - -arguments are only valid when action - is BD_NVME_SANITIZE_ACTION_OVERWRITE.

-

The sanitize operation is set to run under the Allow Unrestricted Sanitize Exit -mode.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

device

NVMe namespace or controller device to format (e.g. /dev/nvme0n1)

 

action

the sanitize action to perform.

 

no_dealloc

instruct the controller to not deallocate the affected media area.

 

overwrite_pass_count

number of overwrite passes [1-15] or 0 for the default (16 passes).

 

overwrite_pattern

a 32-bit pattern used for the Overwrite sanitize operation.

 

overwrite_invert_pattern

invert the overwrite pattern between passes.

 

error

place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the format command finished successfully, FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_NVME-BD_NVME_TECH_MODE_MANAGE

-
-
-
-
-

bd_nvme_get_host_nqn ()

-
gchar *
-bd_nvme_get_host_nqn (GError **error);
-

Reads the Host NQN (NVM Qualified Name) value from the global /etc/nvme/hostnqn -file. An empty string is an indication that no Host NQN has been set.

-
-

Parameters

-
----- - - - - - -

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

the Host NQN string or an empty string if none set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR.

-

[transfer full]

-
-
-
-
-

bd_nvme_get_host_id ()

-
gchar *
-bd_nvme_get_host_id (GError **error);
-

Reads the Host ID value from the global /etc/nvme/hostid file. An empty -string is an indication that no Host ID has been set.

-
-

Parameters

-
----- - - - - - -

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

the Host ID string or an empty string if none set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR.

-

[transfer full]

-
-
-
-
-

bd_nvme_generate_host_nqn ()

-
gchar *
-bd_nvme_generate_host_nqn (GError **error);
-

Compute new Host NQN (NVM Qualified Name) value for the current system. This -takes in account various system identifiers (DMI, device tree) with the goal -of a stable unique identifier whenever feasible.

-
-

Parameters

-
----- - - - - - -

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

the Host NQN string or NULL with error -set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR.

-

[transfer full]

-
-
-
-
-

bd_nvme_set_host_nqn ()

-
gboolean
-bd_nvme_set_host_nqn (const gchar *host_nqn,
-                      GError **error);
-

Writes the Host NQN (NVM Qualified Name) value to the system /etc/nvme/hostnqn file. -No validation of the string is performed.

-
-

Parameters

-
----- - - - - - - - - - - - - -

host_nqn

The Host NVM Qualified Name.

 

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the value was set successfully or FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR

-
-
-
-
-

bd_nvme_set_host_id ()

-
gboolean
-bd_nvme_set_host_id (const gchar *host_id,
-                     GError **error);
-

Writes the Host ID value to the system /etc/nvme/hostid file. -No validation of the string is performed.

-
-

Parameters

-
----- - - - - - - - - - - - - -

host_id

The Host ID.

 

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the value was set successfully or FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR

-
-
-
-
-

bd_nvme_connect ()

-
gboolean
-bd_nvme_connect (const gchar *subsysnqn,
-                 const gchar *transport,
-                 const gchar *transport_addr,
-                 const gchar *transport_svcid,
-                 const gchar *host_traddr,
-                 const gchar *host_iface,
-                 const gchar *host_nqn,
-                 const gchar *host_id,
-                 const BDExtraArg **extra,
-                 GError **error);
-

Creates a transport connection to a remote system (specified by transport_addr - and transport_svcid -) -and creates a NVMe over Fabrics controller for the NVMe subsystem specified by the subsysnqn - option.

-

Valid values for transport - include:

-
    -

  • "rdma": An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.)

    • -

  • "fc": A Fibre Channel network.

    • -

  • "tcp": A TCP/IP network.

    • -

  • "loop": A NVMe over Fabrics target on the local host.

    • -
-

In addition to the primary options it's possible to supply extra - arguments:

-
    -

  • "config": Use the specified JSON configuration file instead of the default file (see below) or - specify "none" to avoid reading any configuration file.

    • -

  • "dhchap_key": NVMe In-band authentication secret in ASCII format as described - in the NVMe 2.0 specification. When not specified, the secret is by default read - from /etc/nvme/hostkey. In case that file does not exist no in-band authentication - is attempted.

    • -

  • "dhchap_ctrl_key": NVMe In-band authentication controller secret for bi-directional authentication. - When not specified, no bi-directional authentication is attempted.

    • -

  • "nr_io_queues": The number of I/O queues.

    • -

  • "nr_write_queues": Number of additional queues that will be used for write I/O.

    • -

  • "nr_poll_queues": Number of additional queues that will be used for polling latency sensitive I/O.

    • -

  • "queue_size": Number of elements in the I/O queues.

    • -

  • "keep_alive_tmo": The keep alive timeout (in seconds).

    • -

  • "reconnect_delay": The delay (in seconds) before reconnect is attempted after a connect loss.

    • -

  • "ctrl_loss_tmo": The controller loss timeout period (in seconds). A special value of -1 will cause reconnecting forever.

    • -

  • "fast_io_fail_tmo": Fast I/O Fail timeout (in seconds).

    • -

  • "tos": Type of service.

    • -

  • "duplicate_connect": Allow duplicated connections between same transport host and subsystem port. Boolean value.

    • -

  • "disable_sqflow": Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value.

    • -

  • "hdr_digest": Generates/verifies header digest (TCP). Boolean value.

    • -

  • "data_digest": Generates/verifies data digest (TCP). Boolean value.

    • -

  • "tls": Enable TLS encryption (TCP). Boolean value.

    • -

  • "hostsymname": TP8010: NVMe host symbolic name.

    • -
-

Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive -strings. Failed numerical or boolean string conversions will result in the option being ignored.

-

By default additional options are read from the default configuration file /etc/nvme/config.json. -This follows the default behaviour of nvme-cli. Use the extra - "config" argument -to either specify a different config file or disable use of it. The JSON configuration -file format is documented in https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json. -As a rule extra - key names are kept consistent with the JSON config file schema. -Any extra - option generally overrides particular option specified in a configuration file.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

subsysnqn

The name for the NVMe subsystem to connect to.

 

transport

The network fabric used for a NVMe-over-Fabrics network.

 

transport_addr

The network address of the Controller. For transports using IP addressing (e.g. rdma) this should be an IP-based address.

[nullable]

transport_svcid

The transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420.

[nullable]

host_traddr

The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket.

[nullable]

host_iface

The network interface used on the host to connect to the Controller (e.g. IP eth1, enp2s0). This forces the connection to be made on a specific interface instead of letting the system decide.

[nullable]

host_nqn

Overrides the default Host NQN that identifies the NVMe Host. If this option is NULL, the default is read from /etc/nvme/hostnqn first. -If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host.

[nullable]

host_id

User-defined host UUID or NULL to use default (as defined in /etc/nvme/hostid).

[nullable]

extra

Additional arguments.

[nullable][array zero-terminated=1]

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the subsystem was connected successfully, FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR

-
-
-
-
-

bd_nvme_disconnect ()

-
gboolean
-bd_nvme_disconnect (const gchar *subsysnqn,
-                    GError **error);
-

Disconnects and removes one or more existing NVMe over Fabrics controllers. -This may disconnect multiple controllers with matching subsysnqn - and TRUE -is only returned when all controllers were disconnected successfully.

-
-

Parameters

-
----- - - - - - - - - - - - - -

subsysnqn

The name of the NVMe subsystem to disconnect.

 

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if all matching controllers were disconnected successfully, FALSE with error -set in case of a disconnect error or when no matching controllers were found.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR

-
-
-
-
-

bd_nvme_disconnect_by_path ()

-
gboolean
-bd_nvme_disconnect_by_path (const gchar *path,
-                            GError **error);
-

Disconnects and removes a NVMe over Fabrics controller represented -by a block device path.

-
-

Parameters

-
----- - - - - - - - - - - - - -

path

NVMe controller device to disconnect (e.g. /dev/nvme0).

 

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

TRUE if the controller was disconnected successfully, -FALSE otherwise with error -set.

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR

-
-
-
-
-

bd_nvme_discovery_log_entry_copy ()

-
BDNVMEDiscoveryLogEntry *
-bd_nvme_discovery_log_entry_copy (BDNVMEDiscoveryLogEntry *entry);
-

Creates a new copy of entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMEDiscoveryLogEntry to copy.

[nullable]
-
-
-
-
-

bd_nvme_discovery_log_entry_free ()

-
void
-bd_nvme_discovery_log_entry_free (BDNVMEDiscoveryLogEntry *entry);
-

Frees entry -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

entry

BDNVMEDiscoveryLogEntry to free.

[nullable]
-
-
-
-
-

bd_nvme_discover ()

-
BDNVMEDiscoveryLogEntry **
-bd_nvme_discover (const gchar *discovery_ctrl,
-                  gboolean persistent,
-                  const gchar *transport,
-                  const gchar *transport_addr,
-                  const gchar *transport_svcid,
-                  const gchar *host_traddr,
-                  const gchar *host_iface,
-                  const gchar *host_nqn,
-                  const gchar *host_id,
-                  const BDExtraArg **extra,
-                  GError **error);
-

Performs Discovery request on a Discovery Controller. If no connection to a Discovery Controller -exists (i.e. discovery_ctrl - is NULL) a new connection is established as specified by the transport -, -transport_addr - and optionally transport_svcid - arguments.

-

Note that the nvme-cli's /etc/nvme/discovery.conf config file is not used at the moment.

-

Valid values for transport - include:

-
    -

  • "rdma": An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.)

    • -

  • "fc": A Fibre Channel network.

    • -

  • "tcp": A TCP/IP network.

    • -

  • "loop": A NVMe over Fabrics target on the local host.

    • -
-

In addition to the primary options it's possible to supply extra - arguments:

-
    -

  • "config": Use the specified JSON configuration file instead of the default file (see below) or - specify "none" to avoid reading any configuration file.

    • -

  • "dhchap_key": NVMe In-band authentication secret in ASCII format as described - in the NVMe 2.0 specification. When not specified, the secret is by default read - from /etc/nvme/hostkey. In case that file does not exist no in-band authentication - is attempted.

    • -

  • "dhchap_ctrl_key": NVMe In-band authentication controller secret for bi-directional authentication. - When not specified, no bi-directional authentication is attempted.

    • -

  • "nr_io_queues": The number of I/O queues.

    • -

  • "nr_write_queues": Number of additional queues that will be used for write I/O.

    • -

  • "nr_poll_queues": Number of additional queues that will be used for polling latency sensitive I/O.

    • -

  • "queue_size": Number of elements in the I/O queues.

    • -

  • "keep_alive_tmo": The keep alive timeout (in seconds).

    • -

  • "reconnect_delay": The delay (in seconds) before reconnect is attempted after a connect loss.

    • -

  • "ctrl_loss_tmo": The controller loss timeout period (in seconds). A special value of -1 will cause reconnecting forever.

    • -

  • "fast_io_fail_tmo": Fast I/O Fail timeout (in seconds).

    • -

  • "tos": Type of service.

    • -

  • "duplicate_connect": Allow duplicated connections between same transport host and subsystem port. Boolean value.

    • -

  • "disable_sqflow": Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value.

    • -

  • "hdr_digest": Generates/verifies header digest (TCP). Boolean value.

    • -

  • "data_digest": Generates/verifies data digest (TCP). Boolean value.

    • -

  • "tls": Enable TLS encryption (TCP). Boolean value.

    • -

  • "hostsymname": TP8010: NVMe host symbolic name.

    • -
-

Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive -strings. Failed numerical or boolean string conversions will result in the option being ignored.

-

By default additional options are read from the default configuration file /etc/nvme/config.json. -This follows the default behaviour of nvme-cli. Use the extra - "config" argument -to either specify a different config file or disable use of it. The JSON configuration -file format is documented in https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json. -As a rule extra - key names are kept consistent with the JSON config file schema. -Any extra - option generally overrides particular option specified in a configuration file.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

discovery_ctrl

Use existing discovery controller device or NULL to establish a new connection.

[nullable]

persistent

Persistent discovery connection.

 

transport

The network fabric used for a NVMe-over-Fabrics network.

 

transport_addr

The network address of the Controller. For transports using IP addressing (e.g. rdma) this should be an IP-based address.

[nullable]

transport_svcid

The transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420.

[nullable]

host_traddr

The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket.

[nullable]

host_iface

The network interface used on the host to connect to the Controller (e.g. IP eth1, enp2s0). This forces the connection to be made on a specific interface instead of letting the system decide.

[nullable]

host_nqn

Overrides the default Host NQN that identifies the NVMe Host. If this option is NULL, the default is read from /etc/nvme/hostnqn first. -If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host.

[nullable]

host_id

User-defined host UUID or NULL to use default (as defined in /etc/nvme/hostid).

[nullable]

extra

Additional arguments.

[nullable][array zero-terminated=1]

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

null-terminated list -of discovery log entries or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_nvme_find_ctrls_for_ns ()

-
gchar **
-bd_nvme_find_ctrls_for_ns (const gchar *ns_sysfs_path,
-                           const gchar *subsysnqn,
-                           const gchar *host_nqn,
-                           const gchar *host_id,
-                           GError **error);
-

A convenient utility function to look up all controllers associated - with a NVMe subsystem the specified namespace is part of.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ns_sysfs_path

NVMe namespace device file.

 

subsysnqn

Limit matching to the specified subsystem NQN.

[nullable]

host_nqn

Limit matching to the specified host NQN.

[nullable]

host_id

Limit matching to the specified host ID.

[nullable]

error

Place to store error (if any).

[out][nullable]
-
-
-

Returns

-

list of controller sysfs paths -or NULL in case of an error (with error -set).

-

Tech category: BD_NVME_TECH_FABRICS-BD_NVME_TECH_MODE_INITIATOR.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

Types and Values

-
-

BD_NVME_ERROR

-
#define             BD_NVME_ERROR
-
-
-
-

enum BDNVMEError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_ERROR_TECH_UNAVAIL

 -

NVMe support not available.

-		 

BD_NVME_ERROR_FAILED

 -

General error.

-		 

BD_NVME_ERROR_BUSY

 -

The device is temporarily unavailable or in an inconsistent state.

-		 

BD_NVME_ERROR_INVALID_ARGUMENT

 -

Invalid argument.

-		 

BD_NVME_ERROR_WOULD_FORMAT_ALL_NS

 -

The NVMe controller indicates that it would format all namespaces in the NVM subsystem.

-		 

BD_NVME_ERROR_SC_GENERIC

 -

Generic NVMe Command Status Code.

-		 

BD_NVME_ERROR_SC_CMD_SPECIFIC

 -

NVMe Command Specific error.

-		 

BD_NVME_ERROR_SC_MEDIA

 -

Media and Data Integrity Errors: media specific errors that occur in the NVM or data integrity type errors.

-		 

BD_NVME_ERROR_SC_PATH

 -

Path related error.

-		 

BD_NVME_ERROR_SC_VENDOR_SPECIFIC

 -

NVMe Vendor specific error.

-		 

BD_NVME_ERROR_NO_MATCH

 -

No matching resource found (e.g. a Fabrics Controller).

-		 

BD_NVME_ERROR_CONNECT

 -

General connection error.

-		 

BD_NVME_ERROR_CONNECT_ALREADY

 -

Already connected.

-		 

BD_NVME_ERROR_CONNECT_INVALID

 -

Invalid argument specified.

-		 

BD_NVME_ERROR_CONNECT_ADDRINUSE

 -

HostNQN already in use.

-		 

BD_NVME_ERROR_CONNECT_NODEV

 -

Invalid interface.

-		 

BD_NVME_ERROR_CONNECT_OPNOTSUPP

 -

Operation not supported.

-		 
-
-
-
-
-

enum BDNVMETech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_NVME_TECH_NVME

  

BD_NVME_TECH_FABRICS

  
-
-
-
-
-

enum BDNVMETechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_NVME_TECH_MODE_INFO

  

BD_NVME_TECH_MODE_MANAGE

  

BD_NVME_TECH_MODE_INITIATOR

  
-
-
-
-
-

enum BDNVMEControllerFeature

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_CTRL_FEAT_MULTIPORT

 -

if set, then the NVM subsystem may contain more than one NVM subsystem port, otherwise it's single-port only.

-		 

BD_NVME_CTRL_FEAT_MULTICTRL

 -

if set, then the NVM subsystem may contain two or more controllers, otherwise contains only single controller.

-		 

BD_NVME_CTRL_FEAT_SRIOV

 -

if set, then the controller is associated with an SR-IOV Virtual Function, otherwise it's associated with a PCI Function or a Fabrics connection.

-		 

BD_NVME_CTRL_FEAT_ANA_REPORTING

 -

indicates that the NVM subsystem supports Asymmetric Namespace Access (ANA) Reporting.

-		 

BD_NVME_CTRL_FEAT_FORMAT

 -

indicates that the controller supports the Format NVM command.

-		 

BD_NVME_CTRL_FEAT_FORMAT_ALL_NS

 -

if set, then a format (excluding secure erase) of any namespace results in a format of all namespaces -in an NVM subsystem with all namespaces in an NVM subsystem configured with the same attributes. -If not set, then the controller supports format on a per namespace basis.

-		 

BD_NVME_CTRL_FEAT_NS_MGMT

 -

indicates that the controller supports the Namespace Management and Attachment capability.

-		 

BD_NVME_CTRL_FEAT_SELFTEST

 -

indicates that the controller supports the Device Self-test command.

-		 

BD_NVME_CTRL_FEAT_SELFTEST_SINGLE

 -

indicates that the NVM subsystem supports only one device self-test operation in progress at a time.

-		 

BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO

 -

indicates that the controller supports the Crypto Erase sanitize operation.

-		 

BD_NVME_CTRL_FEAT_SANITIZE_BLOCK

 -

indicates that the controller supports the Block Erase sanitize operation.

-		 

BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE

 -

indicates that the controller supports the Overwrite sanitize operation.

-		 

BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS

 -

if set, then any secure erase performed as part of a format operation -results in a secure erase of all namespaces in the NVM subsystem. If not set, -then any secure erase performed as part of a format results in a secure erase -of the particular namespace specified.

-		 

BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO

 -

indicates that the cryptographic erase is supported.

-		 

BD_NVME_CTRL_FEAT_STORAGE_DEVICE

 -

indicates that the NVM subsystem is part of an NVMe Storage Device.

-		 

BD_NVME_CTRL_FEAT_ENCLOSURE

 -

indicates that the NVM subsystem is part of an NVMe Enclosure.

-		 

BD_NVME_CTRL_FEAT_MGMT_PCIE

 -

indicates that the NVM subsystem contains a Management Endpoint on a PCIe port.

-		 

BD_NVME_CTRL_FEAT_MGMT_SMBUS

 -

indicates that the NVM subsystem contains a Management Endpoint on an SMBus/I2C port.

-		 
-
-
-
-
-

enum BDNVMEControllerType

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_CTRL_TYPE_UNKNOWN

 -

Controller type not reported (as reported by older NVMe-compliant devices).

-		 

BD_NVME_CTRL_TYPE_IO

 -

I/O controller.

-		 

BD_NVME_CTRL_TYPE_DISCOVERY

 -

Discovery controller.

-		 

BD_NVME_CTRL_TYPE_ADMIN

 -

Administrative controller.

-		 
-
-
-
-
-

BDNVMEControllerInfo

-
typedef struct {
-    guint16 pci_vendor_id;
-    guint16 pci_subsys_vendor_id;
-    guint16 ctrl_id;
-    gchar *fguid;
-    gchar *model_number;
-    gchar *serial_number;
-    gchar *firmware_ver;
-    gchar *nvme_ver;
-    guint64 features;
-    BDNVMEControllerType controller_type;
-    gint selftest_ext_time;
-    guint64 hmb_pref_size;
-    guint64 hmb_min_size;
-    guint64 size_total;
-    guint64 size_unalloc;
-    guint num_namespaces;
-    gchar *subsysnqn;
-} BDNVMEControllerInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint16 pci_vendor_id;

The PCI Vendor ID.

 

guint16 pci_subsys_vendor_id;

The PCI Subsystem Vendor ID.

 

guint16 ctrl_id;

Controller ID, the NVM subsystem unique controller identifier associated with the controller.

 

gchar *fguid;

FRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit.

 

gchar *model_number;

The model number.

 

gchar *serial_number;

The serial number.

 

gchar *firmware_ver;

The currently active firmware revision.

 

gchar *nvme_ver;

The NVM Express base specification that the controller implementation supports.

 

guint64 features;

features and capabilities present for this controller, see BDNVMEControllerFeature.

 

BDNVMEControllerType controller_type;

The controller type.

 

gint selftest_ext_time;

Extended Device Self-test Time, if BD_NVME_CTRL_FEAT_SELFTEST is supported then this field -indicates the nominal amount of time in one minute units that the controller takes -to complete an extended device self-test operation when in power state 0.

 

guint64 hmb_pref_size;

Host Memory Buffer Preferred Size indicates the preferred size that the host -is requested to allocate for the Host Memory Buffer feature in bytes.

 

guint64 hmb_min_size;

Host Memory Buffer Minimum Size indicates the minimum size that the host -is requested to allocate for the Host Memory Buffer feature in bytes.

 

guint64 size_total;

Total NVM Capacity in the NVM subsystem in bytes.

 

guint64 size_unalloc;

Unallocated NVM Capacity in the NVM subsystem in bytes.

 

guint num_namespaces;

Maximum Number of Allowed Namespaces supported by the NVM subsystem.

 

gchar *subsysnqn;

NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string.

 
-
-
-
-
-

enum BDNVMELBAFormatRelativePerformance

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_UNKNOWN

 -

Unknown relative performance index.

-		 

BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BEST

 -

Best performance.

-		 

BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BETTER

 -

Better performance.

-		 

BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_GOOD

 -

Good performance.

-		 

BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_DEGRADED

 -

Degraded performance.

-		 
-
-
-
-
-

BDNVMELBAFormat

-
typedef struct {
-    guint16 data_size;
-    BDNVMELBAFormatRelativePerformance relative_performance;
-} BDNVMELBAFormat;
-
-
-

Members

-
----- - - - - - - - - - - - - -

guint16 data_size;

LBA data size (i.e. a sector size) in bytes.

 

BDNVMELBAFormatRelativePerformance relative_performance;

Relative Performance index, see BDNVMELBAFormatRelativePerformance.

 
-
-
-
-
-

enum BDNVMENamespaceFeature

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_NVME_NS_FEAT_THIN

 -

indicates that the namespace supports thin provisioning. Specifically, the Namespace Capacity -reported may be less than the Namespace Size.

-		 

BD_NVME_NS_FEAT_MULTIPATH_SHARED

 -

indicates the capability to attach the namespace to two or more controllers -in the NVM subsystem concurrently.

-		 

BD_NVME_NS_FEAT_FORMAT_PROGRESS

 -

indicates the capability to report the percentage of the namespace -that remains to be formatted.

-		 
-
-
-
-
-

BDNVMENamespaceInfo

-
typedef struct {
-    guint32 nsid;
-    gchar *eui64;
-    gchar *uuid;
-    gchar *nguid;
-    guint64 nsize;
-    guint64 ncap;
-    guint64 nuse;
-    guint64 features;
-    guint8 format_progress_remaining;
-    gboolean write_protected;
-    BDNVMELBAFormat **lba_formats;
-    BDNVMELBAFormat current_lba_format;
-} BDNVMENamespaceInfo;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint32 nsid;

The Namespace Identifier (NSID).

 

gchar *eui64;

IEEE Extended Unique Identifier: a 64-bit IEEE Extended Unique Identifier (EUI-64) -that is globally unique and assigned to the namespace when the namespace is created. -Remains fixed throughout the life of the namespace and is preserved across namespace -and controller operations.

 

gchar *uuid;

Namespace 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122.

 

gchar *nguid;

Namespace Globally Unique Identifier: a 128-bit value that is globally unique and -assigned to the namespace when the namespace is created. Remains fixed throughout -the life of the namespace and is preserved across namespace and controller operations.

 

guint64 nsize;

Namespace Size: total size of the namespace in logical blocks. The number of logical blocks -is based on the formatted LBA size (see current_lba_format -).

 

guint64 ncap;

Namespace Capacity: maximum number of logical blocks that may be allocated in the namespace -at any point in time. The number of logical blocks is based on the formatted LBA size (see current_lba_format -).

 

guint64 nuse;

Namespace Utilization: current number of logical blocks allocated in the namespace. -This field is smaller than or equal to the Namespace Capacity. The number of logical -blocks is based on the formatted LBA size (see current_lba_format -).

 

guint64 features;

features and capabilities present for this namespace, see BDNVMENamespaceFeature.

 

guint8 format_progress_remaining;

The percentage value remaining of a format operation in progress.

 

gboolean write_protected;

TRUE if the namespace is currently write protected and all write access to the namespace shall fail.

 

BDNVMELBAFormat **lba_formats;

A list of supported LBA Formats.

[array zero-terminated=1][element-type BDNVMELBAFormat]

BDNVMELBAFormat current_lba_format;

A LBA Format currently used for the namespace. Contains zeroes in case of -an invalid or no supported LBA Format reported.

 
-
-
-
-
-

enum BDNVMESmartCriticalWarning

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_SMART_CRITICAL_WARNING_SPARE

 -

the available spare capacity has fallen below the threshold.

-		 

BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE

 -

a temperature is either greater than or equal to an over temperature threshold; -or less than or equal to an under temperature threshold.

-		 

BD_NVME_SMART_CRITICAL_WARNING_DEGRADED

 -

the NVM subsystem reliability has been degraded due to significant media -related errors or any internal error that degrades NVM subsystem reliability.

-		 

BD_NVME_SMART_CRITICAL_WARNING_READONLY

 -

all of the media has been placed in read only mode. Unrelated to the write -protection state of a namespace.

-		 

BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM

 -

the volatile memory backup device has failed. Valid only if the controller -has a volatile memory backup solution.

-		 

BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY

 -

Persistent Memory Region has become read-only or unreliable.

-		 
-
-
-
-
-

BDNVMESmartLog

-
typedef struct {
-    guint critical_warning;
-    guint8 avail_spare;
-    guint8 spare_thresh;
-    guint8 percent_used;
-    guint64 total_data_read;
-    guint64 total_data_written;
-    guint64 ctrl_busy_time;
-    guint64 power_cycles;
-    guint64 power_on_hours;
-    guint64 unsafe_shutdowns;
-    guint64 media_errors;
-    guint64 num_err_log_entries;
-    guint16 temperature;
-    guint16 temp_sensors[8];
-    guint16 wctemp;
-    guint16 cctemp;
-    guint warning_temp_time;
-    guint critical_temp_time;
-} BDNVMESmartLog;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint critical_warning;

critical warnings for the state of the controller, see BDNVMESmartCriticalWarning.

 

guint8 avail_spare;

Available Spare: a normalized percentage (0% to 100%) of the remaining spare capacity available.

 

guint8 spare_thresh;

Available Spare Threshold: a normalized percentage (0% to 100%) of the available spare threshold.

 

guint8 percent_used;

Percentage Used: a vendor specific estimate of the percentage drive life used based on the -actual usage and the manufacturer's prediction. A value of 100 indicates that the estimated -endurance has been consumed, but may not indicate an NVM subsystem failure. -The value is allowed to exceed 100.

 

guint64 total_data_read;

An estimated calculation of total data read in bytes based on calculation of data -units read from the host. A value of 0 indicates that the number of Data Units Read -is not reported.

 

guint64 total_data_written;

An estimated calculation of total data written in bytes based on calculation -of data units written by the host. A value of 0 indicates that the number -of Data Units Written is not reported.

 

guint64 ctrl_busy_time;

Amount of time the controller is busy with I/O commands, reported in minutes.

 

guint64 power_cycles;

The number of power cycles.

 

guint64 power_on_hours;

The number of power-on hours, excluding a non-operational power state.

 

guint64 unsafe_shutdowns;

The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power.

 

guint64 media_errors;

Media and Data Integrity Errors: the number of occurrences where the controller detected -an unrecovered data integrity error (e.g. uncorrectable ECC, CRC checksum failure, or LBA tag mismatch).

 

guint64 num_err_log_entries;

Number of Error Information Log Entries: the number of Error Information log -entries over the life of the controller.

 

guint16 temperature;

Composite Temperature: temperature in Kelvins that represents the current composite -temperature of the controller and associated namespaces or 0 when not applicable.

 

guint16 temp_sensors[8];

Temperature Sensor 1-8: array of the current temperature reported by temperature sensors -1-8 in Kelvins or 0 when the particular sensor is not available.

 

guint16 wctemp;

Warning Composite Temperature Threshold (WCTEMP): indicates the minimum Composite Temperature (temperature -) -value that indicates an overheating condition during which controller operation continues. -A value of 0 indicates that no warning temperature threshold value is reported by the controller.

 

guint16 cctemp;

Critical Composite Temperature Threshold (CCTEMP): indicates the minimum Composite Temperature (temperature -) -value that indicates a critical overheating condition (e.g., may prevent continued normal operation, -possibility of data loss, automatic device shutdown, extreme performance throttling, or permanent damage). -A value of 0 indicates that no critical temperature threshold value is reported by the controller.

 

guint warning_temp_time;

Warning Composite Temperature Time: the amount of time in minutes that the Composite Temperature (temperature -) -is greater than or equal to the Warning Composite Temperature Threshold (wctemp -) and less than the -Critical Composite Temperature Threshold (cctemp -).

 

guint critical_temp_time;

Critical Composite Temperature Time: the amount of time in minutes that the Composite Temperature (temperature -) -is greater than or equal to the Critical Composite Temperature Threshold (cctemp -).

 
-
-
-
-
-

enum BDNVMETransportType

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_TRANSPORT_TYPE_UNSPECIFIED

 -

Not indicated

-		 

BD_NVME_TRANSPORT_TYPE_RDMA

 -

RDMA Transport

-		 

BD_NVME_TRANSPORT_TYPE_FC

 -

Fibre Channel Transport

-		 

BD_NVME_TRANSPORT_TYPE_TCP

 -

TCP Transport

-		 

BD_NVME_TRANSPORT_TYPE_LOOP

 -

Intra-host Transport (loopback)

-		 
-
-
-
-
-

BDNVMEErrorLogEntry

-
typedef struct {
-    guint64 error_count;
-    guint16 command_id;
-    guint64 command_specific;
-    guint16 command_status;
-    GError *command_error;
-    guint64 lba;
-    guint32 nsid;
-    BDNVMETransportType transport_type;
-} BDNVMEErrorLogEntry;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

guint64 error_count;

internal error counter, a unique identifier for the error.

 

guint16 command_id;

the Command Identifier of the command that the error is associated with or 0xffff if the error is not specific to a particular command.

 

guint64 command_specific;

Command Specific Information specific to command_id -.

 

guint16 command_status;

the Status code for the command that completed.

 

GError *command_error;

translated command error in the BD_NVME_ERROR domain or NULL in case command_status -indicates success.

 

guint64 lba;

the first LBA that experienced the error condition.

 

guint32 nsid;

the NSID of the namespace that the error is associated with.

 

BDNVMETransportType transport_type;

type of the transport associated with the error.

 
-
-
-
-
-

BDNVMESelfTestLog

-
typedef struct {
-    BDNVMESelfTestAction current_operation;
-    guint8 current_operation_completion;
-    BDNVMESelfTestLogEntry **entries;
-} BDNVMESelfTestLog;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BDNVMESelfTestAction current_operation;

Current running device self-test operation. There's no corresponding record in entries -for a device self-test operation that is in progress.

 

guint8 current_operation_completion;

Percentage of the currently running device self-test operation. Only valid when current_operation -is other than BD_NVME_SELF_TEST_ACTION_NOT_RUNNING.

 

BDNVMESelfTestLogEntry **entries;

Self-test log entries for the last 20 operations, sorted from newest (first element) to oldest.

[array zero-terminated=1][element-type BDNVMESelfTestLogEntry]
-
-
-
-
-

BDNVMESelfTestLogEntry

-
typedef struct {
-    BDNVMESelfTestResult result;
-    BDNVMESelfTestAction action;
-    guint8 segment;
-    guint64 power_on_hours;
-    guint32 nsid;
-    guint64 failing_lba;
-    GError *status_code_error;
-} BDNVMESelfTestLogEntry;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BDNVMESelfTestResult result;

Result of the device self-test operation.

 

BDNVMESelfTestAction action;

The Self-test Code value (action) that was specified in the Device Self-test command that started this device self-test operation.

 

guint8 segment;

Segment number where the first self-test failure occurred. Valid only when result -is set to BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL.

 

guint64 power_on_hours;

Number of power-on hours at the time the device self-test operation was completed or aborted. Does not include time that the controller was powered and in a low power state condition.

 

guint32 nsid;

Namespace ID that the Failing LBA occurred on.

 

guint64 failing_lba;

LBA of the logical block that caused the test to fail. If the device encountered more than one failed logical block during the test, then this field only indicates one of those failed logical blocks.

 

GError *status_code_error;

Translated NVMe Command Status Code representing additional information related to errors or conditions.

 
-
-
-
-
-

enum BDNVMESelfTestAction

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_SELF_TEST_ACTION_NOT_RUNNING

 -

No device self-test operation in progress. Not a valid argument for bd_nvme_device_self_test().

-		 

BD_NVME_SELF_TEST_ACTION_SHORT

 -

Start a short device self-test operation.

-		 

BD_NVME_SELF_TEST_ACTION_EXTENDED

 -

Start an extended device self-test operation.

-		 

BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC

 -

Start a vendor specific device self-test operation.

-		 

BD_NVME_SELF_TEST_ACTION_ABORT

 -

Abort the device self-test operation. Only valid for bd_nvme_device_self_test().

-		 
-
-
-
-
-

enum BDNVMESelfTestResult

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_SELF_TEST_RESULT_NO_ERROR

 -

Operation completed without error.

-		 

BD_NVME_SELF_TEST_RESULT_ABORTED

 -

Operation was aborted by a Device Self-test command.

-		 

BD_NVME_SELF_TEST_RESULT_CTRL_RESET

 -

Operation was aborted by a Controller Level Reset.

-		 

BD_NVME_SELF_TEST_RESULT_NS_REMOVED

 -

Operation was aborted due to a removal of a namespace from the namespace inventory.

-		 

BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT

 -

Operation was aborted due to the processing of a Format NVM command.

-		 

BD_NVME_SELF_TEST_RESULT_FATAL_ERROR

 -

A fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete.

-		 

BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL

 -

Operation completed with a segment that failed and the segment that failed is not known.

-		 

BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL

 -

Operation completed with one or more failed segments and the first segment that failed is indicated in the Segment Number field.

-		 

BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN

 -

Operation was aborted for unknown reason.

-		 

BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE

 -

Operation was aborted due to a sanitize operation.

-		 
-
-
-
-
-

enum BDNVMEFormatSecureErase

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_NVME_FORMAT_SECURE_ERASE_NONE

 -

No secure erase operation requested.

-		 

BD_NVME_FORMAT_SECURE_ERASE_USER_DATA

 -

User Data Erase: All user data shall be erased, contents of the user data after the erase is indeterminate -(e.g., the user data may be zero filled, one filled, etc.). If a User Data Erase is requested and all affected -user data is encrypted, then the controller is allowed to use a cryptographic erase to perform the requested User Data Erase.

-		 

BD_NVME_FORMAT_SECURE_ERASE_CRYPTO

 -

Cryptographic Erase: All user data shall be erased cryptographically. This is accomplished by deleting the encryption key.

-		 
-
-
-
-
-

enum BDNVMESanitizeStatus

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED

 -

The NVM subsystem has never been sanitized.

-		 

BD_NVME_SANITIZE_STATUS_IN_PROGESS

 -

A sanitize operation is currently in progress.

-		 

BD_NVME_SANITIZE_STATUS_SUCCESS

 -

The most recent sanitize operation completed successfully including any additional media modification.

-		 

BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC

 -

The most recent sanitize operation for which No-Deallocate After Sanitize was requested has completed successfully with deallocation of all user data.

-		 

BD_NVME_SANITIZE_STATUS_FAILED

 -

The most recent sanitize operation failed.

-		 
-
-
-
-
-

BDNVMESanitizeLog

-
typedef struct {
-    gdouble sanitize_progress;
-    BDNVMESanitizeStatus sanitize_status;
-    gboolean global_data_erased;
-    guint8 overwrite_passes;
-    gint64 time_for_overwrite;
-    gint64 time_for_block_erase;
-    gint64 time_for_crypto_erase;
-    gint64 time_for_overwrite_nd;
-    gint64 time_for_block_erase_nd;
-    gint64 time_for_crypto_erase_nd;
-} BDNVMESanitizeLog;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gdouble sanitize_progress;

The percentage complete of the sanitize operation.

 

BDNVMESanitizeStatus sanitize_status;

The status of the most recent sanitize operation.

 

gboolean global_data_erased;

Indicates that no user data has been written either since the drive was manufactured and -has never been sanitized or since the most recent successful sanitize operation.

 

guint8 overwrite_passes;

Number of completed passes if the most recent sanitize operation was an Overwrite.

 

gint64 time_for_overwrite;

Estimated time in seconds needed to complete an Overwrite sanitize operation with 16 passes in the background. -A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected -to be completed in the background when the Sanitize command is completed.

 

gint64 time_for_block_erase;

Estimated time in seconds needed to complete a Block Erase sanitize operation in the background. -A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected -to be completed in the background when the Sanitize command is completed.

 

gint64 time_for_crypto_erase;

Estimated time in seconds needed to complete a Crypto Erase sanitize operation in the background. -A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected -to be completed in the background when the Sanitize command is completed.

 

gint64 time_for_overwrite_nd;

Estimated time in seconds needed to complete an Overwrite sanitize operation and the associated -additional media modification in the background when the No-Deallocate After Sanitize or -the No-Deallocate Modifies Media After Sanitize features have been requested.

 

gint64 time_for_block_erase_nd;

Estimated time in seconds needed to complete a Block Erase sanitize operation and the associated -additional media modification in the background when the No-Deallocate After Sanitize or -the No-Deallocate Modifies Media After Sanitize features have been requested.

 

gint64 time_for_crypto_erase_nd;

Estimated time in seconds needed to complete a Crypto Erase sanitize operation and the associated -additional media modification in the background when the No-Deallocate After Sanitize or -the No-Deallocate Modifies Media After Sanitize features have been requested.

 
-
-
-
-
-

enum BDNVMESanitizeAction

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_SANITIZE_ACTION_EXIT_FAILURE

 -

Exit Failure Mode.

-		 

BD_NVME_SANITIZE_ACTION_BLOCK_ERASE

 -

Start a Block Erase sanitize operation - a low-level block erase method that is specific to the media.

-		 

BD_NVME_SANITIZE_ACTION_OVERWRITE

 -

Start an Overwrite sanitize operation - writing a fixed data pattern or related patterns in multiple passes.

-		 

BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE

 -

Start a Crypto Erase sanitize operation - changing the media encryption keys for all locations on the media.

-		 
-
-
-
-
-

BDNVMEDiscoveryLogEntry

-
typedef struct {
-    BDNVMETransportType transport_type;
-    BDNVMEAddressFamily address_family;
-    gboolean sq_flow_control_disable;
-    gboolean sq_flow_control_required;
-    guint16 port_id;
-    guint16 ctrl_id;
-    gchar *transport_addr;
-    gchar *transport_svcid;
-    gchar *subsys_nqn;
-    BDNVMETCPSecurity tcp_security;
-} BDNVMEDiscoveryLogEntry;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BDNVMETransportType transport_type;

The NVMe Transport type.

 

BDNVMEAddressFamily address_family;

The address family.

 

gboolean sq_flow_control_disable;

Indicates that the controller is capable of disabling SQ flow control.

 

gboolean sq_flow_control_required;

Indicates that the controller requires use of SQ flow control.

 

guint16 port_id;

A NVM subsystem port. Different NVMe Transports or address families may utilize the same Port ID value (eg. a Port ID may support both iWARP and RoCE).

 

guint16 ctrl_id;

A Controller ID. Special value of 0xFFFF indicates a dynamic controller model and a value of 0xFFFE indicates a temporary ID in a static controller model that should be replaced by a real ID after a connection is established.

 

gchar *transport_addr;

Transport Address.

 

gchar *transport_svcid;

Transport Service Identifier.

 

gchar *subsys_nqn;

Subsystem Qualified Name. For a Discovery Service the value should be the well-known Discovery Service NQN (nqn.2014-08.org.nvmexpress.discovery).

 

BDNVMETCPSecurity tcp_security;

NVMe/TCP transport port security.

 
-
-
-
-
-

enum BDNVMEAddressFamily

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_NVME_ADDRESS_FAMILY_PCI

 -

PCI Express.

-		 

BD_NVME_ADDRESS_FAMILY_INET

 -

AF_INET: IPv4 address family.

-		 

BD_NVME_ADDRESS_FAMILY_INET6

 -

AF_INET6: IPv6 address family.

-		 

BD_NVME_ADDRESS_FAMILY_IB

 -

AF_IB: InfiniBand address family.

-		 

BD_NVME_ADDRESS_FAMILY_FC

 -

Fibre Channel address family.

-		 

BD_NVME_ADDRESS_FAMILY_LOOP

 -

Intra-host Transport (loopback).

-		 
-
-
-
-
-

enum BDNVMETCPSecurity

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_NVME_TCP_SECURITY_NONE

 -

No Security, the host shall set up a normal TCP connection.

-		 

BD_NVME_TCP_SECURITY_TLS12

 -

Transport Layer Security (TLS) version 1.2 (NVMe-oF 1.1).

-		 

BD_NVME_TCP_SECURITY_TLS13

 -

Transport Layer Security (TLS) version 1.3+. The TLS version and cipher is negotiated on every connection.

-		 
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Part.html b/libblockdev/docs/3.0/libblockdev-Part.html deleted file mode 100644 index fd55b92..0000000 --- a/libblockdev/docs/3.0/libblockdev-Part.html +++ /dev/null @@ -1,1914 +0,0 @@ - - - - -Part: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Part

-

Part — plugin for operations with partition tables

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_part_check_deps () -
-gboolean - -bd_part_init () -
-void - -bd_part_close () -
-gboolean - -bd_part_create_table () -
-BDPartSpec * - -bd_part_create_part () -
-gboolean - -bd_part_delete_part () -
-gboolean - -bd_part_resize_part () -
-BDPartSpec ** - -bd_part_get_disk_parts () -
-BDPartSpec * - -bd_part_get_part_spec () -
-gboolean - -bd_part_set_part_flag () -
-BDPartSpec * - -bd_part_spec_copy () -
-void - -bd_part_spec_free () -
-GType - -bd_part_spec_get_type () -
const gchar * - -bd_part_get_flag_str () -
const gchar * - -bd_part_get_part_table_type_str () -
const gchar * - -bd_part_get_type_str () -
-BDPartSpec * - -bd_part_get_best_free_region () -
-BDPartSpec ** - -bd_part_get_disk_free_regions () -
-BDPartDiskSpec * - -bd_part_get_disk_spec () -
-BDPartSpec * - -bd_part_get_part_by_pos () -
-gboolean - -bd_part_set_disk_flag () -
-gboolean - -bd_part_set_part_flags () -
-gboolean - -bd_part_set_part_name () -
-gboolean - -bd_part_set_part_type () -
-gboolean - -bd_part_set_part_id () -
-gchar * - -bd_part_get_part_id () -
-GQuark - -bd_part_error_quark () -
-gboolean - -bd_part_is_tech_avail () -
-BDPartDiskSpec * - -bd_part_disk_spec_copy () -
-void - -bd_part_disk_spec_free () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineBD_PART_ERROR
#defineBD_PART_TYPE_SPEC
enumBDPartAlign
enumBDPartFlag
 BDPartSpec
enumBDPartType
enumBDPartTypeReq
enumBDPartError
enumBDPartTableType
enumBDPartDiskFlag
 BDPartDiskSpec
enumBDPartTech
enumBDPartTechMode
-
-
-

Includes

-
#include <part.h>
-
-
-
-

Description

-

A plugin for operations with partition tables. Currently supported table -(disk label) types are MBR and GPT. See the functions below to get an -overview of which operations are supported. If there's anything missing, -please don't hesitate to report it as this plugin (just like all the others) -is subject to future development and enhancements.

-

This particular implementation of the part plugin uses libfdisk for -manipulations of both the MBR and GPT disk label types.

-
-
-

Functions

-
-

bd_part_check_deps ()

-
gboolean
-bd_part_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_part_init ()

-
gboolean
-bd_part_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_part_close ()

-
void
-bd_part_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_part_create_table ()

-
gboolean
-bd_part_create_table (const gchar *disk,
-                      BDPartTableType type,
-                      gboolean ignore_existing,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

path of the disk block device to create partition table on

 

type

type of the partition table to create

 

ignore_existing

whether to ignore/overwrite the existing table or not -(reports an error if FALSE and there's some table on disk -)

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the partition table was successfully created or not

-

Tech category: BD_PART_TECH_MODE_CREATE_TABLE + the tech according to type -

-
-
-
-
-

bd_part_create_part ()

-
BDPartSpec *
-bd_part_create_part (const gchar *disk,
-                     BDPartTypeReq type,
-                     guint64 start,
-                     guint64 size,
-                     BDPartAlign align,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

disk

disk to create partition on

 

type

type of the partition to create (if BD_PART_TYPE_REQ_NEXT, the -partition type will be determined automatically based on the existing -partitions)

 

start

where the partition should start (i.e. offset from the disk start)

 

size

desired size of the partition (if 0, a max-sized partition is created)

 

align

alignment to use for the partition

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

specification of the created partition or NULL in case of error

-

NOTE: The resulting partition may start at a different position than given by -start -and can have different size than size -due to alignment.

-

Tech category: BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type.

-

[transfer full]

-
-
-
-
-

bd_part_delete_part ()

-
gboolean
-bd_part_delete_part (const gchar *disk,
-                     const gchar *part,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

disk

disk to remove the partition from

 

part

partition to remove

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the part -partition was successfully deleted from disk -

-

Tech category: BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type

-
-
-
-
-

bd_part_resize_part ()

-
gboolean
-bd_part_resize_part (const gchar *disk,
-                     const gchar *part,
-                     guint64 size,
-                     BDPartAlign align,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

disk

disk containing the partition

 

part

partition to resize

 

size

new partition size, 0 for maximal size

 

align

alignment to use for the partition end

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the part -partition was successfully resized on disk -to size -

-

NOTE: The resulting partition may be slightly bigger than requested due to alignment.

-

Tech category: BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type

-
-
-
-
-

bd_part_get_disk_parts ()

-
BDPartSpec **
-bd_part_get_disk_parts (const gchar *disk,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

disk

disk to get information about partitions for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

specs of the partitions from disk -or NULL in case of error

-

Tech category: BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_part_get_part_spec ()

-
BDPartSpec *
-bd_part_get_part_spec (const gchar *disk,
-                       const gchar *part,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

disk

disk to remove the partition from

 

part

partition to get spec for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

spec of the part -partition from disk -or NULL in case of error

-

Tech category: BD_PART_TECH_MODE_QUERY_PART + the tech according to the partition table type.

-

[transfer full]

-
-
-
-
-

bd_part_set_part_flag ()

-
gboolean
-bd_part_set_part_flag (const gchar *disk,
-                       const gchar *part,
-                       BDPartFlag flag,
-                       gboolean state,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

disk

disk the partition belongs to

 

part

partition to set the flag on

 

flag

flag to set

 

state

state to set for the flag -(TRUE = enabled)

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the flag flag -was successfully set on the part -partition -or not.

-

Tech category: BD_PART_TECH_MODE_MODIFY_PART + the tech according to the partition table type

-
-
-
-
-

bd_part_spec_copy ()

-
BDPartSpec *
-bd_part_spec_copy (BDPartSpec *data);
-
-
-
-

bd_part_spec_free ()

-
void
-bd_part_spec_free (BDPartSpec *data);
-
-
-
-

bd_part_spec_get_type ()

-
GType
-bd_part_spec_get_type ();
-
-
-
-

bd_part_get_flag_str ()

-
const gchar *
-bd_part_get_flag_str (BDPartFlag flag,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

flag

flag to get string representation for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

string representation of flag -

-

Tech category: always available.

-

[transfer none]

-
-
-
-
-

bd_part_get_part_table_type_str ()

-
const gchar *
-bd_part_get_part_table_type_str (BDPartTableType type,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

type

table type to get string representation for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

string representation of table_type -

-

Tech category: the tech according to type -.

-

[transfer none]

-
-
-
-
-

bd_part_get_type_str ()

-
const gchar *
-bd_part_get_type_str (BDPartType type,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

type

type to get string representation for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

string representation of type -

-

Tech category: always available.

-

[transfer none]

-
-
-
-
-

bd_part_get_best_free_region ()

-
BDPartSpec *
-bd_part_get_best_free_region (const gchar *disk,
-                              BDPartType type,
-                              guint64 size,
-                              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

disk to get the best free region for

 

type

type of the partition that is planned to be added

 

size

size of the partition to be added

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

spec of the best free region on disk -for a new partition of type type -with the size of size -or NULL if there is none such region or if -there was an error (error -gets populated)

-

Note: For the type -BD_PART_TYPE_NORMAL, the smallest possible space that *is not* in an extended partition -is found. For the type -BD_PART_TYPE_LOGICAL, the smallest possible space that *is* in an extended -partition is found. For BD_PART_TYPE_EXTENDED, the biggest possible space is found as long as there -is no other extended partition (there can only be one).

-

Tech category: BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type.

-

[transfer full]

-
-
-
-
-

bd_part_get_disk_free_regions ()

-
BDPartSpec **
-bd_part_get_disk_free_regions (const gchar *disk,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

disk

disk to get free regions for

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

specs of the free regions from disk -or NULL in case of error

-

Tech category: BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_part_get_disk_spec ()

-
BDPartDiskSpec *
-bd_part_get_disk_spec (const gchar *disk,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

disk

disk to get information about

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

information about the given disk -or NULL (in case of error)

-

Tech category: BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type.

-

[transfer full]

-
-
-
-
-

bd_part_get_part_by_pos ()

-
BDPartSpec *
-bd_part_get_part_by_pos (const gchar *disk,
-                         guint64 position,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

disk

disk to remove the partition from

 

position

position (in bytes) determining the partition

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

spec of the partition from disk -spanning over the position -or NULL if no such -partition exists or in case of error (error -is set)

-

Tech category: BD_PART_TECH_MODE_QUERY_PART + the tech according to the partition table type.

-

[transfer full]

-
-
-
-
-

bd_part_set_disk_flag ()

-
gboolean
-bd_part_set_disk_flag (const gchar *disk,
-                       BDPartDiskFlag flag,
-                       gboolean state,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

disk the partition belongs to

 

flag

flag to set

 

state

state to set for the flag -(TRUE = enabled)

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the flag flag -was successfully set on the disk -or not

-

Tech category: BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type

-
-
-
-
-

bd_part_set_part_flags ()

-
gboolean
-bd_part_set_part_flags (const gchar *disk,
-                        const gchar *part,
-                        guint64 flags,
-                        GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

disk the partition belongs to

 

part

partition to set the flag on

 

flags

flags to set (mask combined from BDPartFlag numbers)

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the flags -were successfully set on the part -partition or -not

-

Note: Unsets all the other flags on the partition. -Only GPT-specific flags and the legacy boot flag are supported on GPT -partition tables.

-

Tech category: BD_PART_TECH_MODE_MODIFY_PART + the tech according to the partition table type

-
-
-
-
-

bd_part_set_part_name ()

-
gboolean
-bd_part_set_part_name (const gchar *disk,
-                       const gchar *part,
-                       const gchar *name,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

device the partition belongs to

 

part

partition the should be set for

 

name

name to set

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the name was successfully set or not

-

Tech category: BD_PART_TECH_GPT-BD_PART_TECH_MODE_MODIFY_PART

-
-
-
-
-

bd_part_set_part_type ()

-
gboolean
-bd_part_set_part_type (const gchar *disk,
-                       const gchar *part,
-                       const gchar *type_guid,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

device the partition belongs to

 

part

partition the should be set for

 

type_guid

GUID of the type

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the type_guid -type was successfully set for part -or not

-

Tech category: BD_PART_TECH_GPT-BD_PART_TECH_MODE_MODIFY_PART

-
-
-
-
-

bd_part_set_part_id ()

-
gboolean
-bd_part_set_part_id (const gchar *disk,
-                     const gchar *part,
-                     const gchar *part_id,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

disk

device the partition belongs to

 

part

partition the should be set for

 

part_id

partition Id

 

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the part_id -type was successfully set for part -or not

-

Tech category: BD_PART_TECH_MODE_MODIFY_PART + the tech according to the partition table type

-
-
-
-
-

bd_part_get_part_id ()

-
gchar *
-bd_part_get_part_id (const gchar *disk,
-                     const gchar *part,
-                     GError **error);
-

Returns (transfer full): partition id type or NULL in case of error

-

Tech category: BD_PART_TECH_MODE_QUERY_PART + the tech according to the partition table type

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

disk

device the partition belongs to

 

part

partition the should be set for

 

error

place to store error (if any).

[out]
-
-
-
-
-

bd_part_error_quark ()

-
GQuark
-bd_part_error_quark (void);
-

[skip]

-
-
-
-

bd_part_is_tech_avail ()

-
gboolean
-bd_part_is_tech_avail (BDPartTech tech,
-                       guint64 mode,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDPartTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

bd_part_disk_spec_copy ()

-
BDPartDiskSpec *
-bd_part_disk_spec_copy (BDPartDiskSpec *data);
-
-
-
-

bd_part_disk_spec_free ()

-
void
-bd_part_disk_spec_free (BDPartDiskSpec *data);
-
-
-
-

Types and Values

-
-

BD_PART_ERROR

-
#define             BD_PART_ERROR
-
-
-
-

BD_PART_TYPE_SPEC

-
#define BD_PART_TYPE_SPEC (bd_part_spec_get_type ())
-
-
-
-
-

enum BDPartAlign

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_PART_ALIGN_MINIMAL

  

BD_PART_ALIGN_OPTIMAL

  

BD_PART_ALIGN_NONE

  
-
-
-
-
-

enum BDPartFlag

-

Partition flags supported by libblockdev. First part of the flags (up to -BD_PART_FLAG_BASIC_LAST -) corresponds to the flags supported by libparted -(see https://www.gnu.org/software/parted/manual/parted.htmlset). Second -part corresponds to the flags supported by sgdisk (GPT, see sgdisk -A=list).

-

The only exception from the above is BD_PART_FLAG_LEGACY_BOOT - which is -supported by libparted too but is GPT specific.

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_PART_FLAG_BOOT

  

BD_PART_FLAG_ROOT

  

BD_PART_FLAG_SWAP

  

BD_PART_FLAG_HIDDEN

  

BD_PART_FLAG_RAID

  

BD_PART_FLAG_LVM

  

BD_PART_FLAG_LBA

  

BD_PART_FLAG_HPSERVICE

  

BD_PART_FLAG_CPALO

  

BD_PART_FLAG_PREP

  

BD_PART_FLAG_MSFT_RESERVED

  

BD_PART_FLAG_BIOS_GRUB

  

BD_PART_FLAG_APPLE_TV_RECOVERY

  

BD_PART_FLAG_DIAG

  

BD_PART_FLAG_LEGACY_BOOT

  

BD_PART_FLAG_MSFT_DATA

  

BD_PART_FLAG_IRST

  

BD_PART_FLAG_ESP

  

BD_PART_FLAG_BASIC_LAST

  

BD_PART_FLAG_GPT_SYSTEM_PART

  

BD_PART_FLAG_GPT_READ_ONLY

  

BD_PART_FLAG_GPT_HIDDEN

  

BD_PART_FLAG_GPT_NO_AUTOMOUNT

  
-
-
-
-
-

BDPartSpec

-
typedef struct {
-    gchar *path;
-    gchar *name;
-    gchar *type_guid;
-    guint64 type;
-    guint64 start;
-    guint64 size;
-    guint64 flags;
-} BDPartSpec;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *path;

path of the partition (block device)

 

gchar *name;

name of the partition (for GPT partitions)

 

gchar *type_guid;

GUID of the partition's type (GPT)

 

guint64 type;

bit combination of partition's types (BDPartType)

 

guint64 start;

start of the partition

 

guint64 size;

size of the partition

 

guint64 flags;

bit combination of partition's flags (BDPartFlag)

 
-
-
-
-
-

enum BDPartType

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_PART_TYPE_NORMAL

  

BD_PART_TYPE_LOGICAL

  

BD_PART_TYPE_EXTENDED

  

BD_PART_TYPE_FREESPACE

  

BD_PART_TYPE_METADATA

  

BD_PART_TYPE_PROTECTED

  
-
-
-
-
-

enum BDPartTypeReq

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_PART_TYPE_REQ_NORMAL

  

BD_PART_TYPE_REQ_LOGICAL

  

BD_PART_TYPE_REQ_EXTENDED

  

BD_PART_TYPE_REQ_NEXT

  
-
-
-
-
-

enum BDPartError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_PART_ERROR_EXISTS

  

BD_PART_ERROR_INVAL

  

BD_PART_ERROR_FAIL

  

BD_PART_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

enum BDPartTableType

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_PART_TABLE_MSDOS

  

BD_PART_TABLE_GPT

  

BD_PART_TABLE_UNDEF

  
-
-
-
-
-

enum BDPartDiskFlag

-
-

Members

-
----- - - - - - -

BD_PART_DISK_FLAG_GPT_PMBR_BOOT

  
-
-
-
-
-

BDPartDiskSpec

-
typedef struct {
-    gchar *path;
-    BDPartTableType table_type;
-    guint64 size;
-    guint64 sector_size;
-    guint64 flags;
-} BDPartDiskSpec;
-
-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gchar *path;

path of the disk (block device)

 

BDPartTableType table_type;

type of the disk's partition table

 

guint64 size;

size of the disk

 

guint64 sector_size;

disk's sector size

 

guint64 flags;

bit combination of the disk's flags (BDPartDiskFlag)

 
-
-
-
-
-

enum BDPartTech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_PART_TECH_MBR

  

BD_PART_TECH_GPT

  
-
-
-
-
-

enum BDPartTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_PART_TECH_MODE_CREATE_TABLE

  

BD_PART_TECH_MODE_MODIFY_TABLE

  

BD_PART_TECH_MODE_QUERY_TABLE

  

BD_PART_TECH_MODE_MODIFY_PART

  

BD_PART_TECH_MODE_QUERY_PART

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Plugins.html b/libblockdev/docs/3.0/libblockdev-Plugins.html deleted file mode 100644 index 9fc9cc0..0000000 --- a/libblockdev/docs/3.0/libblockdev-Plugins.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - -Plugins: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Plugins

-

Plugins — functions related to querying plugins

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-BDPluginSpec * - -bd_plugin_spec_copy () -
-void - -bd_plugin_spec_free () -
-gboolean - -bd_is_plugin_available () -
-gchar ** - -bd_get_available_plugin_names () -
-gchar * - -bd_get_plugin_soname () -
-gchar * - -bd_get_plugin_name () -
-
-
-

Types and Values

-
---- - - - - -
enumBDPlugin
-
-
-

Includes

-
#include <blockdev.h>
-
-
-
-

Description

-
-
-

Functions

-
-

bd_plugin_spec_copy ()

-
BDPluginSpec *
-bd_plugin_spec_copy (BDPluginSpec *spec);
-

Creates a new copy of spec -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

spec

BDPluginSpec to copy.

[nullable]
-
-
-
-
-

bd_plugin_spec_free ()

-
void
-bd_plugin_spec_free (BDPluginSpec *spec);
-

Frees spec -.

-

[skip]

-
-

Parameters

-
----- - - - - - -

spec

BDPluginSpec to free.

[nullable]
-
-
-
-
-

bd_is_plugin_available ()

-
gboolean
-bd_is_plugin_available (BDPlugin plugin);
-
-

Parameters

-
----- - - - - - -

plugin

the queried plugin

 
-
-
-

Returns

-

whether the given plugin is available or not

-
-
-
-
-

bd_get_available_plugin_names ()

-
gchar **
-bd_get_available_plugin_names (void);
-
-

Returns

-

an array of string -names of plugins that are available.

-

[transfer container][array zero-terminated=1]

-
-
-
-
-

bd_get_plugin_soname ()

-
gchar *
-bd_get_plugin_soname (BDPlugin plugin);
-
-

Parameters

-
----- - - - - - -

plugin

the queried plugin

 
-
-
-

Returns

-

name of the shared object loaded for the plugin or -NULL if none is loaded.

-

[transfer full]

-
-
-
-
-

bd_get_plugin_name ()

-
gchar *
-bd_get_plugin_name (BDPlugin plugin);
-
-

Parameters

-
----- - - - - - -

plugin

the queried plugin

 
-
-
-

Returns

-

name of the plugin.

-

[transfer none]

-
-
-
-
-

Types and Values

-
-

enum BDPlugin

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_PLUGIN_LVM

  

BD_PLUGIN_BTRFS

  

BD_PLUGIN_SWAP

  

BD_PLUGIN_LOOP

  

BD_PLUGIN_CRYPTO

  

BD_PLUGIN_MPATH

  

BD_PLUGIN_DM

  

BD_PLUGIN_MDRAID

  

BD_PLUGIN_KBD

  

BD_PLUGIN_S390

  

BD_PLUGIN_PART

  

BD_PLUGIN_FS

  

BD_PLUGIN_NVDIMM

  

BD_PLUGIN_NVME

  

BD_PLUGIN_UNDEF

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Swap.html b/libblockdev/docs/3.0/libblockdev-Swap.html deleted file mode 100644 index de77b64..0000000 --- a/libblockdev/docs/3.0/libblockdev-Swap.html +++ /dev/null @@ -1,556 +0,0 @@ - - - - -Swap: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Swap

-

Swap — plugin for operations with swap space

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_swap_check_deps () -
-gboolean - -bd_swap_init () -
-void - -bd_swap_close () -
-GQuark - -bd_swap_error_quark () -
-gboolean - -bd_swap_mkswap () -
-gboolean - -bd_swap_swapon () -
-gboolean - -bd_swap_swapoff () -
-gboolean - -bd_swap_swapstatus () -
-gboolean - -bd_swap_set_label () -
-gboolean - -bd_swap_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - -
#defineBD_SWAP_ERROR
enumBDSwapError
enumBDSwapTech
enumBDSwapTechMode
-
-
-

Includes

-
#include <swap.h>
-
-
-
-

Description

-

A plugin for operations with swap space.

-
-
-

Functions

-
-

bd_swap_check_deps ()

-
gboolean
-bd_swap_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_swap_init ()

-
gboolean
-bd_swap_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_swap_close ()

-
void
-bd_swap_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_swap_error_quark ()

-
GQuark
-bd_swap_error_quark (void);
-

[skip]

-
-
-
-

bd_swap_mkswap ()

-
gboolean
-bd_swap_mkswap (const gchar *device,
-                const gchar *label,
-                const BDExtraArg **extra,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

device

a device to create swap space on

 

label

a label for the swap space device.

[nullable]

extra

extra options for the creation (right now -passed to the 'mkswap' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the swap space was successfully created or not

-

Tech category: BD_SWAP_TECH_SWAP-BD_SWAP_TECH_MODE_CREATE

-
-
-
-
-

bd_swap_swapon ()

-
gboolean
-bd_swap_swapon (const gchar *device,
-                gint priority,
-                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

swap device to activate

 

priority

priority of the activated device or -1 to use the default

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the swap device was successfully activated or not

-

Tech category: BD_SWAP_TECH_SWAP-BD_SWAP_TECH_MODE_ACTIVATE_DEACTIVATE

-
-
-
-
-

bd_swap_swapoff ()

-
gboolean
-bd_swap_swapoff (const gchar *device,
-                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

swap device to deactivate

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the swap device was successfully deactivated or not

-

Tech category: BD_SWAP_TECH_SWAP-BD_SWAP_TECH_MODE_ACTIVATE_DEACTIVATE

-
-
-
-
-

bd_swap_swapstatus ()

-
gboolean
-bd_swap_swapstatus (const gchar *device,
-                    GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

device

swap device to get status of

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

TRUE if the swap device is active, FALSE if not active or failed -to determine (error -) is set not a non-NULL value in such case)

-

Tech category: BD_SWAP_TECH_SWAP-BD_SWAP_TECH_MODE_QUERY

-
-
-
-
-

bd_swap_set_label ()

-
gboolean
-bd_swap_set_label (const gchar *device,
-                   const gchar *label,
-                   GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

device

a device to set label on

 

label

label that will be set

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the label was successfully set or not

-

Tech category: BD_SWAP_TECH_SWAP-BD_SWAP_TECH_MODE_SET_LABEL

-
-
-
-
-

bd_swap_is_tech_avail ()

-
gboolean
-bd_swap_is_tech_avail (BDSwapTech tech,
-                       guint64 mode,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDSwapTechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

BD_SWAP_ERROR

-
#define             BD_SWAP_ERROR
-
-
-
-

enum BDSwapError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_SWAP_ERROR_UNKNOWN_STATE

  

BD_SWAP_ERROR_ACTIVATE

  

BD_SWAP_ERROR_TECH_UNAVAIL

  

BD_SWAP_ERROR_ACTIVATE_OLD

  

BD_SWAP_ERROR_ACTIVATE_SUSPEND

  

BD_SWAP_ERROR_ACTIVATE_UNKNOWN

  

BD_SWAP_ERROR_ACTIVATE_PAGESIZE

  
-
-
-
-
-

enum BDSwapTech

-
-

Members

-
----- - - - - - -

BD_SWAP_TECH_SWAP

  
-
-
-
-
-

enum BDSwapTechMode

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - -

BD_SWAP_TECH_MODE_CREATE

  

BD_SWAP_TECH_MODE_ACTIVATE_DEACTIVATE

  

BD_SWAP_TECH_MODE_QUERY

  

BD_SWAP_TECH_MODE_SET_LABEL

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-Utils.html b/libblockdev/docs/3.0/libblockdev-Utils.html deleted file mode 100644 index d714484..0000000 --- a/libblockdev/docs/3.0/libblockdev-Utils.html +++ /dev/null @@ -1,2402 +0,0 @@ - - - - -Utils: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

Utils

-

Utils — library providing utility functions used by the blockdev library and its plugins

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -(*BDUtilsProgExtract) () -
-void - -(*BDUtilsProgFunc) () -
-void - -(*BDUtilsLogFunc) () -
-GQuark - -bd_utils_exec_error_quark () -
-GQuark - -bd_utils_dev_utils_error_quark () -
-gboolean - -bd_utils_exec_and_report_error () -
-gboolean - -bd_utils_exec_and_report_status_error () -
-gboolean - -bd_utils_exec_and_capture_output () -
-gboolean - -bd_utils_exec_and_report_error_no_progress () -
-gboolean - -bd_utils_exec_and_report_progress () -
-gboolean - -bd_utils_exec_with_input () -
-gboolean - -bd_utils_prog_reporting_initialized () -
-gboolean - -bd_utils_init_logging () -
-gboolean - -bd_utils_init_prog_reporting () -
-gboolean - -bd_utils_init_prog_reporting_thread () -
-gboolean - -bd_utils_mute_prog_reporting_thread () -
-void - -bd_utils_report_finished () -
-void - -bd_utils_report_progress () -
-guint64 - -bd_utils_report_started () -
-guint64 - -bd_utils_get_next_task_id () -
-void - -bd_utils_log_task_status () -
-void - -bd_utils_log () -
-void - -bd_utils_log_format () -
-void - -bd_utils_log_stdout () -
-gboolean - -bd_utils_echo_str_to_file () -
-void - -bd_utils_set_log_level () -
-gboolean - -bd_utils_check_util_version () -
-gint - -bd_utils_version_cmp () -
-BDExtraArg * - -bd_extra_arg_new () -
-BDExtraArg * - -bd_extra_arg_copy () -
-void - -bd_extra_arg_free () -
-GType - -bd_extra_arg_get_type () -
-gchar * - -bd_utils_resolve_device () -
-gchar ** - -bd_utils_get_device_symlinks () -
-gboolean - -bd_utils_have_kernel_module () -
-gboolean - -bd_utils_load_kernel_module () -
-gboolean - -bd_utils_unload_kernel_module () -
-BDUtilsLinuxVersion * - -bd_utils_get_linux_version () -
-gint - -bd_utils_check_linux_version () -
-gboolean - -bd_utils_dbus_service_available () -
-GQuark - -bd_utils_dbus_error_quark () -
-GQuark - -bd_utils_module_error_quark () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
enumBDUtilsProgStatus
#defineBD_UTILS_EXEC_ERROR
enumBDUtilsExecError
enumBDUtilsDevUtilsError
enumBDUtilsDBusError
enumBDUtilsModuleError
#defineBD_UTILS_DEV_UTILS_ERROR
#defineBD_UTILS_DBUS_ERROR
#defineBD_UTILS_MODULE_ERROR
 BDUtilsLinuxVersion
 BDExtraArg
#defineEXBIBYTE
#defineEiB
#defineGIBIBYTE
#defineGiB
#defineKIBIBYTE
#defineKiB
#defineMEBIBYTE
#defineMiB
#definePEBIBYTE
#definePiB
#defineTEBIBYTE
#defineTiB
#defineEB
#defineEXABYTE
#defineGB
#defineGIGABYTE
#defineKB
#defineKILOBYTE
#defineMB
#defineMEGABYTE
#definePB
#definePETABYTE
#defineTB
#defineTERABYTE
#defineBD_UTILS_LOG_EMERG
#defineBD_UTILS_LOG_ALERT
#defineBD_UTILS_LOG_CRIT
#defineBD_UTILS_LOG_ERR
#defineBD_UTILS_LOG_WARNING
#defineBD_UTILS_LOG_NOTICE
#defineBD_UTILS_LOG_INFO
#defineBD_UTILS_LOG_DEBUG
-
-
-

Includes

-
#include <utils.h>
-
-
-
-

Description

-
-
-

Functions

-
-

BDUtilsProgExtract ()

-
gboolean
-(*BDUtilsProgExtract) (const gchar *line,
-                       guint8 *completion);
-

Callback function used to process a line captured from spawned command's standard -output and standard error output. Typically used to extract completion percentage -of a long-running job.

-

Note that both outputs are read simultaneously with no guarantees of message order -this function is called with.

-

The value the completion - points to may contain value previously returned from -this callback or zero when called for the first time. This is useful for extractors -where only some kind of a tick mark is printed out as a progress and previous value -is needed to compute an incremented value. It's important to keep in mind that this -function is only called over lines, i.e. progress reporting printing out tick marks -(e.g. dots) without a newline character might not work properly.

-

The line - string usually contains trailing newline character, which may be absent -however in case the spawned command exits without printing one. It's guaranteed -this function is called over remaining buffer no matter what the trailing -character is.

-
-

Parameters

-
----- - - - - - - - - - - - - -

line

line to extract progress from

 

completion

percentage of completion.

[out]
-
-
-

Returns

-

whether the line was a progress reporting line and should be excluded -from the collected standard output string or not.

-
-
-
-
-

BDUtilsProgFunc ()

-
void
-(*BDUtilsProgFunc) (guint64 task_id,
-                    BDUtilsProgStatus status,
-                    guint8 completion,
-                    gchar *msg);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

task_id

ID of the task/action the progress is reported for

 

status

progress status

 

completion

percentage of completion

 

msg

arbitrary progress message (for the user).

[nullable]
-
-
-
-
-

BDUtilsLogFunc ()

-
void
-(*BDUtilsLogFunc) (gint level,
-                   const gchar *msg);
-

Function type for logging function used by the libblockdev's exec utils to -log the information about program executing.

-
-

Parameters

-
----- - - - - - - - - - - - - -

level

log level (as understood by syslog(3))

 

msg

log message

 
-
-
-
-
-

bd_utils_exec_error_quark ()

-
GQuark
-bd_utils_exec_error_quark (void);
-

[skip]

-
-
-
-

bd_utils_dev_utils_error_quark ()

-
GQuark
-bd_utils_dev_utils_error_quark (void);
-

[skip]

-
-
-
-

bd_utils_exec_and_report_error ()

-
gboolean
-bd_utils_exec_and_report_error (const gchar **argv,
-                                const BDExtraArg **extra,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

extra

extra arguments.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed (no error and exit code 0) or not

-
-
-
-
-

bd_utils_exec_and_report_status_error ()

-
gboolean
-bd_utils_exec_and_report_status_error (const gchar **argv,
-                                       const BDExtraArg **extra,
-                                       gint *status,
-                                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

extra

extra arguments.

[nullable][array zero-terminated=1]

status

place to store the status.

[out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed (no error and exit code 0) or not

-
-
-
-
-

bd_utils_exec_and_capture_output ()

-
gboolean
-bd_utils_exec_and_capture_output (const gchar **argv,
-                                  const BDExtraArg **extra,
-                                  gchar **output,
-                                  GError **error);
-

Note that any NULL bytes read from standard output and standard error -output will be discarded.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

extra

extra arguments.

[nullable][array zero-terminated=1]

output

variable to store output to.

[out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed capturing the output or not

-
-
-
-
-

bd_utils_exec_and_report_error_no_progress ()

-
gboolean
-bd_utils_exec_and_report_error_no_progress
-                               (const gchar **argv,
-                                const BDExtraArg **extra,
-                                GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

extra

extra arguments.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed (no error and exit code 0) or not

-
-
-
-
-

bd_utils_exec_and_report_progress ()

-
gboolean
-bd_utils_exec_and_report_progress (const gchar **argv,
-                                   const BDExtraArg **extra,
-                                   BDUtilsProgExtract prog_extract,
-                                   gint *proc_status,
-                                   GError **error);
-

Note that any NULL bytes read from standard output and standard error -output are treated as separators similar to newlines and prog_extract - -will be called with the respective chunk.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

extra

extra arguments.

[nullable][array zero-terminated=1]

prog_extract

function for extracting progress information.

[scope notified][nullable]

proc_status

place to store the process exit status.

[out]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed (no error and exit code 0) or not

-
-
-
-
-

bd_utils_exec_with_input ()

-
gboolean
-bd_utils_exec_with_input (const gchar **argv,
-                          const gchar *input,
-                          const BDExtraArg **extra,
-                          GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

argv

the argv array for the call.

[array zero-terminated=1]

input

input for the executed program.

[nullable]

extra

extra arguments.

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the argv -was successfully executed (no error and exit code 0) or not

-
-
-
-
-

bd_utils_prog_reporting_initialized ()

-
gboolean
-bd_utils_prog_reporting_initialized (void);
-
-

Returns

-

TRUE if progress reporting has been initialized, i.e. a reporting -function was set up with either bd_utils_init_prog_reporting or -bd_utils_init_prog_reporting_thread (takes precedence). FALSE if -bd_utils_mute_prog_reporting_thread was used to mute the thread.

-
-
-
-
-

bd_utils_init_logging ()

-
gboolean
-bd_utils_init_logging (BDUtilsLogFunc new_log_func,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

new_log_func

logging function to use or -NULL to disable logging; use -bd_utils_log_stdout to reset to -the default behaviour.

[nullable][scope notified]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether logging was successfully initialized or not

-
-
-
-
-

bd_utils_init_prog_reporting ()

-
gboolean
-bd_utils_init_prog_reporting (BDUtilsProgFunc new_prog_func,
-                              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

new_prog_func

progress reporting function to -use or NULL to reset to default.

[nullable][scope notified]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether progress reporting was successfully initialized or not

-
-
-
-
-

bd_utils_init_prog_reporting_thread ()

-
gboolean
-bd_utils_init_prog_reporting_thread (BDUtilsProgFunc new_prog_func,
-                                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

new_prog_func

progress reporting function to -use on current thread or NULL -to reset to default or global.

[nullable][scope notified]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether progress reporting was successfully initialized or not

-
-
-
-
-

bd_utils_mute_prog_reporting_thread ()

-
gboolean
-bd_utils_mute_prog_reporting_thread (GError **error);
-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether progress reporting for the current thread was successfully -muted (deinitialized even in presence of a global reporting function) or not

-
-
-
-
-

bd_utils_report_finished ()

-
void
-bd_utils_report_finished (guint64 task_id,
-                          const gchar *msg);
-
-

Parameters

-
----- - - - - - - - - - - - - -

task_id

ID of the task/action

 

msg

message describing the status of the task/action

 
-
-
-
-
-

bd_utils_report_progress ()

-
void
-bd_utils_report_progress (guint64 task_id,
-                          guint64 completion,
-                          const gchar *msg);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

task_id

ID of the task/action

 

completion

percentage of completion

 

msg

message describing the status of the task/action

 
-
-
-
-
-

bd_utils_report_started ()

-
guint64
-bd_utils_report_started (const gchar *msg);
-
-

Parameters

-
----- - - - - - -

msg

message describing the started task/action

 
-
-
-

Returns

-

ID of the started task/action

-
-
-
-
-

bd_utils_get_next_task_id ()

-
guint64
-bd_utils_get_next_task_id (void);
-
-
-
-

bd_utils_log_task_status ()

-
void
-bd_utils_log_task_status (guint64 task_id,
-                          const gchar *msg);
-
-

Parameters

-
----- - - - - - - - - - - - - -

task_id

ID of the task the status of which is being logged

 

msg

log message

 
-
-
-
-
-

bd_utils_log ()

-
void
-bd_utils_log (gint level,
-              const gchar *msg);
-
-

Parameters

-
----- - - - - - - - - - - - - -

level

log level

 

msg

log message

 
-
-
-
-
-

bd_utils_log_format ()

-
void
-bd_utils_log_format (gint level,
-                     const gchar *format,
-                     ...);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

level

log level

 

format

printf-style format for the log message

 

...

arguments for format -

 
-
-
-
-
-

bd_utils_log_stdout ()

-
void
-bd_utils_log_stdout (gint level,
-                     const gchar *msg);
-

Convenient function for logging to stdout. Can be used as BDUtilsLogFunc.

-
-

Parameters

-
----- - - - - - - - - - - - - -

level

log level

 

msg

log message

 
-
-
-
-
-

bd_utils_echo_str_to_file ()

-
gboolean
-bd_utils_echo_str_to_file (const gchar *str,
-                           const gchar *file_path,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

str

string to write to file_path -

 

file_path

path to file

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the str -was successfully written to file_path -or not.

-
-
-
-
-

bd_utils_set_log_level ()

-
void
-bd_utils_set_log_level (gint level);
-

Level of messages to log. Only messages with level <= level - will be logged. -For example using with BD_UTILS_LOG_WARNING (default value) only messages -with log levels BD_UTILS_LOG_WARNING, BD_UTILS_LOG_ERR, ..., BD_UTILS_LOG_EMERG -will be logged.

-

Note: BD_UTILS_LOG_DEBUG level messages are always skipped unless compiled - with --enable-debug configure option.

-
-

Parameters

-
----- - - - - - -

level

log level

 
-
-
-
-
-

bd_utils_check_util_version ()

-
gboolean
-bd_utils_check_util_version (const gchar *util,
-                             const gchar *version,
-                             const gchar *version_arg,
-                             const gchar *version_regexp,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

util

name of the utility to check

 

version

minimum required version of the utility or NULL -if no version is required.

[nullable]

version_arg

argument to use with the util -to get version -info or NULL to use "--version".

[nullable]

version_regexp

regexp to extract version from the version -info or NULL if only version is printed by "$ util -version_arg -".

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the util -is available in a version >= version -or not -(error -is set in such case).

-
-
-
-
-

bd_utils_version_cmp ()

-
gint
-bd_utils_version_cmp (const gchar *ver_string1,
-                      const gchar *ver_string2,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

ver_string1

first version string

 

ver_string2

second version string

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

-1, 0 or 1 if ver_string1 -is lower, the same or higher version as -ver_string2 -respectively. If an error occurs, returns -2 and error -is set.

-

**ONLY SUPPORTS VERSION STRINGS OF FORMAT X[.Y[.Z[.Z2[.Z3...[-R]]]]] where all components -are natural numbers!**

-
-
-
-
-

bd_extra_arg_new ()

-
BDExtraArg *
-bd_extra_arg_new (const gchar *opt,
-                  const gchar *val);
-

Example of calling bd_fs_xfs_mkfs() with an extra argument. -This will result in calling mkfs.xfs with -L label.

-
- - - - - - - - 
1
-2
-3
-4
BDExtraArg label_arg = {"-L", "label"};
-const BDExtraArg *extra_args[2] = {&label_arg, NULL};
-
-ret = bd_fs_xfs_mkfs ("/dev/sda", extra_args, error);
-
- -

-

[constructor]

-
-

Parameters

-
----- - - - - - - - - - - - - -

opt

extra option

 

val

value for the extra option opt -

 
-
-
-

Returns

-

a new extra argument.

-

[transfer full]

-
-
-
-
-

bd_extra_arg_copy ()

-
BDExtraArg *
-bd_extra_arg_copy (BDExtraArg *arg);
-

Creates a new copy of arg -.

-
-

Parameters

-
----- - - - - - -

arg

BDExtraArg to copy.

[nullable]
-
-
-
-
-

bd_extra_arg_free ()

-
void
-bd_extra_arg_free (BDExtraArg *arg);
-

Frees arg -.

-
-

Parameters

-
----- - - - - - -

arg

BDExtraArg to free.

[nullable]
-
-
-
-
-

bd_extra_arg_get_type ()

-
GType
-bd_extra_arg_get_type (void);
-
-
-
-

bd_utils_resolve_device ()

-
gchar *
-bd_utils_resolve_device (const gchar *dev_spec,
-                         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dev_spec

specification of the device (e.g. "/dev/sda", any symlink, or the name of a file -under "/dev")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

the full real path of the device (e.g. "/dev/md126" -for "/dev/md/my_raid") or NULL in case of error.

-

[transfer full]

-
-
-
-
-

bd_utils_get_device_symlinks ()

-
gchar **
-bd_utils_get_device_symlinks (const gchar *dev_spec,
-                              GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dev_spec

specification of the device (e.g. "/dev/sda", any symlink, or the name of a file -under "/dev")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a list of all symlinks (known to udev) for the -device specified with dev_spec -or NULL in -case of error.

-

[transfer full][array zero-terminated=1]

-
-
-
-
-

bd_utils_have_kernel_module ()

-
gboolean
-bd_utils_have_kernel_module (const gchar *module_name,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

module_name

name of the kernel module to check

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the module_name -was found in the system, either as a module -or built-in in the kernel

-
-
-
-
-

bd_utils_load_kernel_module ()

-
gboolean
-bd_utils_load_kernel_module (const gchar *module_name,
-                             const gchar *options,
-                             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

module_name

name of the kernel module to load

 

options

module options.

[nullable]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the module_name -was successfully loaded or not

-
-
-
-
-

bd_utils_unload_kernel_module ()

-
gboolean
-bd_utils_unload_kernel_module (const gchar *module_name,
-                               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

module_name

name of the kernel module to unload

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the module_name -was successfully unloaded or not

-
-
-
-
-

bd_utils_get_linux_version ()

-
BDUtilsLinuxVersion *
-bd_utils_get_linux_version (GError **error);
-

Retrieves version of currently running Linux kernel. Acts also as an initializer for statically cached data.

-
-

Parameters

-
----- - - - - - -

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

Detected Linux kernel version or NULL in case of an error. The returned value belongs to the library, do not free.

-

[transfer none]

-
-
-
-
-

bd_utils_check_linux_version ()

-
gint
-bd_utils_check_linux_version (guint major,
-                              guint minor,
-                              guint micro);
-

Checks whether the currently running linux kernel version is equal or higher -than the specified required major -.minor -.micro - version.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

major

Minimal major linux kernel version.

 

minor

Minimal minor linux kernel version.

 

micro

Minimal micro linux kernel version.

 
-
-
-

Returns

-

an integer less than, equal to, or greater than zero, if detected version is <, == or > than the specified major -.minor -.micro -version.

-
-
-
-
-

bd_utils_dbus_service_available ()

-
gboolean
-bd_utils_dbus_service_available (GDBusConnection *connection,
-                                 GBusType bus_type,
-                                 const gchar *bus_name,
-                                 const gchar *obj_prefix,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

connection

existing GDBusConnection or NULL.

[nullable]

bus_type

bus type (system or session), ignored if connection -is specified

 

bus_name

name of the service to check (e.g. "com.redhat.lvmdbus1")

 

obj_prefix

object path prefix for the service (e.g. "/com/redhat/lvmdbus1")

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether the service was found in the system

-
-
-
-
-

bd_utils_dbus_error_quark ()

-
GQuark
-bd_utils_dbus_error_quark (void);
-

[skip]

-
-
-
-

bd_utils_module_error_quark ()

-
GQuark
-bd_utils_module_error_quark (void);
-

[skip]

-
-
-
-

Types and Values

-
-

enum BDUtilsProgStatus

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_UTILS_PROG_STARTED

  

BD_UTILS_PROG_PROGRESS

  

BD_UTILS_PROG_FINISHED

  
-
-
-
-
-

BD_UTILS_EXEC_ERROR

-
#define BD_UTILS_EXEC_ERROR bd_utils_exec_error_quark ()
-
-
-
-
-

enum BDUtilsExecError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_UTILS_EXEC_ERROR_FAILED

  

BD_UTILS_EXEC_ERROR_NOOUT

  

BD_UTILS_EXEC_ERROR_INVAL_VER

  

BD_UTILS_EXEC_ERROR_UTIL_UNAVAILABLE

  

BD_UTILS_EXEC_ERROR_UTIL_UNKNOWN_VER

  

BD_UTILS_EXEC_ERROR_UTIL_LOW_VER

  

BD_UTILS_EXEC_ERROR_UTIL_CHECK_ERROR

  

BD_UTILS_EXEC_ERROR_UTIL_FEATURE_CHECK_ERROR

  

BD_UTILS_EXEC_ERROR_UTIL_FEATURE_UNAVAILABLE

  
-
-
-
-
-

enum BDUtilsDevUtilsError

-
-

Members

-
----- - - - - - -

BD_UTILS_DEV_UTILS_ERROR_FAILED

  
-
-
-
-
-

enum BDUtilsDBusError

-
-

Members

-
----- - - - - - - - - - - - - -

BD_UTILS_DBUS_ERROR_FAIL

  

BD_UTILS_DBUS_ERROR_NOEXIST

  
-
-
-
-
-

enum BDUtilsModuleError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_UTILS_MODULE_ERROR_KMOD_INIT_FAIL

  

BD_UTILS_MODULE_ERROR_FAIL

  

BD_UTILS_MODULE_ERROR_NOEXIST

  

BD_UTILS_MODULE_ERROR_MODULE_CHECK_ERROR

  

BD_UTILS_MODULE_ERROR_INVALID_PLATFORM

  
-
-
-
-
-

BD_UTILS_DEV_UTILS_ERROR

-
#define BD_UTILS_DEV_UTILS_ERROR bd_utils_dev_utils_error_quark ()
-
-
-
-
-

BD_UTILS_DBUS_ERROR

-
#define BD_UTILS_DBUS_ERROR bd_utils_dbus_error_quark ()
-
-
-
-
-

BD_UTILS_MODULE_ERROR

-
#define BD_UTILS_MODULE_ERROR bd_utils_module_error_quark ()
-
-
-
-
-

BDUtilsLinuxVersion

-
typedef struct {
-    guint major;
-    guint minor;
-    guint micro;
-} BDUtilsLinuxVersion;
-
-
-
-
-

BDExtraArg

-
typedef struct {
-    gchar *opt;
-    gchar *val;
-} BDExtraArg;
-
-

See bd_extra_arg_new() for an example on how to construct the extra args.

-
-

Members

-
----- - - - - - - - - - - - - -

gchar *opt;

extra option (command line option for most functions that allow extra options -to be passed, e.g. "-L" to call mkfs.xfs -L)

 

gchar *val;

value for opt -, can be an empty string or NULL for options without parameter

 
-
-
-
-
-

EXBIBYTE

-
#define EXBIBYTE *1024ULL PEBIBYTE
-
-
-
-
-

EiB

-
#define EiB EXBIBYTE
-
-
-
-
-

GIBIBYTE

-
#define GIBIBYTE *1024ULL MEBIBYTE
-
-
-
-
-

GiB

-
#define GiB GIBIBYTE
-
-
-
-
-

KIBIBYTE

-
#define KIBIBYTE *1024ULL
-
-
-
-
-

KiB

-
#define KiB KIBIBYTE
-
-
-
-
-

MEBIBYTE

-
#define MEBIBYTE *1024ULL KIBIBYTE
-
-
-
-
-

MiB

-
#define MiB MEBIBYTE
-
-
-
-
-

PEBIBYTE

-
#define PEBIBYTE *1024ULL TEBIBYTE
-
-
-
-
-

PiB

-
#define PiB PEBIBYTE
-
-
-
-
-

TEBIBYTE

-
#define TEBIBYTE *1024ULL GIBIBYTE
-
-
-
-
-

TiB

-
#define TiB TEBIBYTE
-
-
-
-
-

EB

-
#define EB EXABYTE
-
-
-
-
-

EXABYTE

-
#define EXABYTE *1000ULL PETABYTE
-
-
-
-
-

GB

-
#define GB GIGABYTE
-
-
-
-
-

GIGABYTE

-
#define GIGABYTE *1000ULL MEGABYTE
-
-
-
-
-

KB

-
#define KB KILOBYTE
-
-
-
-
-

KILOBYTE

-
#define KILOBYTE *1000ULL
-
-
-
-
-

MB

-
#define MB MEGABYTE
-
-
-
-
-

MEGABYTE

-
#define MEGABYTE *1000ULL KILOBYTE
-
-
-
-
-

PB

-
#define PB PETABYTE
-
-
-
-
-

PETABYTE

-
#define PETABYTE *1000ULL TERABYTE
-
-
-
-
-

TB

-
#define TB TERABYTE
-
-
-
-
-

TERABYTE

-
#define TERABYTE *1000ULL GIGABYTE
-
-
-
-
-

BD_UTILS_LOG_EMERG

-
#define BD_UTILS_LOG_EMERG   0
-
-
-
-
-

BD_UTILS_LOG_ALERT

-
#define BD_UTILS_LOG_ALERT   1
-
-
-
-
-

BD_UTILS_LOG_CRIT

-
#define BD_UTILS_LOG_CRIT    2
-
-
-
-
-

BD_UTILS_LOG_ERR

-
#define BD_UTILS_LOG_ERR     3
-
-
-
-
-

BD_UTILS_LOG_WARNING

-
#define BD_UTILS_LOG_WARNING 4
-
-
-
-
-

BD_UTILS_LOG_NOTICE

-
#define BD_UTILS_LOG_NOTICE  5
-
-
-
-
-

BD_UTILS_LOG_INFO

-
#define BD_UTILS_LOG_INFO    6
-
-
-
-
-

BD_UTILS_LOG_DEBUG

-
#define BD_UTILS_LOG_DEBUG   7
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-blockdev-library.html b/libblockdev/docs/3.0/libblockdev-blockdev-library.html deleted file mode 100644 index b9b561b..0000000 --- a/libblockdev/docs/3.0/libblockdev-blockdev-library.html +++ /dev/null @@ -1,534 +0,0 @@ - - - - -blockdev library: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

blockdev library

-

blockdev library — a library for doing low-level operations with block devices

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_init () -
-gboolean - -bd_ensure_init () -
-gboolean - -bd_try_init () -
-gboolean - -bd_reinit () -
-gboolean - -bd_try_reinit () -
-gboolean - -bd_is_initialized () -
-gboolean - -bd_switch_init_checks () -
-GQuark - -bd_init_error_quark () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
#defineBD_INIT_ERROR
enumBDInitError
-
-
-

Includes

-
#include <blockdev.h>
-
-
-
-

Description

-
-
-

Functions

-
-

bd_init ()

-
gboolean
-bd_init (BDPluginSpec **require_plugins,
-         BDUtilsLogFunc log_func,
-         GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

require_plugins

NULL-terminated list -of plugins that should be loaded (if no so_name is specified -for the plugin, the default is used) or NULL to load all -plugins.

[nullable][array zero-terminated=1]

log_func

logging function to use.

[nullable][scope notified]

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the library was successfully initialized with all the -required or default (see require_plugins -) plugins or not

-

Example of libblockdev initialization with 'fs' and 'lvm' plugins. Specific -version of the lvm plugin is required:

-
- - - - - - - - 
1
-2
-3
-4
-5
-6
GError *error = NULL;
-gboolean ret = FALSE;
-BDPluginSpec fs_plugin = {BD_PLUGIN_FS, NULL};
-BDPluginSpec lvm_plugin = {BD_PLUGIN_LVM, "libbd_lvm.so.2"};
-BDPluginSpec *plugins[] = {&fs_plugin, &lvm_plugin, NULL};
-ret = bd_init (plugins, NULL, &error);
-
- -

-
-
-
-
-

bd_ensure_init ()

-
gboolean
-bd_ensure_init (BDPluginSpec **require_plugins,
-                BDUtilsLogFunc log_func,
-                GError **error);
-

Checks the state of the library and if it is uninitialized or not all the -require_plugins - plugins are available, tries to (re)initialize it. Otherwise -just returns early. The difference between:

-
- - - - - - - - 
1
-2
if (!bd_is_initialized())
-    bd_init(None, None, &error);
-
- -

-

and this function is that this function does the check and init in an atomic -way (holding the lock preventing other threads from doing changes in -between).

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

require_plugins

NULL-terminated list -of plugins that should be loaded (if no so_name is specified -for the plugin, the default is used) or NULL to load all -plugins.

[nullable][array zero-terminated=1]

log_func

logging function to use.

[nullable][scope notified]

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the library was successfully initialized with all the -required or default (see require_plugins -) plugins or not either -before or by this call

-
-
-
-
-

bd_try_init ()

-
gboolean
-bd_try_init (BDPluginSpec **request_plugins,
-             BDUtilsLogFunc log_func,
-             gchar ***loaded_plugin_names,
-             GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

request_plugins

NULL-terminated list -of plugins that should be loaded (if no so_name is specified -for the plugin, the default is used) or NULL to load all -plugins.

[nullable][array zero-terminated=1]

log_func

logging function to use.

[nullable][scope notified]

loaded_plugin_names

names -of the successfully loaded plugins.

[optional][out][transfer container][array zero-terminated=1]

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the library was successfully initialized with all the -required or default (see require_plugins -) plugins or not

-

*UNLIKE IN CASE OF bd_init() AND bd_ensure_init(), FAILURE TO LOAD A PLUGIN -IS NOT CONSIDERED ERROR*

-
-
-
-
-

bd_reinit ()

-
gboolean
-bd_reinit (BDPluginSpec **require_plugins,
-           gboolean reload,
-           BDUtilsLogFunc log_func,
-           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

require_plugins

NULL-terminated list -of plugins that should be loaded (if no so_name is specified -for the plugin, the default is used) or NULL to load all -plugins.

[nullable][array zero-terminated=1]

reload

whether to reload the already loaded plugins or not

 

log_func

logging function to use or NULL -to keep the old one.

[nullable][scope notified]

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the library was successfully initialized or not

-

If reload -is TRUE all the plugins are closed and reloaded otherwise only -the missing plugins are loaded.

-
-
-
-
-

bd_try_reinit ()

-
gboolean
-bd_try_reinit (BDPluginSpec **require_plugins,
-               gboolean reload,
-               BDUtilsLogFunc log_func,
-               gchar ***loaded_plugin_names,
-               GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

require_plugins

NULL-terminated list -of plugins that should be loaded (if no so_name is specified -for the plugin, the default is used) or NULL to load all -plugins.

[nullable][array zero-terminated=1]

reload

whether to reload the already loaded plugins or not

 

log_func

logging function to use or NULL -to keep the old one.

[nullable][scope notified]

loaded_plugin_names

names of the successfully -loaded plugins.

[optional][out][transfer container][array zero-terminated=1]

error

place to store error (if any).

[out]
-
-
-

Returns

-

whether the library was successfully initialized or not

-

If reload -is TRUE all the plugins are closed and reloaded otherwise only -the missing plugins are loaded.

-

*UNLIKE IN CASE OF bd_init() AND bd_ensure_init(), FAILURE TO LOAD A PLUGIN -IS NOT CONSIDERED ERROR*

-
-
-
-
-

bd_is_initialized ()

-
gboolean
-bd_is_initialized (void);
-
-

Returns

-

whether the library is initialized or not

-

The library is considered initialized if some of the *init*() functions -was/were called and either at least one plugin is loaded or 0 plugins are -loaded after an explicit call that requested 0 plugins to be loaded.

-
-
-
-
-

bd_switch_init_checks ()

-
gboolean
-bd_switch_init_checks (gboolean enable,
-                       GError **error);
-

Enables or disables plugins' init checks based on enable -.

-

Note: The current implementation (un)sets the LIBBLOCKDEV_SKIP_DEP_CHECKS - environment variable.

-
-

Parameters

-
----- - - - - - - - - - - - - -

enable

whether to enable init checks (TRUE) or not (FALSE)

 

error

place to store error (if any).

[out]
-
-
-
-
-

bd_init_error_quark ()

-
GQuark
-bd_init_error_quark (void);
-

[skip]

-
-
-
-

Types and Values

-
-

BD_INIT_ERROR

-
#define BD_INIT_ERROR bd_init_error_quark ()
-
-
-
-
-

enum BDInitError

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

BD_INIT_ERROR_PLUGINS_FAILED

  

BD_INIT_ERROR_NOT_IMPLEMENTED

  

BD_INIT_ERROR_FAILED

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev-s390.html b/libblockdev/docs/3.0/libblockdev-s390.html deleted file mode 100644 index d676c21..0000000 --- a/libblockdev/docs/3.0/libblockdev-s390.html +++ /dev/null @@ -1,821 +0,0 @@ - - - - -s390: libblockdev Reference Manual for libblockdev 2.99. - - - - - - - - - - - - - - - - -
-
-
- - -
-

s390

-

s390 — plugin for operations with s390

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-gboolean - -bd_s390_check_deps () -
-gboolean - -bd_s390_init () -
-void - -bd_s390_close () -
-GQuark - -bd_s390_error_quark () -
-gboolean - -bd_s390_dasd_format () -
-gboolean - -bd_s390_dasd_needs_format () -
-gchar * - -bd_s390_sanitize_dev_input () -
-gboolean - -bd_s390_dasd_online () -
-gboolean - -bd_s390_dasd_is_ldl () -
-gboolean - -bd_s390_dasd_is_fba () -
-gchar * - -bd_s390_zfcp_sanitize_wwpn_input () -
-gchar * - -bd_s390_zfcp_sanitize_lun_input () -
-gboolean - -bd_s390_zfcp_online () -
-gboolean - -bd_s390_zfcp_scsi_offline () -
-gboolean - -bd_s390_zfcp_offline () -
-gboolean - -bd_s390_is_tech_avail () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - -
enumBDS390Error
#defineBD_S390_ERROR
enumBDS390Tech
enumBDS390TechMode
-
-
-

Includes

-
#include <s390.h>
-
-
-
-

Description

-

A plugin for operations with s390 devices.

-
-
-

Functions

-
-

bd_s390_check_deps ()

-
gboolean
-bd_s390_check_deps (void);
-
-

Returns

-

whether the plugin's runtime dependencies are satisfied or not

-

Function checking plugin's runtime dependencies.

-
-
-
-
-

bd_s390_init ()

-
gboolean
-bd_s390_init (void);
-

Initializes the plugin. **This function is called automatically by the -library's initialization functions.**

-
-
-
-

bd_s390_close ()

-
void
-bd_s390_close (void);
-

Cleans up after the plugin. **This function is called automatically by the -library's functions that unload it.**

-
-
-
-

bd_s390_error_quark ()

-
GQuark
-bd_s390_error_quark (void);
-

[skip]

-
-
-
-

bd_s390_dasd_format ()

-
gboolean
-bd_s390_dasd_format (const gchar *dasd,
-                     const BDExtraArg **extra,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

dasd

dasd to format

 

extra

extra options for the formatting (right now -passed to the 'dasdfmt' utility).

[nullable][array zero-terminated=1]

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether dasdfmt was successful or not

-

Tech category: BD_S390_TECH_DASD-BD_S390_TECH_MODE_MODIFY

-
-
-
-
-

bd_s390_dasd_needs_format ()

-
gboolean
-bd_s390_dasd_needs_format (const gchar *dasd,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dasd

dasd to check, whether it needs dasdfmt run on it

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a dasd needs dasdfmt run against it

-

Tech category: BD_S390_TECH_DASD-BD_S390_TECH_MODE_QUERY

-
-
-
-
-

bd_s390_sanitize_dev_input ()

-
gchar *
-bd_s390_sanitize_dev_input (const gchar *dev,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dev

a DASD or zFCP device number

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a synthesized dasd or zfcp device number

-

Tech category: always available.

-

[transfer full]

-
-
-
-
-

bd_s390_dasd_online ()

-
gboolean
-bd_s390_dasd_online (const gchar *dasd,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dasd

dasd to switch online

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a dasd was successfully switched online

-

Tech category: BD_S390_TECH_DASD-BD_S390_TECH_MODE_MODIFY

-
-
-
-
-

bd_s390_dasd_is_ldl ()

-
gboolean
-bd_s390_dasd_is_ldl (const gchar *dasd,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dasd

dasd to check, whether it is LDL formatted

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a dasd is LDL formatted

-

Tech category: BD_S390_TECH_DASD-BD_S390_TECH_MODE_QUERY

-
-
-
-
-

bd_s390_dasd_is_fba ()

-
gboolean
-bd_s390_dasd_is_fba (const gchar *dasd,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

dasd

dasd to check, whether it is FBA

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a dasd is FBA

-

Tech category: BD_S390_TECH_DASD-BD_S390_TECH_MODE_QUERY

-
-
-
-
-

bd_s390_zfcp_sanitize_wwpn_input ()

-
gchar *
-bd_s390_zfcp_sanitize_wwpn_input (const gchar *wwpn,
-                                  GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

wwpn

a zFCP WWPN identifier

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a synthesized zFCP WWPN

-

Tech category: always available.

-

[transfer full]

-
-
-
-
-

bd_s390_zfcp_sanitize_lun_input ()

-
gchar *
-bd_s390_zfcp_sanitize_lun_input (const gchar *lun,
-                                 GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - -

lun

a zFCP LUN identifier

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

a synthesized zFCP LUN

-

Tech category: always available.

-

[transfer full]

-
-
-
-
-

bd_s390_zfcp_online ()

-
gboolean
-bd_s390_zfcp_online (const gchar *devno,
-                     const gchar *wwpn,
-                     const gchar *lun,
-                     GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

devno

a zFCP device number

 

wwpn

a zFCP WWPN identifier

 

lun

a zFCP LUN identifier

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a zFCP device was successfully switched online

-

Tech category: BD_S390_TECH_ZFCP-BD_S390_TECH_MODE_MODIFY

-
-
-
-
-

bd_s390_zfcp_scsi_offline ()

-
gboolean
-bd_s390_zfcp_scsi_offline (const gchar *devno,
-                           const gchar *wwpn,
-                           const gchar *lun,
-                           GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

devno

a zFCP device number

 

wwpn

a zFCP WWPN identifier

 

lun

a zFCP LUN identifier

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a LUN was successfully removed from associated WWPN

-

This function looks through /proc/scsi/scsi and manually removes LUNs from -associated WWPNs. zFCP devices are SCSI devices accessible over FCP protocol. -In z/OS the IODF (I/O definition file) contains basic information about the -I/O config, but WWPN and LUN configuration is done at the OS level, hence -this function becomes necessary when switching the device offline. This -particular sequence of actions is for some reason unnecessary when switching -the device online. Chalk it up to s390x being s390x.

-

Tech category: BD_S390_TECH_ZFCP-BD_S390_TECH_MODE_MODIFY

-
-
-
-
-

bd_s390_zfcp_offline ()

-
gboolean
-bd_s390_zfcp_offline (const gchar *devno,
-                      const gchar *wwpn,
-                      const gchar *lun,
-                      GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

devno

zfcp device number

 

wwpn

zfcp WWPN (World Wide Port Number)

 

lun

zfcp LUN (Logical Unit Number)

 

error

place to store error (if any).

[out][optional]
-
-
-

Returns

-

whether a zfcp device was successfully switched offline

-

Tech category: BD_S390_TECH_ZFCP-BD_S390_TECH_MODE_MODIFY

-
-
-
-
-

bd_s390_is_tech_avail ()

-
gboolean
-bd_s390_is_tech_avail (BDS390Tech tech,
-                       guint64 mode,
-                       GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

tech

the queried tech

 

mode

a bit mask of queried modes of operation (BDS390TechMode) for tech -

 

error

place to store error (details about why the tech --mode -combination is not available).

[out][optional]
-
-
-

Returns

-

whether the tech --mode -combination is available -- supported by the -plugin implementation and having all the runtime dependencies available

-
-
-
-
-

Types and Values

-
-

enum BDS390Error

-
-

Members

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BD_S390_ERROR_DEVICE

  

BD_S390_ERROR_FORMAT_FAILED

  

BD_S390_ERROR_DASDFMT

  

BD_S390_ERROR_IO

  

BD_S390_ERROR_TECH_UNAVAIL

  
-
-
-
-
-

BD_S390_ERROR

-
#define             BD_S390_ERROR
-
-
-
-

enum BDS390Tech

-
-

Members

-
----- - - - - - - - - - - - - -

BD_S390_TECH_DASD

  

BD_S390_TECH_ZFCP

  
-
-
-
-
-

enum BDS390TechMode

-
-

Members

-
----- - - - - - - - - - - - - -

BD_S390_TECH_MODE_MODIFY

  

BD_S390_TECH_MODE_QUERY

  
-
-
-
-
-
-
Generated by GTK-Doc V1.33.1
- - \ No newline at end of file diff --git a/libblockdev/docs/3.0/libblockdev.devhelp2 b/libblockdev/docs/3.0/libblockdev.devhelp2 deleted file mode 100644 index 807e7e7..0000000 --- a/libblockdev/docs/3.0/libblockdev.devhelp2 +++ /dev/null @@ -1,1621 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/libblockdev/docs/3.0/right-insensitive.png b/libblockdev/docs/3.0/right-insensitive.png deleted file mode 100644 index 4c95785b907b978f36674cd98bf5302669c15c1b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 373 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefG`u!(zUX23=E7+o-U3d7N^fn+URvSL8NuRG*{E) z?#-+97X-^pidQ*u@StO1(S@7g8g>nnA24$?ty?)cmuaa|Y>ez2*_Ia?6HP4j{3LIs zTr!s1ao_Sz^~3e4zRJGAjKZGn=XP#)Wmuo-QN>teTzzI!&R*jMI^Oa#7_ukLYdicf zOx;1mb-rt04s-c|uIH8fnX}$)XJa^0_-F3(pA%=sGI<|(n_*&=yYt96+n5InXn_GN+EraJI9q(O+n{6MQKErp&KxRvpfn0xh z`sSMqH(2Z%?kaFBTf06W^y=UDA9gR9YrwNS*1pjB((0K%&+SbAx3`XA&dKZ}j*nX7 QfdRze>FVdQ&MBb@09|aA9{>OV diff --git a/libblockdev/docs/3.0/right.png b/libblockdev/docs/3.0/right.png deleted file mode 100644 index 76260ec8865f4e13cd269ec62eccd78a33adba3c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 261 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefRMbR+#PqI2*V^#7sn8b(^oI8=W9$9IsUQVezxzH zy`G{eu0`y#boSlU-NAlQG~=D)BPJG4k(^0qdDa(AdQvI0d|vJT=i7_<_D6`Cy?Dm; zP0@1EeB~D|O$oQe*sxL-P;q{2UCr}fN-o#M~tpZzsGyfNz46SZlIJCbKH zZQscEqpOfBCPDgx dt -{ - padding-top: 0.25em; - padding-bottom: 0.25em; - font-weight: bold; -} - -dl.toc > dl -{ - padding-bottom: 0.5em; -} - -.parameter -{ - font-style: normal; -} - -.footer -{ - padding-top: 3.5em; - /* tango:aluminium 3 */ - color: #babdb6; - text-align: center; - font-size: 80%; -} - -.informalfigure, -.figure -{ - margin: 1em; -} - -.informalexample, -.example -{ - margin-top: 1em; - margin-bottom: 1em; -} - -.warning -{ - /* tango:orange 0/1 */ - background: #ffeed9; - background: rgba(252, 175, 62, 0.1); - border-color: #ffb04f; - border-color: rgba(252, 175, 62, 0.2); -} -.note -{ - /* tango:chameleon 0/0.5 */ - background: #d8ffb2; - background: rgba(138, 226, 52, 0.1); - border-color: #abf562; - border-color: rgba(138, 226, 52, 0.2); -} -div.blockquote -{ - border-color: #eeeeec; -} -.note, .warning, div.blockquote -{ - padding: 0.5em; - border-width: 1px; - border-style: solid; - margin: 2em; -} -.note p, .warning p -{ - margin: 0; -} - -div.warning h3.title, -div.note h3.title -{ - display: none; -} - -p + div.section -{ - margin-top: 1em; -} - -div.refnamediv, -div.refsynopsisdiv, -div.refsect1, -div.refsect2, -div.toc, -div.section -{ - margin-bottom: 1em; -} - -/* blob links */ -h2 .extralinks, h3 .extralinks -{ - float: right; - /* tango:aluminium 3 */ - color: #babdb6; - font-size: 80%; - font-weight: normal; -} - -.lineart -{ - color: #d3d7cf; - font-weight: normal; -} - -.annotation -{ - /* tango:aluminium 5 */ - color: #555753; - font-weight: normal; -} - -.structfield -{ - font-style: normal; - font-weight: normal; -} - -acronym,abbr -{ - border-bottom: 1px dotted gray; -} - -.listing_frame { - /* tango:sky blue 1 */ - border: solid 1px #729fcf; - border: solid 1px rgba(114, 159, 207, 0.2); - padding: 0px; -} - -.listing_lines, .listing_code { - margin-top: 0px; - margin-bottom: 0px; - padding: 0.5em; -} -.listing_lines { - /* tango:sky blue 0.5 */ - background: #a6c5e3; - background: rgba(114, 159, 207, 0.2); - /* tango:aluminium 6 */ - color: #2e3436; -} -.listing_code { - /* tango:sky blue 0 */ - background: #e6f3ff; - background: rgba(114, 159, 207, 0.1); -} -.listing_code .programlisting { - /* override from previous */ - border: none 0px; - padding: 0px; - background: none; -} -.listing_lines pre, .listing_code pre { - margin: 0px; -} - -@media screen { - /* these have a as a first child, but since there are no parent selectors - * we can't use that. */ - a.footnote - { - position: relative; - top: 0em ! important; - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - display: inline-block; - position: relative; - top:-5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 2.5em; - padding-bottom: 500px; - max-width: 60em; - } - p - { - max-width: 60em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - background: #e2e2e2; - border-bottom: solid 1px #babdb6; - border-spacing: 5px; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - z-index: 10; - } - table.navigation#top td - { - padding-left: 6px; - padding-right: 6px; - } - .navigation a, .navigation a:visited - { - /* tango:sky blue 3 */ - color: #204a87; - } - .navigation a:hover - { - /* tango:sky blue 2 */ - color: #3465a4; - } - td.shortcuts - { - /* tango:sky blue 2 */ - color: #3465a4; - font-size: 80%; - white-space: nowrap; - } - td.shortcuts .dim - { - color: #babdb6; - } - .navigation .title - { - font-size: 80%; - max-width: none; - margin: 0px; - font-weight: normal; - } -} -@media screen and (min-width: 60em) { - /* screen larger than 60em */ - body { margin: auto; } -} -@media screen and (max-width: 60em) { - /* screen less than 60em */ - #nav_hierarchy { display: none; } - #nav_interfaces { display: none; } - #nav_prerequisites { display: none; } - #nav_derived_interfaces { display: none; } - #nav_implementations { display: none; } - #nav_child_properties { display: none; } - #nav_style_properties { display: none; } - #nav_index { display: none; } - #nav_glossary { display: none; } - .gallery_image { display: none; } - .property_flags { display: none; } - .signal_flags { display: none; } - .parameter_annotations { display: none; } - .enum_member_annotations { display: none; } - .struct_member_annotations { display: none; } - .union_member_annotations { display: none; } - /* now that a column is hidden, optimize space */ - col.parameters_name { width: auto; } - col.parameters_description { width: auto; } - col.struct_members_name { width: auto; } - col.struct_members_description { width: auto; } - col.enum_members_name { width: auto; } - col.enum_members_description { width: auto; } - col.union_members_name { width: auto; } - col.union_members_description { width: auto; } - .listing_lines { display: none; } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - background: #e2e2e2; - border: solid 1px #babdb6; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - -pre { line-height: 125%; } -td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.hll { background-color: #ffffcc } -.c { color: #3D7B7B; font-style: italic } /* Comment */ -.err { border: 1px solid #FF0000 } /* Error */ -.k { color: #008000; font-weight: bold } /* Keyword */ -.o { color: #666666 } /* Operator */ -.ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ -.cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ -.cp { color: #9C6500 } /* Comment.Preproc */ -.cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ -.c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ -.cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ -.gd { color: #A00000 } /* Generic.Deleted */ -.ge { font-style: italic } /* Generic.Emph */ -.gr { color: #E40000 } /* Generic.Error */ -.gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.gi { color: #008400 } /* Generic.Inserted */ -.go { color: #717171 } /* Generic.Output */ -.gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.gt { color: #0044DD } /* Generic.Traceback */ -.kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.kp { color: #008000 } /* Keyword.Pseudo */ -.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.kt { color: #B00040 } /* Keyword.Type */ -.m { color: #666666 } /* Literal.Number */ -.s { color: #BA2121 } /* Literal.String */ -.na { color: #687822 } /* Name.Attribute */ -.nb { color: #008000 } /* Name.Builtin */ -.nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.no { color: #880000 } /* Name.Constant */ -.nd { color: #AA22FF } /* Name.Decorator */ -.ni { color: #717171; font-weight: bold } /* Name.Entity */ -.ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ -.nf { color: #0000FF } /* Name.Function */ -.nl { color: #767600 } /* Name.Label */ -.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.nt { color: #008000; font-weight: bold } /* Name.Tag */ -.nv { color: #19177C } /* Name.Variable */ -.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.w { color: #bbbbbb } /* Text.Whitespace */ -.mb { color: #666666 } /* Literal.Number.Bin */ -.mf { color: #666666 } /* Literal.Number.Float */ -.mh { color: #666666 } /* Literal.Number.Hex */ -.mi { color: #666666 } /* Literal.Number.Integer */ -.mo { color: #666666 } /* Literal.Number.Oct */ -.sa { color: #BA2121 } /* Literal.String.Affix */ -.sb { color: #BA2121 } /* Literal.String.Backtick */ -.sc { color: #BA2121 } /* Literal.String.Char */ -.dl { color: #BA2121 } /* Literal.String.Delimiter */ -.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.s2 { color: #BA2121 } /* Literal.String.Double */ -.se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ -.sh { color: #BA2121 } /* Literal.String.Heredoc */ -.si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ -.sx { color: #008000 } /* Literal.String.Other */ -.sr { color: #A45A77 } /* Literal.String.Regex */ -.s1 { color: #BA2121 } /* Literal.String.Single */ -.ss { color: #19177C } /* Literal.String.Symbol */ -.bp { color: #008000 } /* Name.Builtin.Pseudo */ -.fm { color: #0000FF } /* Name.Function.Magic */ -.vc { color: #19177C } /* Name.Variable.Class */ -.vg { color: #19177C } /* Name.Variable.Global */ -.vi { color: #19177C } /* Name.Variable.Instance */ -.vm { color: #19177C } /* Name.Variable.Magic */ -.il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/libblockdev/docs/3.0/up-insensitive.png b/libblockdev/docs/3.0/up-insensitive.png deleted file mode 100644 index f40498606db349a7321cf6b470523e836ee7ac2e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 374 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefG~@Ex#w@70gTL^E{-7zACwHGSRJaopUzr*FR_KPpkxheNzTDP+%{a~ox zRb6~e-_l%s#;V|Jw-)bO$G_X=4F`Y7SBoCzyjAZQ8BPW>ywAP8?pbBsZ|wt?+h6S6&uqY)kkMnwQQEd@7k`4t@sCCO z@7MoiEI4Q_#IB70vhu7Ab+>SXLxu@LWH Qzz|~aboFyt=akR{08E^fv;Y7A diff --git a/libblockdev/docs/3.0/up.png b/libblockdev/docs/3.0/up.png deleted file mode 100644 index 80b4b37e997d69b2e128bc3090bc447ccb74bbe9..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 260 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b zKpodXn9)gNb_Gz7y~NYkmHjTefRFevZLys@4W>+6GUE!tU04Ii{0w_tkMIDB?rA5 zttYTN Date: Wed, 25 Mar 2026 14:52:54 +0100 Subject: [PATCH 11/15] Add jekyll-sitemap plugin for SEO Co-Authored-By: Claude Opus 4.6 --- _config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_config.yml b/_config.yml index 23c0286..74047a9 100644 --- a/_config.yml +++ b/_config.yml @@ -6,6 +6,7 @@ description: >- theme: minima plugins: - jekyll-feed + - jekyll-sitemap show_excerpts: true From ff72d7d43d9a95936ebd3c7eb82a8c86c4c8aa9e Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 14:57:02 +0100 Subject: [PATCH 12/15] Add estimated reading time to blog posts Co-Authored-By: Claude Opus 4.6 --- _layouts/post.html | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/_layouts/post.html b/_layouts/post.html index f70b376..3a29f33 100644 --- a/_layouts/post.html +++ b/_layouts/post.html @@ -12,7 +12,10 @@

{{ page.title | escape }} {%- if page.author -%} • - {%- endif -%}

+ {%- endif -%} + {%- assign words = content | number_of_words -%} + {%- assign minutes = words | divided_by: 200 | plus: 1 -%} + • {{ minutes }} min read

From 18fad30bd3426ba41baa49fa5585788ced5c1975 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Wed, 25 Mar 2026 15:28:03 +0100 Subject: [PATCH 13/15] Exclude vendor directory from Jekyll build Fixes CI failure caused by Jekyll trying to process gem template files installed in vendor/bundle. Co-Authored-By: Claude Opus 4.6 --- _config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_config.yml b/_config.yml index 74047a9..2b79f4a 100644 --- a/_config.yml +++ b/_config.yml @@ -29,3 +29,4 @@ include: exclude: - README.md + - vendor From ab895c77555e72504846d54f479f74b711d4779b Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Mon, 13 Apr 2026 15:16:19 +0200 Subject: [PATCH 14/15] Add GVfs to the project relationships graph Co-Authored-By: Claude Opus 4.6 --- _includes/projects-graph.svg | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/_includes/projects-graph.svg b/_includes/projects-graph.svg index f5376f7..56bd91b 100644 --- a/_includes/projects-graph.svg +++ b/_includes/projects-graph.svg @@ -1,4 +1,4 @@ - + Storaged Project relationships @@ -13,6 +13,7 @@ + @@ -40,6 +41,9 @@ GNOME Disks + + + GVfs @@ -61,7 +65,7 @@ - + Storaged projects From eadb99bb6aad30cc2564a40c8c9dfcf304fd32d9 Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Tue, 14 Apr 2026 14:16:35 +0200 Subject: [PATCH 15/15] Replace Projects dropdown with flat nav links and About page Revert the collapsible dropdown menu (6d2ae42) back to a flat list of project links. Add the About page to the main menu, separated from the project links by a visual divider. Co-Authored-By: Claude Opus 4.6 --- _includes/header.html | 20 +++----- _sass/nav-separator.scss | 15 ++++++ _sass/projects-dropdown.scss | 90 ------------------------------------ assets/main.scss | 2 +- 4 files changed, 23 insertions(+), 104 deletions(-) create mode 100644 _sass/nav-separator.scss delete mode 100644 _sass/projects-dropdown.scss diff --git a/_includes/header.html b/_includes/header.html index 6a5def8..e73cfb4 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -17,19 +17,13 @@
-
- -
    - {%- for path in page_paths -%} - {%- assign my_page = site.pages | where: "path", path | first -%} - {%- if my_page.title -%} -
  • {{ my_page.title | escape }}
    • - {%- endif -%} - {%- endfor -%} -
-
+ {%- for path in page_paths -%} + {%- assign my_page = site.pages | where: "path", path | first -%} + {%- if my_page.title -%} + {{ my_page.title | escape }} + {%- endif -%} + {%- endfor -%} + About
diff --git a/_sass/nav-separator.scss b/_sass/nav-separator.scss new file mode 100644 index 0000000..3ac9d01 --- /dev/null +++ b/_sass/nav-separator.scss @@ -0,0 +1,15 @@ +.nav-separator { + display: inline-block; + width: 1px; + height: 1.2em; + background-color: $grey-color-light; + vertical-align: middle; + margin: 0 10px 0 0; + + @include media-query($on-palm) { + display: block; + width: auto; + height: 1px; + margin: 5px 10px 5px 20px; + } +} diff --git a/_sass/projects-dropdown.scss b/_sass/projects-dropdown.scss deleted file mode 100644 index a47e16d..0000000 --- a/_sass/projects-dropdown.scss +++ /dev/null @@ -1,90 +0,0 @@ -.dropdown { - position: relative; - display: inline-block; -} - -.dropdown-toggle { - background: none; - border: none; - cursor: pointer; - font: inherit; - padding: 0; -} - -.dropdown-caret { - font-size: 0.7em; - vertical-align: middle; -} - -.dropdown-menu { - display: none; - position: absolute; - right: 0; - top: 100%; - margin: 0; - padding: 5px 0; - list-style: none; - background-color: $background-color; - border: 1px solid $grey-color-light; - border-radius: 5px; - box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1); - min-width: 160px; - z-index: 1000; - - li { - margin: 0; - } - - .page-link { - display: block; - padding: 6px 16px; - white-space: nowrap; - - &:hover { - background-color: lighten($grey-color-light, 5%); - } - } -} - -// Desktop: show dropdown on hover or focus-within -.dropdown:hover > .dropdown-menu, -.dropdown:focus-within > .dropdown-menu { - display: block; -} - -// Mobile: integrate with the hamburger menu -@include media-query($on-palm) { - .dropdown { - display: block; - width: 100%; - } - - .dropdown-toggle { - display: block; - padding: 5px 10px; - margin-left: 20px; - text-align: right; - } - - .dropdown-menu { - position: static; - border: none; - box-shadow: none; - padding: 0; - min-width: 0; - - .page-link { - padding: 5px 10px; - margin-left: 20px; - - &:hover { - background-color: transparent; - } - } - } - - // Always show the dropdown contents inside the hamburger menu - .dropdown > .dropdown-menu { - display: block; - } -} diff --git a/assets/main.scss b/assets/main.scss index 3d4520e..5c2a9fc 100644 --- a/assets/main.scss +++ b/assets/main.scss @@ -4,4 +4,4 @@ @import "minima"; @import "author-bio"; -@import "projects-dropdown"; +@import "nav-separator";