diff options
| author | Romain Tartière <romain@FreeBSD.org> | 2017-10-16 17:21:52 +0000 |
|---|---|---|
| committer | Romain Tartière <romain@FreeBSD.org> | 2017-10-16 17:21:52 +0000 |
| commit | 3f7047aeebeed66f0963299083f3f18b6cba5de3 (patch) | |
| tree | 0bc424c595fbf760923aacfb25c3bc11cede3485 /lib/libgeom | |
| parent | 0d8e04054ee6de957268ecbe4ff1b453263f32d1 (diff) | |
Notes
Diffstat (limited to 'lib/libgeom')
| -rw-r--r-- | lib/libgeom/Makefile | 4 | ||||
| -rw-r--r-- | lib/libgeom/libgeom.3 | 54 |
2 files changed, 57 insertions, 1 deletions
diff --git a/lib/libgeom/Makefile b/lib/libgeom/Makefile index ea1f6c83a961b..b7877cc56ece6 100644 --- a/lib/libgeom/Makefile +++ b/lib/libgeom/Makefile @@ -33,6 +33,10 @@ MLINKS+= \ libgeom.3 gctl_issue.3 \ libgeom.3 gctl_free.3 \ libgeom.3 gctl_dump.3 \ + libgeom.3 geom_getxml.3 \ + libgeom.3 geom_xml2tree.3 \ + libgeom.3 geom_gettree.3 \ + libgeom.3 geom_deletetree.3 \ libgeom.3 g_close.3 \ libgeom.3 g_delete.3 \ libgeom.3 g_device_path.3 \ diff --git a/lib/libgeom/libgeom.3 b/lib/libgeom/libgeom.3 index dbe21c84d38e8..e1a3a35b70626 100644 --- a/lib/libgeom/libgeom.3 +++ b/lib/libgeom/libgeom.3 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 22, 2017 +.Dd October 16, 2017 .Dt LIBGEOM 3 .Os .Sh NAME @@ -46,6 +46,10 @@ .Nm gctl_issue , .Nm gctl_free , .Nm gctl_dump , +.Nm geom_getxml , +.Nm geom_xml2tree , +.Nm geom_gettree , +.Nm geom_deletetree , .Nm g_open , .Nm g_close , .Nm g_mediasize , @@ -99,6 +103,14 @@ .Ft void .Fn gctl_dump "struct gctl_req *req" "FILE *f" .Ss "Utility Functions" +.Ft "char *" +.Fn geom_getxml void +.Ft int +.Fn geom_xml2tree "struct gmesh *gmp" "char *p" +.Ft int +.Fn geom_gettree "struct gmesh *gmp" +.Ft void +.Fn geom_deletetree "struct gmesh *gmp" .Ft int .Fn g_open "const char *name" "int dowrite" .Ft int @@ -279,6 +291,46 @@ on success, or an error message corresponding to the first error which happened. .Ss "Utility Functions" The +.Fn geom_getxml +function is a wrapper around +.Xr sysctl 3 +that fetches the +.Ar kern.geom.confxml +OID, and returns it's value. +The allocated memory should be released with +.Xr free 2 +after use. +.Pp +The +.Fn geom_xml2tree +function parses the XML representation of a GEOM topology passed as +.Ar p , +allocates the needed data structures to access this information and fills in +the passed +.Ar gmp +data structure. +Memory allocated during this transformation should be released +using +.Fn geom_deletetree +after use. +.Pp +The +.Fn geom_gettree +function is a wrapper around the +.Fn geom_getxml +and +.Fn geom_xml2tree +functions. +Memory allocated during this operation should be released using +.Fn geom_deletetree +after use. +.Pp +The +.Fn geom_deletetree +function releases memory allocated for storing the data-structures referenced by +.Ar gmp . +.Pp +The .Fn g_* functions are used to communicate with GEOM providers. .Pp |
