CodeSonar As A Windows Service (Windows Only)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.0p0 Hot Tips

CONFIDENTIAL

CodeSecure Inc

CodeSonar As A Windows Service (Windows Only)

By default, CodeSonar will run as a Windows Service on Windows machines. Running as a service provides several advantages, but is not required; users can specify that CodeSonar should be run without services.

Note in particular that Windows Services do not have access to mapped network drives. If you are analyzing files stored on mapped drives, you should run without services.

Running As A Service
Authentication
Running Without Services
Uninstalling Services
Service Management
Change the Hub Service Owner

Running As A Windows Service

By default, CodeSonar will run as a Windows service on Windows machines. This provides several advantages for managing the CodeSonar hub and launch daemon:

They will restart automatically if your machine is restarted.
They can be shut down in a clean manner by the user.
Windows expects that daemons will be run as services.

Windows Build Wizard	On screen 1, make sure that Use Services is selected (it will be selected by default).
Command Line Build	No special actions are necessary.

Windows Authentication

The first time you run CodeSonar as a Windows service, you may need to provide authentication. If so, a dialog will be displayed during the build process.

screenshot: services authentication dialog

Enter your Windows username and password and click OK.
If you have changed your mind about using services, click Cancel. CodeSonar will continue without services.

Windows Permissions

The Windows credentials that you use to authenticate a newly-created CodeSonar service must be for an account with Windows "Administrator" privileges for the current machine.

If you have authenticated a CodeSonar service with a Windows account that has insufficient privileges, you can change the service owner.

Running Without Windows Services

The CodeSonar hub and launch daemon can be run without services.

Hub

Use the -no-services option to the codesonar hub-start command. For example:

codesonar hub-start -no-services myhubdir localhost:7340

If you are starting a hub with the CodeSonar configuration tool, the tool will ask you to specify whether or not you wish to run the hub as a service.

Launch Daemon,
explicitly started

Use the -no-services option to the codesonar install-launchd command. For example:

codesonar install-launchd -no-services localhost:7340

Launch Daemon,
implicitly started
by analysis

(The built project and analysis results are not affected by the absence of services, but the advantages described above will not apply.)

Windows Build Wizard	On screen 1, make sure that Use Services is not selected.
Command Line Build	Use the -no-services option to the codesonar analyze command. For example: codesonar analyze MyProj -no-services localhost:7340 make Alternatively, you can set USE_SERVICES=No in the project configuration file. Note that this parameter is ignored by the Windows build wizard and by the codesonar install-launchd command.

Uninstalling Services

To uninstall the CodeSonar services, use the following command line.

codesonar uninstall-services

If you have services for multiple installations of CodeSonar on a machine, you can uninstall all of them at once:

codesonar uninstall-services -all-installs

This functionality is also available through the CodeSonar configuration tool.

Service Management

Microsoft provides instructions to Start, stop, pause, resume, or restart a service.

Change the Hub Service Owner

There are a number of cases in which you might need to change the owner of the hub service. For example:

The account that owns the hub service requires two-factor authentication (2FA) or some other interactive authentication mechanism.
If this occurs, the hub service will not be able to automatically restart. To address this, change the owner to an account that can be authenticated automatically.
The account that owns the hub service does not have full control for the hub directory.
In this case you will see an error like the following when you try to start the hub, where path\to\hubdir\ is the path to the hub directory and num is a number.
Could not open file for writing at "path\to\hubdir\.check_file.num": Access is denied.
If this occurs, the hub service will not be able to perform all its required operations. To address this, change the owner to an account with full control.
(Or change the settings for the original owner so that they have full control, then manually restart the service.)

To change the service owner, do the following.

Open the Windows Services dialog.
Find the CodeSonar hub service in the list of services. It will have a name of the form "CodeSonar Hub (cshubnum)", where num is a number.
Right-click on the CodeSonar hub service name and select Properties from the menu that pops up.
The service properties dialog will open.
Change to the Log On tab.
Set the fields of the Log On tab to select the account that should be the owner of the hub service: either
- the local System account, or
- another account (specify the username and password).
This account must have full control of the hub directory and all its contents.
Click OK.

When the service next restarts, its owner will change to your new selection.