/usr/include/ipmiconsole.h is in libipmiconsole-dev 0.8.12-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 | /*****************************************************************************\
* $Id: ipmiconsole.h,v 1.81.4.6 2010-08-03 00:10:48 chu11 Exp $
*****************************************************************************
* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
* Copyright (C) 2006-2007 The Regents of the University of California.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
* Written by Albert Chu <chu11@llnl.gov>
* UCRL-CODE-221226
*
* This file is part of Ipmiconsole, a set of IPMI 2.0 SOL libraries
* and utilities. For details, see http://www.llnl.gov/linux/.
*
* Ipmiconsole is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* Ipmiconsole is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with Ipmiconsole. If not, see <http://www.gnu.org/licenses/>.
\*****************************************************************************/
#ifndef _IPMICONSOLE_H
#define _IPMICONSOLE_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <freeipmi/freeipmi.h>
/*
* IPMI Console Error Codes
*/
#define IPMICONSOLE_ERR_SUCCESS 0
#define IPMICONSOLE_ERR_CTX_NULL 1
#define IPMICONSOLE_ERR_CTX_INVALID 2
#define IPMICONSOLE_ERR_ALREADY_SETUP 3
#define IPMICONSOLE_ERR_NOT_SETUP 4
#define IPMICONSOLE_ERR_CTX_NOT_SUBMITTED 5
#define IPMICONSOLE_ERR_CTX_IS_SUBMITTED 6
#define IPMICONSOLE_ERR_PARAMETERS 7
#define IPMICONSOLE_ERR_HOSTNAME_INVALID 8
#define IPMICONSOLE_ERR_IPMI_2_0_UNAVAILABLE 9
#define IPMICONSOLE_ERR_CIPHER_SUITE_ID_UNAVAILABLE 10
#define IPMICONSOLE_ERR_USERNAME_INVALID 11
#define IPMICONSOLE_ERR_PASSWORD_INVALID 12
#define IPMICONSOLE_ERR_K_G_INVALID 13
#define IPMICONSOLE_ERR_PRIVILEGE_LEVEL_INSUFFICIENT 14
#define IPMICONSOLE_ERR_PRIVILEGE_LEVEL_CANNOT_BE_OBTAINED 15
#define IPMICONSOLE_ERR_SOL_UNAVAILABLE 16
#define IPMICONSOLE_ERR_SOL_INUSE 17
#define IPMICONSOLE_ERR_SOL_STOLEN 18
#define IPMICONSOLE_ERR_SOL_REQUIRES_ENCRYPTION 19
#define IPMICONSOLE_ERR_SOL_REQUIRES_NO_ENCRYPTION 20
#define IPMICONSOLE_ERR_BMC_BUSY 21
#define IPMICONSOLE_ERR_BMC_ERROR 22
#define IPMICONSOLE_ERR_BMC_IMPLEMENTATION 23
#define IPMICONSOLE_ERR_CONNECTION_TIMEOUT 24
#define IPMICONSOLE_ERR_SESSION_TIMEOUT 25
#define IPMICONSOLE_ERR_EXCESS_RETRANSMISSIONS_SENT 26
#define IPMICONSOLE_ERR_EXCESS_ERRORS_RECEIVED 27
#define IPMICONSOLE_ERR_OUT_OF_MEMORY 28
#define IPMICONSOLE_ERR_TOO_MANY_OPEN_FILES 29
#define IPMICONSOLE_ERR_SYSTEM_ERROR 30
#define IPMICONSOLE_ERR_INTERNAL_ERROR 31
#define IPMICONSOLE_ERR_ERRNUMRANGE 32
/*
* Debug Flags
*
* Utilized with ipmiconsole_engine_init() or with struct
* ipmiconsole_engine_config below for debugging.
*
* When used with ipmiconsole_engine_init(), enables debugging in
* libipmiconsole global activities, such as the libipmiconsole engine
* threads.
*
* When used with struct ipmiconsole_engine_config and a context,
* enables debugging specific to an IPMI connection with a specific
* host.
*
* STDOUT - Output debugging to stdout
* STDERR - Output debugging to stderr
* SYSLOG - Output debugging to the Syslog
* FILE - Output debugging to the default debug file
* IPMI_PACKETS - Dump IPMI Packets too
*/
#define IPMICONSOLE_DEBUG_STDOUT 0x00000001
#define IPMICONSOLE_DEBUG_STDERR 0x00000002
#define IPMICONSOLE_DEBUG_SYSLOG 0x00000004
#define IPMICONSOLE_DEBUG_FILE 0x00000008
#define IPMICONSOLE_DEBUG_IPMI_PACKETS 0x00000010
/*
* IPMI Privilege Constants
*
* Utilized with struct ipmiconsole_ipmi_config below to specify a
* privilege level to authenticate with.
*/
#define IPMICONSOLE_PRIVILEGE_USER 0
#define IPMICONSOLE_PRIVILEGE_OPERATOR 1
#define IPMICONSOLE_PRIVILEGE_ADMIN 2
/*
* Workaround Flags
*
* Utilized with struct ipmiconsole_ipmi_config below to specify
* workarounds for specific motherboard manufacturers.
*
* AUTHENTICATION_CAPABILITIES
*
* This workaround flag will skip early checks for username
* capabilities, authentication capabilities, and K_g support and
* allow IPMI authentication to succeed. It works around multiple
* issues in which the remote system does not properly report username
* capabilities, authentication capabilities, or K_g status.
*
* IGNORE_SOL_PAYLOAD_SIZE
*
* This workaround flag will not check for valid SOL payload sizes and
* assume a proper set. It works around remote systems that report
* invalid IPMI 2.0 SOL payload sizes.
*
* IGNORE_SOL_PORT
*
* This workaround flag will ignore alternate SOL ports specified
* during the protocol. It works around remote systems that report
* invalid alternate SOL ports.
*
* SKIP_SOL_ACTIVATION_STATUS
*
* This workaround flag will not check the current activation status
* of SOL during the protocol setup. It works around remote systems
* that do not properly support this command.
*
* INTEL_2_0_SESSION
*
* This workaround flag will work around several Intel IPMI 2.0
* authentication issues. The issues covered include padding of
* usernames, automatic acceptance of a RAKP 4 response integrity
* check when using the integrity algorithm MD5-128, and password
* truncation if the authentication algorithm is HMAC-MD5-128.
*
* Security Note: When the Integrity Algorithm is MD5-128 (Cipher
* Suite ID 11 & 12), the integrity check value of a RAKP 4 packet
* response is not tested, it is automatically accepted. The other
* integrity algorithms (None, HMAC-SHA1, HMAC-MD5) have been reverse
* engineered for this non-compliance bug, however straight forward
* MD5-128 has not yet been reverse engineered.
*
* SUPERMICRO_2_0_SESSION
*
* This workaround option will work around several Supermicro IPMI 2.0
* authentication issues on motherboards w/ Peppercon IPMI firmware.
* The issues covered include handling * invalid length authentication
* codes.
*
* SUN_2_0_SESSION
*
* This workaround flag will work work around several Sun IPMI 2.0
* authentication issues. The issues covered include invalid lengthed
* hash keys, improperly hashed keys, and invalid cipher suite
* records. This workaround automatically includes the
* OPEN_SESSION_PRIVILEGE workaround.
*
* OPEN_SESSION_PRIVILEGE
*
* This workaround flag will slightly alter FreeIPMI's IPMI 2.0
* connection protocol to workaround an invalid hashing algorithm used
* by the remote system. The privilege level sent during the Open
* Session stage of an IPMI 2.0 connection is used for hashing keys
* instead of the privilege level sent during the RAKP1 connection
* stage. This workaround is automatically triggered with the
* SUN_2_0_SESSION workaround.
*
* NON_EMPTY_INTEGRITY_CHECK_VALUE
*
* This workaround option will work around an invalid integrity check
* value during an IPMI 2.0 session establishment when using Cipher
* Suite ID 0. The integrity check value should be 0 length, however
* the remote motherboard responds with a non-empty field.
*
* Note: The non-logical bitmask order below is set for consistency of
* masks with libfreeipmi bitmasks.
*/
#define IPMICONSOLE_WORKAROUND_AUTHENTICATION_CAPABILITIES 0x00000010
#define IPMICONSOLE_WORKAROUND_IGNORE_SOL_PAYLOAD_SIZE 0x00010000
#define IPMICONSOLE_WORKAROUND_IGNORE_SOL_PORT 0x00020000
#define IPMICONSOLE_WORKAROUND_SKIP_SOL_ACTIVATION_STATUS 0x00040000
#define IPMICONSOLE_WORKAROUND_INTEL_2_0_SESSION 0x01000000
#define IPMICONSOLE_WORKAROUND_SUPERMICRO_2_0_SESSION 0x02000000
#define IPMICONSOLE_WORKAROUND_SUN_2_0_SESSION 0x04000000
#define IPMICONSOLE_WORKAROUND_OPEN_SESSION_PRIVILEGE 0x08000000
#define IPMICONSOLE_WORKAROUND_NON_EMPTY_INTEGRITY_CHECK_VALUE 0x10000000
/*
* Engine Flags
*
* Utilized with struct ipmiconsole_engine_config below to alter
* libipmiconsole engine behavior.
*
* CLOSE_FD
*
* By default, the ipmiconsole engine will not close the file
* descriptor (returned by ipmiconsole_ctx_fd()) when an error occurs
* within the ipmiconsole engine (such as a session timeout). A user
* will subsequently see an EOF on a read() or an EPIPE on a write()
* to know an error occurred.
*
* This flag will inform the engine to close the file descriptor on
* error. This will change the behavior of how the user should
* program with the file descriptor. For example, calls to read() and
* write() would likely return with EBADF errors instead of EOF or
* EPIPE errors respectively. Calls to select() may return with EBADF
* errors and calls to poll() could result in POLLNVAL returned
* events.
*
* OUTPUT_ON_SOL_ESTABLISHED
*
* When submitting a context to the engine non-blocking, another way
* to determine if the SOL session has been established is if data has
* output from the remote console and is available for you to read.
* Under most circumstances, this isn't a controllable situation.
*
* This flag will inform the engine to output a single NUL character
* ('\0') to the console once a SOL session has been established. If
* the CLOSE_FD flag isn't used above, this would allow the user to
* expect an EOF vs. 1 byte of data on a read() to determine if the
* SOL session has failed or succeeded. The user may choose to output
* the NUL anyways (it should do no harm) or simply throw out the
* first byte ever read from remote console.
*
* LOCK_MEMORY
*
* Inform libipmiconsole to lock memory to prevent sensitive
* information (such as usernames and passwords) to be non-swappable.
*
*/
#define IPMICONSOLE_ENGINE_CLOSE_FD 0x00000001
#define IPMICONSOLE_ENGINE_OUTPUT_ON_SOL_ESTABLISHED 0x00000002
#define IPMICONSOLE_ENGINE_LOCK_MEMORY 0x00000004
/*
* Behavior Flags
*
* Utilized with struct ipmiconsole_protocol_config below to atler
* SOL connection behavior.
*
* ERROR_ON_SOL_INUSE
*
* Under most circumstances, if SOL is detected as being in use,
* libipmiconsole will attempt to deactivate the earlier SOL session
* and activate the SOL session under the current one. This default
* behavior exists for several reasons, most notably that earlier SOL
* sessions may have not been able to be deactivated properly. This
* security flag changes the default behavior to return an error if
* SOL is already detected as being in use. If it is detected as in
* use, the errnum returned from ipmiconsole_ctx_errnum() would be
* IPMICONSOLE_ERR_SOL_INUSE.
*
* DEACTIVATE_ONLY
*
* Only attempt to deactivate the SOL session. If an SOL session is
* not active, do nothing.
*/
#define IPMICONSOLE_BEHAVIOR_ERROR_ON_SOL_INUSE 0x00000001
#define IPMICONSOLE_BEHAVIOR_DEACTIVATE_ONLY 0x00000002
/*
* Context Status
*
* Returned by ipmiconsole_ctx_status() below.
*
* ERROR
*
* An error has occurred retrieving the status.
*
* NOT_SUBMITTED
*
* The context has not been submitted to the engine.
*
* SUBMITTED
*
* The context has been submitted to the engine. SOL has not been
* established and an error has not yet occurred.
*
* SOL_ERROR
*
* The context has received an error during SOL establishment.
*
* SOL_ESTABLISHED
*
* The context has established a SOL session.
*
*/
enum ipmiconsole_ctx_status
{
IPMICONSOLE_CTX_STATUS_ERROR = -1,
IPMICONSOLE_CTX_STATUS_NOT_SUBMITTED = 0,
IPMICONSOLE_CTX_STATUS_SUBMITTED = 1,
IPMICONSOLE_CTX_STATUS_SOL_ERROR = 2,
IPMICONSOLE_CTX_STATUS_SOL_ESTABLISHED = 3,
};
typedef enum ipmiconsole_ctx_status ipmiconsole_ctx_status_t;
/*
* ipmiconsole_ipmi_config
*
* IPMI configuration for a connection to a remote IPMI machine.
*
* username
*
* BMC username. Pass NULL ptr for NULL username. Maximum length of
* 16 bytes.
*
* password
*
* BMC password. Pass NULL ptr for NULL password. Maximum length of
* 20 bytes.
*
* k_g
*
* BMC Key for 2-key authentication. Pass NULL ptr to use password
* as BMC key. The k_g key need not be an ascii string.
*
* k_g_len
*
* Length of k_g. Necessary b/c k_g may contain null values in its
* key. Maximum length of 20 bytes.
*
* privilege_level
*
* privilege level to authenticate with.
*
* Supported privilege levels:
*
* IPMICONSOLE_PRIVILEGE_USER
* IPMICONSOLE_PRIVILEGE_OPERATOR
* IPMICONSOLE_PRIVILEGE_ADMIN
*
* Pass < 0 for default of IPMICONSOLE_PRIVILEGE_ADMIN.
*
* cipher_suite_id
*
* Cipher suite identifier to determine authentication, integrity,
* and confidentiality algorithms to use.
*
* Supported Cipher Suite IDs
* (Key: A - Authentication Algorithm
* I - Integrity Algorithm
* C - Confidentiality Algorithm)
*
* 0 - A = None; I = None; C = None
* 1 - A = HMAC-SHA1; I = None; C = None
* 2 - A = HMAC-SHA1; I = HMAC-SHA1-96; C = None
* 3 - A = HMAC-SHA1; I = HMAC-SHA1-96; C = AES-CBC-128
* 6 - A = HMAC-MD5; I = None; C = None
* 7 - A = HMAC-MD5; I = HMAC-MD5-128; C = None
* 8 - A = HMAC-MD5; I = HMAC-MD5-128; C = AES-CBC-128
* 11 - A = HMAC-MD5; I = MD5-128; C = None
* 12 - A = HMAC-MD5; I = MD5-128; C = AES-CBC-128
*
* Pass < 0 for default of 3.
*
* workaround_flags
*
* Bitwise OR of flags indicating IPMI implementation changes. Some
* BMCs which are non-compliant and may require a workaround flag
* for correct operation. Pass 0 for default of no modifications to
* the IPMI protocol.
*/
struct ipmiconsole_ipmi_config
{
char *username;
char *password;
unsigned char *k_g;
unsigned int k_g_len;
int privilege_level;
int cipher_suite_id;
unsigned int workaround_flags;
};
/*
* ipmiconsole_protocol_config
*
* Configuration information for the IPMI protocol management.
*
* session_timeout_len
*
* Specifies the session timeout length in milliseconds. Pass <= 0
* to default to 60000 (60 seconds).
*
* retransmission_timeout_len
*
* Specifies the packet retransmission timeout length in
* milliseconds. Pass <= 0 to default to 500 (0.5 seconds).
*
* retransmission_backoff_count
*
* Specifies the packet retransmission count until retransmission
* timeout lengths will be backed off. Pass <= 0 to default to 2.
*
* keepalive_timeout_len
*
* Specifies the session timeout length in milliseconds until a
* keepalive packet is sent. Pass <= 0 to default to 20000 (20
* seconds).
*
* retransmission_keepalive_timeout_len
*
* Specifies the keepalive packet retransmission timeout length in
* milliseconds. Pass <= 0 to default to 5000 (5 seconds).
*
* acceptable_packet_errors_count
*
* Specifies the maximum number of consecutive packet errors that
* can be received from a remote BMC before an error is returned and
* the session ended. Pass <= 0 to use the default of 16.
*
* Note: This has been added to the behavior of the IPMI engine due
* to issues where remote BMCs can become "un-synced" with sequence
* numbers due to a network kernel boot. It is possible a stream of
* packets can be sent to the remote client with session sequence
* numbers that are excessively outside of the acceptable window
* range.
*
* maximum_retransmission_count
*
* Specifies the maximum number of retransmissions that can be
* sent for any IPMI packet before an error is returned and the
* session ended. Pass <= 0 to use the default of 16.
*
* Note: This has been added to the behavior of the IPMI engine due
* to issues where remote BMCs can become "un-synced" with sequence
* numbers due to a network kernel boot. It is possible for some
* packets (in particular 'ping' packets to keep an IPMI session
* alive) to be accepted by the remote BMC, but not SOL packets.
*
*/
struct ipmiconsole_protocol_config
{
int session_timeout_len;
int retransmission_timeout_len;
int retransmission_backoff_count;
int keepalive_timeout_len;
int retransmission_keepalive_timeout_len;
int acceptable_packet_errors_count;
int maximum_retransmission_count;
};
/*
* ipmiconsole_engine_config
*
* Configuration information for how the engine should interact with
* the user or API.
*
* engine_flags
*
* Bitwise OR of flags indicating how the ipmiconsole engine should
* behave for a particular context. Pass 0 for default behavior.
*
* behavior_flags
*
* Bitwise OR of flags indicating any protocol behavior that should
* be changed from the default. Pass 0 for default of no
* modifications to behavior.
*
* debug_flags
*
* Bitwise OR of flags indicating how debug output should (or should
* not) be output. Pass 0 for default of no debugging.
*
*/
struct ipmiconsole_engine_config
{
unsigned int engine_flags;
unsigned int behavior_flags;
unsigned int debug_flags;
};
#define IPMICONSOLE_THREAD_COUNT_MAX 32
typedef struct ipmiconsole_ctx *ipmiconsole_ctx_t;
/*
* Ipmiconsole_callback
*
* Function prototype for a callback function.
* ipmiconsole_engine_submit() below.
*/
typedef void (*Ipmiconsole_callback)(void *);
/*
* ipmiconsole_engine_init
*
* Initialize the ipmiconsole engine. Engine threads will be created
* which will manage SOL sessions for the user. This function must be
* called before ipmi console contexts can be submitted into the
* engine.
*
* Parameters:
*
* thread_count
*
* Number of threads the engine will support.
*
* debug_flags
*
* Bitwise OR of flags indicating how debug output should (or should
* not) be output. Pass 0 for default of no debugging.
*
* Returns 0 on success, -1 on error. On error errno will be set to
* indicate error.
*/
int ipmiconsole_engine_init (unsigned int thread_count,
unsigned int debug_flags);
/*
* ipmiconsole_engine_submit
*
* Submit a context to the ipmiconsole engine non-blocking. This
* function can return prior to a SOL session being established. A
* return value of 0 indicates the context was submitted properly. A
* return value of -1 indicates an error occurred during the
* submission. On an error, ipmiconsole_ctx_errnum() can be used to
* determine the type of error that occured.
*
* After a context has been submitted, the user may determine if a SOL
* session has been established several ways:
*
* A) Poll on the context status, retrieved via
* ipmiconsole_ctx_status(). On an error, ipmiconsole_ctx_errnum()
* can be used to determine the specific IPMI related error that
* occurred.
*
* B) Poll on the context file descriptor, retrieved via
* ipmiconsole_ctx_fd(). A SOL establishment error will result in an
* EOF being returned on the file descriptor. A proper SOL
* establishment can be determined via a readable character on the
* file descriptor. The use of the OUTPUT_ON_SOL_ESTABLISHED Engine
* flag above can aid in this. the CLOSE_FD Engine flag can be set to
* slightly alter this behavior, please see above. On an error,
* ipmiconsole_ctx_errnum() can be used to determine the specific IPMI
* related error that occurred.
*
* C) Specify a callback function. The callback function specified as
* a parameter below will be called directly after a SOL session has
* been established or an error has occurred. Within those callback
* functions, ipmiconsole_ctx_status() can be used to determine which
* has occurred.
*
* Due to the non-blocking semantics of this function, it is possible
* that multiple errors could occur simultaneously and the errnum
* retrieved via ipmiconsole_ctx_errnum() may not be the one that
* caused the SOL session to fail. However, this will not occur given
* proper usage of the API. For example, if the user called
* ipmiconsole_engine_submit() twice with the same context, an SOL
* error in the engine background could race with the setting of the
* errnum IPMICONSOLE_ERR_CTX_IS_SUBMITTED in the second call.
*
* Parameters:
*
* callback
*
* If specified, a callback function will be called from the engine
* when a SOL session has been established or a SOL establishment
* error has occurred. Will only be called under a non-blocking
* engine submission via ipmiconsole_engine_submit(). Will be
* called once and only once during an individual engine submission.
* For example, if a SOL session is established then a later session
* timeout occurs, the later session timeout will not generate a
* function call to the callback. Pass NULL for no callback.
*
* The callback function can be called simultaneously from different
* engine threads. It is the user's responsibility to protect
* against any race conditions in their callback function.
*
* callback_arg
*
* Specify an arbitrary argument to be passed to the callback
* routine. If the callback will be required to process the context
* status, the context should be included in this argument.
*
* Returns 0 on success, -1 on error. ipmiconsole_ctx_errnum() can be
* called to determine the cause of the error.
*/
int ipmiconsole_engine_submit (ipmiconsole_ctx_t c,
Ipmiconsole_callback callback,
void *callback_arg);
/*
* ipmiconsole_engine_submit_block
*
* Submit a context to the ipmiconsole engine and block until a SOL
* session is established or an error/timeout occurs. A return value
* of 0 indicates the SOL session was established and a -1 indicates
* an error occurred. On an error, ipmiconsole_ctx_errnum() can be
* used to determine the type of error that occured.
*
* Returns 0 on success, -1 on error. ipmiconsole_ctx_errnum() can be
* called to determine the cause of the error.
*/
int ipmiconsole_engine_submit_block (ipmiconsole_ctx_t c);
/*
* ipmiconsole_engine_teardown
*
* Teardown the ipmiconsole engine. This function will destroy
* all threads and contexts managed by the engine.
*
* Parameters:
*
* cleanup_sol_sessions
*
* If set to non zero, SOL sessions will be torn down cleanly.
* ipmiconsole_engine_teardown() will block until all active ipmi
* sessions have been closed cleanly or timed out.
*/
void ipmiconsole_engine_teardown (int cleanup_sol_sessions);
/*
* ipmiconsole_ctx_create
*
* Create a ipmiconsole context. The context can then be submitted
* into the ipmiconsole engine (via ipmiconsole_engine_submit() or
* ipmiconsole_engine_submit_block()) to establish a SOL session. The
* context cannot be submitted to the ipmiconsole engine more than
* once. After it has been submitted to the ipmiconsole, it cannot be
* reused.
*
* Parameters:
*
* hostname
*
* Host or IP address you wish to connect to.
*
* ipmi_config
*
* IPMI configuration. See ipmiconsole_ipmi_config definition
* above.
*
* protocol_config
*
* IPMI protocol configuration. See ipmiconsole_protocol_config
* definition above.
*
* engine_config
*
* Ipmiconsole engine configuration. See ipmiconsole_engine_config
* definition above.
*
* Returns ctx on success, NULL on error. On error errno will be set to
* indicate error.
*/
ipmiconsole_ctx_t ipmiconsole_ctx_create (const char *hostname,
struct ipmiconsole_ipmi_config *ipmi_config,
struct ipmiconsole_protocol_config *protocol_config,
struct ipmiconsole_engine_config *engine_config);
/*
* ipmiconsole_ctx_errnum
*
* Returns the errnum of the most recently recorded error for the
* context that has not yet been read by the user.
*/
int ipmiconsole_ctx_errnum (ipmiconsole_ctx_t c);
/*
* ipmiconsole_ctx_strerror
*
* Returns a pointer to statically allocated string describing the
* error code in errnum.
*/
char *ipmiconsole_ctx_strerror (int errnum);
/*
* ipmiconsole_ctx_errormsg
*
* Returns a pointer to statically allocated string describing the
* most recent error for the context.
*/
char *ipmiconsole_ctx_errormsg (ipmiconsole_ctx_t c);
/*
* ipmiconsole_ctx_status
*
* Returns the current context status. Primarily used to determine if
* a context submission (submitted non-blocking via
* ipmiconsole_engine_submit()) has been established or not. Returns
* IPMICONSOLE_CTX_STATUS_ERROR (-1) on error.
*/
ipmiconsole_ctx_status_t ipmiconsole_ctx_status (ipmiconsole_ctx_t c);
/*
* ipmiconsole_ctx_fd
*
* Returns a file descriptor for console reading and writing after it
* has been submitted to the engine. Returns -1 on error.
* ipmiconsole_ctx_errnum() can be called to determine the cause of
* the error.
*
* If the user closes the file descriptor while the serial over lan
* session is established, the session will be torn down in the
* engine.
*
* If an error occurs on the engine side (for example a session
* timeout) the other end of the file descriptor pair (from which this
* fd is a part of) will be closed. The error can be determined via
* ipmiconsole_ctx_errnum(). The user of this file descriptor will
* typically see this affect via an EOF on a read() or an EPIPE on a
* write(). For alternate file descriptor behavior, see ENGINE flags
* above.
*/
int ipmiconsole_ctx_fd (ipmiconsole_ctx_t c);
/*
* ipmiconsole_ctx_generate_break
*
* Generate a break on an active serial over LAN session.
*
* Returns 0 on success, -1 on error. ipmiconsole_ctx_errnum() can be
* called to determine the cause of the error.
*/
int ipmiconsole_ctx_generate_break (ipmiconsole_ctx_t c);
/*
* ipmiconsole_ctx_destroy
*
* Destroy a context. Will close file descriptor retrieved from
* ipmiconsole_ctx_fd().
*/
void ipmiconsole_ctx_destroy (ipmiconsole_ctx_t c);
#ifdef __cplusplus
}
#endif
#endif /* _IPMICONSOLE_H */
|