Index for Section 9s

Alphabetical listing for C

Bottom of page

cfg_attr_t(9s)
NAME
  cfg_attr_t - General: Contains information for managing the loading and
  unloading of kernel modules

SYNOPSIS
       typedef struct cfg_attr {
	 char		   name[CFG_ATTR_NAME_SZ];
	 uchar		   type;
	 uchar		   operation;
	 uint		   status;
	 long		   index;
	 union {
	     struct {
		 caddr_t   val;
		 ulong	   min_size;
		 ulong	   max_size;
		 void	   (*disposal)();
		 ulong	   val_size;
	     } bin;

	     struct {
		 caddr_t   val;
		 ulong	   min_len;
		 ulong	   max_len;
		 void	   (*disposal)();
	     } str;

	     struct {
		 ulong	   val;
		 ulong	   min_val;
		 ulong	   max_val;
	     } num;
	 } attr;
       } cfg_attr_t;

MEMBERS
  name
      Specifies the ASCII name of the attribute. The name must be between 2
      and CFG_ATTR_NAME_SZ characters in length, including the terminating
      null character. Do not begin the ASCII name of the attribute with the
      Method_ or Device_ characters.  The cfgmgr framework reserves certain
      names that begin with the Method_ and Device_ characters.

  type
      Specifies the data type associated with the name attribute. See the
      DESCRIPTION section for the constants you can pass to the type member.

  operation
      Specifies the operations that the cfgmgr framework can perform on the
      attribute. See the DESCRIPTION section for the constants you can pass
      to the operation member.

  status
      Stores the return code from operations (configure, unconfigure, query)
      that the cfgmgr framework performs. See the DESCRIPTION section for the
      operation codes that the cfgmgr framework can return to the status
      member.

  index
      Stores a value that scopes the target for indexed attributes.

  attr
      Specifies a union of the possible attribute types used for storing
      values, kernel locations, validation criteria, and disposal routines.
      The cfgmgr framework uses the appropriate union element according to
      the attribute type. For example, attributes of type CFG_ATTR_ULONGTYPE
      use the union element num.

DESCRIPTION
  The cfg_attr_t data structure contains information for managing the
  configuring and unconfiguring of kernel modules. The cfgmgr framework
  passes a pointer to this data structure to the kernel module's configure
  routine.  The kernel module can parse this structure pointer to check the
  validity of the values associated with the module's associated sysconfigtab
  file fragment and the /etc/sysconfigtab database.

  You must set the type member to one of the following constants:

  CFG_ATTR_STRTYPE
	      Data type is a null-terminated array of characters.

  CFG_ATTR_INTTYPE
	      Data type is a 32-bit signed integer.

  CFG_ATTR_UINTTYPE
	      Data type is a 32-bit unsigned integer.

  CFG_ATTR_LONGTYPE
	      Data type is a 64-bit signed integer.

  CFG_ATTR_ULONGTYPE
	      Data type is a 64-bit unsigned integer.

  CFG_ATTR_BINTYPE
	      Data type is an array of bytes.

  CFG_ATTR_UCHARTYPE
	      Data type is an 8-bit unsigned character.

  CFG_ATTR_USHORTTYPE
	      Data type is a 16-bit unsigned short integer.

  You can set the operation member to one of the following constants:

  CFG_OP_CONFIGURE
	      The cfgmgr framework configures the attribute.  This means the
	      cfgmgr framework obtains a data value for the attribute from
	      the /etc/sysconfigtab database. The configure operation occurs
	      when the cfgmgr framework calls the configure routine at its
	      CFG_OP_CONFIGURE entry point.  (That is, the optype argument of
	      the configure routine evaluates to the CFG_OP_CONFIGURE
	      constant.)

  CFG_OP_QUERY
	      The cfgmgr framework queries (reads) the attribute. This means
	      the kernel module cooperates with the cfgmgr framework to
	      provide the value associated with the attribute as a result of
	      user-initiated query requests. These requests are typically the
	      result of the sysconfig -q command. The query operation occurs
	      when the cfgmgr framework calls the configure routine at its
	      CFG_OP_QUERY entry point. (That is, the optype argument of the
	      configure routine evaluates to the CFG_OP_QUERY constant.)

  CFG_OP_RECONFIGURE
	      The cfgmgr framework reconfigures the attribute.	This means
	      the cfgmgr framework reconfigures the data value for the
	      attribute.  This functionality allows a user to modify the
	      attribute.  A reconfigure request is typically the result of
	      the sysconfig -r command. The reconfigure operation occurs when
	      the cfgmgr framework calls the configure routine at its
	      CFG_OP_RECONFIGURE entry point. (That is, the optype argument
	      of the configure routine evaluates to the CFG_OP_RECONFIGURE
	      constant.)

  The cfgmgr framework can return one of the following operation codes:

  CFG_ATTR_SUCCESS
	      Successful operation.

  CFG_ATTR_EEXISTS
	      The attribute you specified in the name member does not exist.

  CFG_ATTR_EOP
	      The attribute you specified in the name member does not support
	      the operation.

  CFG_ATTR_ESUBSYS
	      The subsystem failed.

  CFG_ATTR_ESMALL
	      The value or size of the attribute you specified in the name
	      member is too small.

  CFG_ATTR_ELARGE
	      The value or size of the attribute you specified in the name
	      member is too large.

  CFG_ATTR_ETYPE
	      The data type that you specified for the attribute you
	      specified in the name member is invalid or is a mismatch.

  CFG_ATTR_EINDEX
	      The index associated with the attribute that you specified in
	      the name member is invalid.

  CFG_ATTR_EMEM
	      The cfgmgr framework could not allocate memory for the
	      specified attribute.

  CFG_ATTR_ENOTNUMBER
	      The attribute that you specified in the name member cannot be
	      converted to a number.

FILES
  <sys/sysconfig.h>

SEE ALSO
  Data Structures: cfg_subsys_attr_t(9s)

Index for Section 9s

Alphabetical listing for C

Top of page