Summary of SPC Macros And Functions

int PLUGIN_SNPRINTF(char *, size_t, const char *, ...);

Export of the kernel's version of snprintf().

char *PLUGIN_STRCAT((char *, const char *)

Export of the kernel's version of strcat().

char *PLUGIN_STRNCPY(char *, const char *, size_t)

Export of the kernel's version of strncpy().

size_t PLUGIN_STRLEN(const char *)

Export of the kernel's version of strlen().

MSR_PLUGIN_MALLOC(space, cast, size, type, flags);

Export of kernel's malloc macro. The space argument is a pointer which will be initialized to reference the allocated memory. The cast argument is the corresponding type. The size argument is the number of bytes to allocate, type should always be M_MSR and flags should be set to M_WAITOK or M_NOWAIT. On error the space argument is set to NULL.

void PLUGIN_FREE(void *addr, int type)

Export of kernel's free function (used to free memory allocated by MSR_PLUGIN_MALLOC). The type should always be set to M_MSR.

void PLUGIN_MSR_PRINTF_FCT(const u_int32_t , const char *,...)

This function is for printing debug messages. The first argument is a bitwise or of the module (MSR_DEBUG_PLUGIN) and level. See msr_debug.h for valid levels.

void PLUGIN_PRINT_HDR_FCT(car *s, u_int32_t f, char *a)

This uses the MSR_DEBUG facility to print the contents of the msr_bufhdr_t struct referenced by argument a. The argument s should either be set to NULL or reference a valid which is prepended to the output message. The argument f are MSR_DEBUG flags and should be set to the bitwise or of MSR_DEBUG_PLUGIN and the desired verbosity level (such as MSR_DEBUG_LEVEL_INFO).

msr_bufhdr_t *PLUGIN_IPBUF_ALLOC_FCT(void)

This allocates both a packet buffer and the corresponding buffer descriptor (msr_bufhdr_t). The returned buffer includes a shim which has been initialized to mimic a packet which was received on associated port and has not yet been classified (i.e. the reclassify bit is set). Null (0) is returned if no buffers are available.

void PLUGIN_IPBUF_FREE_FCT(msr_bufhdr_t *)

Deallocates the referenced packet buffer and returns it to the free list. This function must not be called with a NULL pointer, the function void msr_freeBuffer(msr_bufhdr_t *) defined in $MSR/rp/plugins/include/plugin_utils.h adds a level of error checking by first checking for a NULL pointer before calling PLUGIN_IPBUF_FREE_FCT().

int PLUGIN_MSR_CFY_FADD_FCT(int c, MSR_GenFilter_t *f, CFY_FltrParams_t *p)

Used to add general or exact match filters to the classifier in the FPX. The parameter c should be either MSR_CFY_ID_EXACT or MSR_CFY_ID_GENERAL for exact match or general match filters respecively. The parameter f specifies the matching header values and parameter p the desired qid and priority. See msr_classify.h for a description of the data structures. A return value of zero indicates success and less than zero an error. The error codes are defined in msr_classify.h with an error return equaling the negative of the defined constants. For example, if invalid arguments are supplied then -1 * MSR_CFY_RESULT_InvArgs is returned.

int PLUGIN_MSR_CFY_FREM_FCT(int c, MSR_GenFilter_t *f, CFY_FltrParams_t *p)

Removes a filter installed either by PLUGIN_MSR_CFY_FADD_FCT() or the RLI. See msr_classify.h for a description of the data structures. Returns zero on success or a negative error code (see msr_classify.h for a list of error codes).

int PLUGIN_MSR_CKSUM_FCT(char *, int)

Used to calculate the IP header checksum in the SPC's kernel code. Plugin developers should use the functions defined in $MSR/rp/plugins/include/ipnet.h (see calc_cksums()) which updates the checksum of both the IP and transport (UDP or TCP) checksum headers fields.

int PLUGIN_IP_FWD_FCT(msr_bufhdr_t *hdr)

A plugin may choose to directly forward a packet rather than adding it to the packet list passed to the plugin's handle_packet routine. If a packet is forwarded using PLUGIN_IP_FWD_FCT then it must not also appear on the bufferList. Returns zero if packet is successfully enqueued for delivery to the FPX, otherwise -1 is returned.

int PLUGIN_SPLCLOCK_FCT(void)

Calling this function will disable clock interrupts, used to protect critical sections when a plugin also uses the clock handler (which runs at the clock interrupt priority). Should always be followed with a call to PLUGIN_SPLX_FCT at the end of a critical section. The return value is an encoding of the current system priority level and must be used in a matching call to PLUGIN_SPLX_FCT().

void PLUGIN_SPLX_FCT(int s)

Enables clock interrupts. The parameter s is set from a call to PLUGIN_SPLCLOCK_FCT().

    	s = PLUGIN_SPLCLOCK_FCT();
    	// critical section
    	PLUGIN_SPLX_FCT()
    	

MSR_PLUGIN_DISPATCH(struct lkm_table *lkmtp, int cmd, int ver, int (*_load) __P((struct lkm_table *lkmtp, int cmd)), int (*_unload) __P((struct lkm_table *lkmtp, int cmd)), int (*_stat) __P((struct lkm_table *lkmtp, int cmd)) )

Called as the very last thing in a plugin modules entry point function. This DISPATCH function causes the plugins _load, _unload or _stat function to be called in response to a command. Often the _stat module is not needed and its place is filled in by the dummy function PLUGIN_LKM_NOFUNC_FCT described below. The use of MSR_PLUGIN_DISPATCH and the PLUGIN_LKM_*_FCT macros/functions would need to be changed very rarely from what is given in the stdplugins and templates.

PLUGIN_LKM_NOFUNC_FCT(struct lkm_table *lkmtp, int cmd)

Can be used as a placeholder for functions passed to the MSR_PLUGIN_DISPATCH function. PLUGIN_LKM_NOFUNC_FCT simply returns 0.

PLUGIN_LKM_DISPATCH_FCT(struct lkm_table *lkmtp, int cmd)

Called as the very last thing in MSR_PLUGIN_DISPATCH. This function calls the kernel functions to do load, unload and stat for special types of modules (LM_VFS, LM_SYSCALL, LM_DEV, ...). For our plugins (type=LM_MISC), this is handled in MSR_PLUGIN_DISPATCH.

PLUGIN_LKM_EXISTS_FCT(struct lkm_table *lkmtp)

Called by a plugin's _load function to avoid loading the plugin twice. Returns one if a plugin of same name is already loaded, otherwise returns zero.

int PLUGIN_PCU_DEREGISTER_CLASS_FCT(struct rp_class *)

Called by a plugin to deregister a class with the SPC plugin control unit. Returns zero (RP_OK) on success, otherwise an error code less than zero is returned. See rp.h for a list of error codes.

int PLUGIN_PCU_FREE_ALL_INSTANCES_FCT(struct rp_class *)

Used by a plugin class to forciblE free any plugin instances. Should be called form the plugin's unload class function to ensure all instances are freed. Returns zero (RP_OK) on success, otherwise an error code less than zero is returned. See rp.h for a list of error codes.

int PLUGIN_PCU_REGISTER_CLASS_FCT(struct rp_class *)

Called by a classes load function to register itself with the SPC plugin control unit. Returns zero (RP_OK) on success, otherwise an error code less than zero is returned. See rp.h for a list of error codes.

void PLUGIN_PCU_LIST_ALL_CLASSES_FCT(void)

Debugging utility which prints a list of loaded classes to the debug messaging facility (also known as monmsgs).

int PLUGIN_MSR_NSP_FPX_READ_REGISTER(u_int8_t regId, u_int32_t *regValue, u_int32_t *timeStamp)

Reads fpx register with id reqID and returns the value in regValue.

int PLUGIN_MSR_NSP_FPX_READ_COUNTER(u_int8_t ctrNum, u_int32_t *ctrValue, u_int32_t *timeStamp)

Reads FPX counter ctrNum and returns the value in ctrValue and timestamp in timeStamp.

int PLUGIN_MSR_NSP_FPX_READ_QUEUE_LENGTH(u_int16_t qid, u_int32_t *qlength, u_int32_t *timeStamp)

Reads the queue length in bytes of qid, returned in network byte order.

int PLUGIN_MSR_NSP_FPX_READ_VOQ_LENGTH(u_int32_t *qlengths, u_int32_t *totalEgressQlength, u_int32_t *timeStamp)

Returns the virtual output queue lengths in the array qlengths, total length of all egress queues in totalEgressQlength and timestamp in timeStamp. The array qlenths is indexed by voq id (0 - 7), and all queue lengths are in network byte order.