diff options
| author | Niels de Vos <ndevos@redhat.com> | 2017-01-06 12:49:32 +0100 |
|---|---|---|
| committer | Shyamsundar Ranganathan <srangana@redhat.com> | 2017-01-19 10:44:22 -0800 |
| commit | d93a6691538270aefe7703e8f8d7c822f53528e5 (patch) | |
| tree | b07a719b7e9cc2ca8cb5e3fb054d8e9d8fea3cdb /api/src/glfs.h | |
| parent | 89cf743118ab6554c7f210754e51c4921cbb60c7 (diff) | |
gfapi: add API to trigger events for debugging and troubleshooting
Introduce glfs_sysrq() as a generic API for triggering debug and
troubleshoot events. This interface will be used by the feature to get
statedumps for applications using libgfapi.
The current events that can be requested through this API are:
- 'h'elp: log a mesage with all supported events
- 's'tatedump: trigger a statedump for the passed glfs_t
In future, this API can be used by a CLI to trigger statedumps from
storage servers. At the moment it is limited to take statedumps, but it
is extensible to set the log-level, clear caches, force reconnects and
much more.
BUG: 1169302
Change-Id: I18858359a3957870cea5139c79efe1365a15a992
Original-author: Poornima G <pgurusid@redhat.com>
Signed-off-by: Niels de Vos <ndevos@redhat.com>
Reviewed-on: http://review.gluster.org/16414
Reviewed-by: Prashanth Pai <ppai@redhat.com>
Smoke: Gluster Build System <jenkins@build.gluster.org>
NetBSD-regression: NetBSD Build System <jenkins@build.gluster.org>
CentOS-regression: Gluster Build System <jenkins@build.gluster.org>
Reviewed-by: Kaleb KEITHLEY <kkeithle@redhat.com>
Diffstat (limited to 'api/src/glfs.h')
| -rw-r--r-- | api/src/glfs.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/api/src/glfs.h b/api/src/glfs.h index 903492a9466..f5a0e1a2a84 100644 --- a/api/src/glfs.h +++ b/api/src/glfs.h @@ -773,6 +773,23 @@ void glfs_free (void *ptr) __THROW GFAPI_PUBLIC(glfs_free, 3.7.16); /* + * glfs_sysrq: send a system request to the @fs instance + * + * Different commands for @sysrq are possible, the defines for these are listed + * below the function definition. + * + * This function always returns success if the @sysrq is recognized. The return + * value does not way anythin about the result of the @sysrq execution. Not all + * @sysrq command will be able to return a success/failure status. + */ +int glfs_sysrq (glfs_t *fs, char sysrq) __THROW + GFAPI_PUBLIC(glfs_sysrq, 3.10.0); + +#define GLFS_SYSRQ_HELP 'h' /* log a message with supported sysrq commands */ +#define GLFS_SYSRQ_STATEDUMP 's' /* create a statedump */ + + +/* * Nobody needs this call at all yet except for the test script. */ int glfs_ipc (glfs_fd_t *fd, int cmd, void *xd_in, void **xd_out) __THROW |